1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. Request
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
filescom logo
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady

    A Request is a file that should be uploaded by a specific user or group.

    Requests can either be manually created and managed, or managed automatically by an Automation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as filescom from "pulumi-filescom";
    
    const exampleRequest = new filescom.Request("example_request", {
        path: "path",
        destination: "destination",
    });
    
    import pulumi
    import pulumi_filescom as filescom
    
    example_request = filescom.Request("example_request",
        path="path",
        destination="destination")
    
    package main
    
    import (
    	"github.com/jschady/pulumi-filescom/sdk/go/filescom"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := filescom.NewRequest(ctx, "example_request", &filescom.RequestArgs{
    			Path:        pulumi.String("path"),
    			Destination: pulumi.String("destination"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Filescom = Jschady.Filescom;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleRequest = new Filescom.Request("example_request", new()
        {
            Path = "path",
            Destination = "destination",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.filescom.Request;
    import com.pulumi.filescom.RequestArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var exampleRequest = new Request("exampleRequest", RequestArgs.builder()
                .path("path")
                .destination("destination")
                .build());
    
        }
    }
    
    resources:
      exampleRequest:
        type: filescom:Request
        name: example_request
        properties:
          path: path
          destination: destination
    
    pulumi {
      required_providers {
        filescom = {
          source = "pulumi/filescom"
        }
      }
    }
    
    resource "filescom_request" "example_request" {
      path        = "path"
      destination = "destination"
    }
    

    Create Request Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Request(name: string, args: RequestArgs, opts?: CustomResourceOptions);
    @overload
    def Request(resource_name: str,
                args: RequestArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Request(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                destination: Optional[str] = None,
                path: Optional[str] = None,
                group_ids: Optional[str] = None,
                user_ids: Optional[str] = None)
    func NewRequest(ctx *Context, name string, args RequestArgs, opts ...ResourceOption) (*Request, error)
    public Request(string name, RequestArgs args, CustomResourceOptions? opts = null)
    public Request(String name, RequestArgs args)
    public Request(String name, RequestArgs args, CustomResourceOptions options)
    
    type: filescom:Request
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "filescom_request" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args RequestArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RequestArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RequestArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RequestArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RequestArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var requestResource = new Filescom.Request("requestResource", new()
    {
        Destination = "string",
        Path = "string",
        GroupIds = "string",
        UserIds = "string",
    });
    
    example, err := filescom.NewRequest(ctx, "requestResource", &filescom.RequestArgs{
    	Destination: pulumi.String("string"),
    	Path:        pulumi.String("string"),
    	GroupIds:    pulumi.String("string"),
    	UserIds:     pulumi.String("string"),
    })
    
    resource "filescom_request" "requestResource" {
      lifecycle {
        create_before_destroy = true
      }
      destination = "string"
      path        = "string"
      group_ids   = "string"
      user_ids    = "string"
    }
    
    var requestResource = new Request("requestResource", RequestArgs.builder()
        .destination("string")
        .path("string")
        .groupIds("string")
        .userIds("string")
        .build());
    
    request_resource = filescom.Request("requestResource",
        destination="string",
        path="string",
        group_ids="string",
        user_ids="string")
    
    const requestResource = new filescom.Request("requestResource", {
        destination: "string",
        path: "string",
        groupIds: "string",
        userIds: "string",
    });
    
    type: filescom:Request
    properties:
        destination: string
        groupIds: string
        path: string
        userIds: string
    

    Request Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Request resource accepts the following input properties:

    Destination string
    Destination filename
    Path string
    Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    GroupIds string
    A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
    UserIds string
    A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
    Destination string
    Destination filename
    Path string
    Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    GroupIds string
    A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
    UserIds string
    A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
    destination string
    Destination filename
    path string
    Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    group_ids string
    A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
    user_ids string
    A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
    destination String
    Destination filename
    path String
    Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    groupIds String
    A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
    userIds String
    A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
    destination string
    Destination filename
    path string
    Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    groupIds string
    A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
    userIds string
    A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
    destination str
    Destination filename
    path str
    Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    group_ids str
    A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
    user_ids str
    A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
    destination String
    Destination filename
    path String
    Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    groupIds String
    A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
    userIds String
    A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Request resource produces the following output properties:

    AutomationId int
    ID of automation that created request
    Id string
    The provider-assigned unique ID for this managed resource.
    Source string
    Source filename, if applicable
    UserDisplayName string
    User making the request (if applicable)
    AutomationId int
    ID of automation that created request
    Id string
    The provider-assigned unique ID for this managed resource.
    Source string
    Source filename, if applicable
    UserDisplayName string
    User making the request (if applicable)
    automation_id number
    ID of automation that created request
    id string
    The provider-assigned unique ID for this managed resource.
    source string
    Source filename, if applicable
    user_display_name string
    User making the request (if applicable)
    automationId Integer
    ID of automation that created request
    id String
    The provider-assigned unique ID for this managed resource.
    source String
    Source filename, if applicable
    userDisplayName String
    User making the request (if applicable)
    automationId number
    ID of automation that created request
    id string
    The provider-assigned unique ID for this managed resource.
    source string
    Source filename, if applicable
    userDisplayName string
    User making the request (if applicable)
    automation_id int
    ID of automation that created request
    id str
    The provider-assigned unique ID for this managed resource.
    source str
    Source filename, if applicable
    user_display_name str
    User making the request (if applicable)
    automationId Number
    ID of automation that created request
    id String
    The provider-assigned unique ID for this managed resource.
    source String
    Source filename, if applicable
    userDisplayName String
    User making the request (if applicable)

    Look up Existing Request Resource

    Get an existing Request resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: RequestState, opts?: CustomResourceOptions): Request
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            automation_id: Optional[int] = None,
            destination: Optional[str] = None,
            group_ids: Optional[str] = None,
            path: Optional[str] = None,
            source: Optional[str] = None,
            user_display_name: Optional[str] = None,
            user_ids: Optional[str] = None) -> Request
    func GetRequest(ctx *Context, name string, id IDInput, state *RequestState, opts ...ResourceOption) (*Request, error)
    public static Request Get(string name, Input<string> id, RequestState? state, CustomResourceOptions? opts = null)
    public static Request get(String name, Output<String> id, RequestState state, CustomResourceOptions options)
    resources:  _:    type: filescom:Request    get:      id: ${id}
    import {
      to = filescom_request.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AutomationId int
    ID of automation that created request
    Destination string
    Destination filename
    GroupIds string
    A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
    Path string
    Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    Source string
    Source filename, if applicable
    UserDisplayName string
    User making the request (if applicable)
    UserIds string
    A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
    AutomationId int
    ID of automation that created request
    Destination string
    Destination filename
    GroupIds string
    A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
    Path string
    Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    Source string
    Source filename, if applicable
    UserDisplayName string
    User making the request (if applicable)
    UserIds string
    A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
    automation_id number
    ID of automation that created request
    destination string
    Destination filename
    group_ids string
    A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
    path string
    Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    source string
    Source filename, if applicable
    user_display_name string
    User making the request (if applicable)
    user_ids string
    A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
    automationId Integer
    ID of automation that created request
    destination String
    Destination filename
    groupIds String
    A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
    path String
    Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    source String
    Source filename, if applicable
    userDisplayName String
    User making the request (if applicable)
    userIds String
    A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
    automationId number
    ID of automation that created request
    destination string
    Destination filename
    groupIds string
    A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
    path string
    Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    source string
    Source filename, if applicable
    userDisplayName string
    User making the request (if applicable)
    userIds string
    A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
    automation_id int
    ID of automation that created request
    destination str
    Destination filename
    group_ids str
    A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
    path str
    Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    source str
    Source filename, if applicable
    user_display_name str
    User making the request (if applicable)
    user_ids str
    A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
    automationId Number
    ID of automation that created request
    destination String
    Destination filename
    groupIds String
    A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.
    path String
    Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    source String
    Source filename, if applicable
    userDisplayName String
    User making the request (if applicable)
    userIds String
    A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.

    Import

    The pulumi import command can be used, for example:

    Requests can be imported by specifying the id.

    $ pulumi import filescom:index/request:Request example_request 1
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    filescom jschady/pulumi-filescom
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the filescom Terraform Provider.
    filescom logo
    Viewing docs for Files.com v0.1.1
    published on Thursday, Aug 20, 2026 by jschady

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial