1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. getFileMigration
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 FileMigration is a background operation on one or more files, such as a copy or a region migration.

    If no operation or destPath is present, then the record represents a region migration.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as filescom from "pulumi-filescom";
    
    const exampleFileMigration = filescom.getFileMigration({
        id: 1,
    });
    
    import pulumi
    import pulumi_filescom as filescom
    
    example_file_migration = filescom.get_file_migration(id=1)
    
    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.GetFileMigration(ctx, &filescom.GetFileMigrationArgs{
    			Id: 1,
    		}, nil)
    		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 exampleFileMigration = Filescom.GetFileMigration.Invoke(new()
        {
            Id = 1,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.filescom.FilescomFunctions;
    import com.pulumi.filescom.inputs.GetFileMigrationArgs;
    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) {
            final var exampleFileMigration = FilescomFunctions.getFileMigration(GetFileMigrationArgs.builder()
                .id(1)
                .build());
    
        }
    }
    
    variables:
      exampleFileMigration:
        fn::invoke:
          function: filescom:getFileMigration
          arguments:
            id: 1
    
    pulumi {
      required_providers {
        filescom = {
          source = "pulumi/filescom"
        }
      }
    }
    
    data "filescom_getfilemigration" "exampleFileMigration" {
      id = 1
    }
    

    Using getFileMigration

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getFileMigration(args: GetFileMigrationArgs, opts?: InvokeOptions): Promise<GetFileMigrationResult>
    function getFileMigrationOutput(args: GetFileMigrationOutputArgs, opts?: InvokeOutputOptions): Output<GetFileMigrationResult>
    def get_file_migration(id: Optional[int] = None,
                           opts: Optional[InvokeOptions] = None) -> GetFileMigrationResult
    def get_file_migration_output(id: pulumi.Input[Optional[int]] = None,
                           opts: Optional[InvokeOutputOptions] = None) -> Output[GetFileMigrationResult]
    func GetFileMigration(ctx *Context, args *GetFileMigrationArgs, opts ...InvokeOption) (*GetFileMigrationResult, error)
    func GetFileMigrationOutput(ctx *Context, args *GetFileMigrationOutputArgs, opts ...InvokeOption) GetFileMigrationResultOutput

    > Note: This function is named GetFileMigration in the Go SDK.

    public static class GetFileMigration 
    {
        public static Task<GetFileMigrationResult> InvokeAsync(GetFileMigrationArgs args, InvokeOptions? opts = null)
        public static Output<GetFileMigrationResult> Invoke(GetFileMigrationInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetFileMigrationResult> Invoke(GetFileMigrationInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetFileMigrationResult> getFileMigration(GetFileMigrationArgs args, InvokeOptions options)
    public static Output<GetFileMigrationResult> getFileMigration(GetFileMigrationArgs args, InvokeOptions options)
    public static Output<GetFileMigrationResult> getFileMigration(GetFileMigrationArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: filescom:index/getFileMigration:getFileMigration
      arguments:
        # arguments dictionary
    data "filescom_get_file_migration" "name" {
        # arguments
    }

    The following arguments are supported:

    Id int
    File migration ID
    Id int
    File migration ID
    id number
    File migration ID
    id Integer
    File migration ID
    id number
    File migration ID
    id int
    File migration ID
    id Number
    File migration ID

    getFileMigration Result

    The following output properties are available:

    DestPath string
    Destination path
    FailureMessage string
    Reason for the failure, if applicable.
    FilesMoved int
    Number of files processed
    FilesTotal int
    Id int
    File migration ID
    LogUrl string
    Link to download the log file for this migration.
    Operation string
    The type of operation
    Path string
    Source path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    Region string
    Region
    Status string
    Status
    DestPath string
    Destination path
    FailureMessage string
    Reason for the failure, if applicable.
    FilesMoved int
    Number of files processed
    FilesTotal int
    Id int
    File migration ID
    LogUrl string
    Link to download the log file for this migration.
    Operation string
    The type of operation
    Path string
    Source path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    Region string
    Region
    Status string
    Status
    dest_path string
    Destination path
    failure_message string
    Reason for the failure, if applicable.
    files_moved number
    Number of files processed
    files_total number
    id number
    File migration ID
    log_url string
    Link to download the log file for this migration.
    operation string
    The type of operation
    path string
    Source path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    region string
    Region
    status string
    Status
    destPath String
    Destination path
    failureMessage String
    Reason for the failure, if applicable.
    filesMoved Integer
    Number of files processed
    filesTotal Integer
    id Integer
    File migration ID
    logUrl String
    Link to download the log file for this migration.
    operation String
    The type of operation
    path String
    Source path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    region String
    Region
    status String
    Status
    destPath string
    Destination path
    failureMessage string
    Reason for the failure, if applicable.
    filesMoved number
    Number of files processed
    filesTotal number
    id number
    File migration ID
    logUrl string
    Link to download the log file for this migration.
    operation string
    The type of operation
    path string
    Source path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    region string
    Region
    status string
    Status
    dest_path str
    Destination path
    failure_message str
    Reason for the failure, if applicable.
    files_moved int
    Number of files processed
    files_total int
    id int
    File migration ID
    log_url str
    Link to download the log file for this migration.
    operation str
    The type of operation
    path str
    Source path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    region str
    Region
    status str
    Status
    destPath String
    Destination path
    failureMessage String
    Reason for the failure, if applicable.
    filesMoved Number
    Number of files processed
    filesTotal Number
    id Number
    File migration ID
    logUrl String
    Link to download the log file for this migration.
    operation String
    The type of operation
    path String
    Source path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
    region String
    Region
    status String
    Status

    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