Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. getSyncRun
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
Schema (JSON)
jschady/pulumi-filescom

filescom.getSyncRun

filescom logo
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
Schema (JSON)
jschady/pulumi-filescom

    A SyncRun represents a single execution (run) of a Sync job.

    It tracks status, statistics, logs, and timing for each sync operation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as filescom from "pulumi-filescom";

const exampleSyncRun = filescom.getSyncRun({
    id: 1,
});

    import pulumi
import pulumi_filescom as filescom

example_sync_run = filescom.get_sync_run(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.GetSyncRun(ctx, &filescom.GetSyncRunArgs{
			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 exampleSyncRun = Filescom.GetSyncRun.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.GetSyncRunArgs;
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 exampleSyncRun = FilescomFunctions.getSyncRun(GetSyncRunArgs.builder()
            .id(1)
            .build());

    }
}

    variables:
  exampleSyncRun:
    fn::invoke:
      function: filescom:getSyncRun
      arguments:
        id: 1

    pulumi {
  required_providers {
    filescom = {
      source = "pulumi/filescom"
    }
  }
}

data "filescom_getsyncrun" "exampleSyncRun" {
  id = 1
}

    Using getSyncRun

    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 getSyncRun(args: GetSyncRunArgs, opts?: InvokeOptions): Promise<GetSyncRunResult>
function getSyncRunOutput(args: GetSyncRunOutputArgs, opts?: InvokeOutputOptions): Output<GetSyncRunResult>
    def get_sync_run(id: Optional[int] = None,
                 opts: Optional[InvokeOptions] = None) -> GetSyncRunResult
def get_sync_run_output(id: pulumi.Input[Optional[int]] = None,
                 opts: Optional[InvokeOutputOptions] = None) -> Output[GetSyncRunResult]
    func GetSyncRun(ctx *Context, args *GetSyncRunArgs, opts ...InvokeOption) (*GetSyncRunResult, error)
func GetSyncRunOutput(ctx *Context, args *GetSyncRunOutputArgs, opts ...InvokeOption) GetSyncRunResultOutput

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

    public static class GetSyncRun 
{
    public static Task<GetSyncRunResult> InvokeAsync(GetSyncRunArgs args, InvokeOptions? opts = null)
    public static Output<GetSyncRunResult> Invoke(GetSyncRunInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetSyncRunResult> Invoke(GetSyncRunInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetSyncRunResult> getSyncRun(GetSyncRunArgs args, InvokeOptions options)
public static Output<GetSyncRunResult> getSyncRun(GetSyncRunArgs args, InvokeOptions options)
public static Output<GetSyncRunResult> getSyncRun(GetSyncRunArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: filescom:index/getSyncRun:getSyncRun
  arguments:
    # arguments dictionary
    data "filescom_get_sync_run" "name" {
    # arguments
}

    The following arguments are supported:

    Id int
    SyncRun ID
    Id int
    SyncRun ID
    id number
    SyncRun ID
    id Integer
    SyncRun ID
    id number
    SyncRun ID
    id int
    SyncRun ID
    id Number
    SyncRun ID

    getSyncRun Result

    The following output properties are available:

    Body string
    Log or summary body for this run
    BytesSynced int
    Total bytes synced in this run
    ComparedFiles int
    Number of files compared
    ComparedFolders int
    Number of folders compared
    CompletedAt string
    When this run was completed
    CreatedAt string
    When this run was created
    DestRemoteServerType string
    Destination remote server type, if any
    DryRun bool
    Whether this run was a dry run (no actual changes made)
    ErroredFiles int
    Number of files that errored
    EstimatedBytesCount int
    Estimated bytes count for this run
    EventErrors List<string>
    Array of errors encountered during the run
    Id int
    SyncRun ID
    LiveTransfers object
    Array of in-progress file transfers with progress data. Only present when the sync run status is in_progress.
    LogUrl string
    Link to external log file.
    Runtime double
    Total runtime in seconds
    SiteId int
    Site ID
    SrcRemoteServerType string
    Source remote server type, if any
    Status string
    Status of the sync run (success, failure, partialfailure, inprogress, skipped)
    SuccessfulFiles int
    Number of files successfully synced
    SyncId int
    ID of the Sync this run belongs to
    SyncName string
    Name of the Sync this run belongs to
    UpdatedAt string
    When this run was last updated
    WorkspaceId int
    Workspace ID
    Body string
    Log or summary body for this run
    BytesSynced int
    Total bytes synced in this run
    ComparedFiles int
    Number of files compared
    ComparedFolders int
    Number of folders compared
    CompletedAt string
    When this run was completed
    CreatedAt string
    When this run was created
    DestRemoteServerType string
    Destination remote server type, if any
    DryRun bool
    Whether this run was a dry run (no actual changes made)
    ErroredFiles int
    Number of files that errored
    EstimatedBytesCount int
    Estimated bytes count for this run
    EventErrors []string
    Array of errors encountered during the run
    Id int
    SyncRun ID
    LiveTransfers interface{}
    Array of in-progress file transfers with progress data. Only present when the sync run status is in_progress.
    LogUrl string
    Link to external log file.
    Runtime float64
    Total runtime in seconds
    SiteId int
    Site ID
    SrcRemoteServerType string
    Source remote server type, if any
    Status string
    Status of the sync run (success, failure, partialfailure, inprogress, skipped)
    SuccessfulFiles int
    Number of files successfully synced
    SyncId int
    ID of the Sync this run belongs to
    SyncName string
    Name of the Sync this run belongs to
    UpdatedAt string
    When this run was last updated
    WorkspaceId int
    Workspace ID
    body string
    Log or summary body for this run
    bytes_synced number
    Total bytes synced in this run
    compared_files number
    Number of files compared
    compared_folders number
    Number of folders compared
    completed_at string
    When this run was completed
    created_at string
    When this run was created
    dest_remote_server_type string
    Destination remote server type, if any
    dry_run bool
    Whether this run was a dry run (no actual changes made)
    errored_files number
    Number of files that errored
    estimated_bytes_count number
    Estimated bytes count for this run
    event_errors list(string)
    Array of errors encountered during the run
    id number
    SyncRun ID
    live_transfers any
    Array of in-progress file transfers with progress data. Only present when the sync run status is in_progress.
    log_url string
    Link to external log file.
    runtime number
    Total runtime in seconds
    site_id number
    Site ID
    src_remote_server_type string
    Source remote server type, if any
    status string
    Status of the sync run (success, failure, partialfailure, inprogress, skipped)
    successful_files number
    Number of files successfully synced
    sync_id number
    ID of the Sync this run belongs to
    sync_name string
    Name of the Sync this run belongs to
    updated_at string
    When this run was last updated
    workspace_id number
    Workspace ID
    body String
    Log or summary body for this run
    bytesSynced Integer
    Total bytes synced in this run
    comparedFiles Integer
    Number of files compared
    comparedFolders Integer
    Number of folders compared
    completedAt String
    When this run was completed
    createdAt String
    When this run was created
    destRemoteServerType String
    Destination remote server type, if any
    dryRun Boolean
    Whether this run was a dry run (no actual changes made)
    erroredFiles Integer
    Number of files that errored
    estimatedBytesCount Integer
    Estimated bytes count for this run
    eventErrors List<String>
    Array of errors encountered during the run
    id Integer
    SyncRun ID
    liveTransfers Object
    Array of in-progress file transfers with progress data. Only present when the sync run status is in_progress.
    logUrl String
    Link to external log file.
    runtime Double
    Total runtime in seconds
    siteId Integer
    Site ID
    srcRemoteServerType String
    Source remote server type, if any
    status String
    Status of the sync run (success, failure, partialfailure, inprogress, skipped)
    successfulFiles Integer
    Number of files successfully synced
    syncId Integer
    ID of the Sync this run belongs to
    syncName String
    Name of the Sync this run belongs to
    updatedAt String
    When this run was last updated
    workspaceId Integer
    Workspace ID
    body string
    Log or summary body for this run
    bytesSynced number
    Total bytes synced in this run
    comparedFiles number
    Number of files compared
    comparedFolders number
    Number of folders compared
    completedAt string
    When this run was completed
    createdAt string
    When this run was created
    destRemoteServerType string
    Destination remote server type, if any
    dryRun boolean
    Whether this run was a dry run (no actual changes made)
    erroredFiles number
    Number of files that errored
    estimatedBytesCount number
    Estimated bytes count for this run
    eventErrors string[]
    Array of errors encountered during the run
    id number
    SyncRun ID
    liveTransfers any
    Array of in-progress file transfers with progress data. Only present when the sync run status is in_progress.
    logUrl string
    Link to external log file.
    runtime number
    Total runtime in seconds
    siteId number
    Site ID
    srcRemoteServerType string
    Source remote server type, if any
    status string
    Status of the sync run (success, failure, partialfailure, inprogress, skipped)
    successfulFiles number
    Number of files successfully synced
    syncId number
    ID of the Sync this run belongs to
    syncName string
    Name of the Sync this run belongs to
    updatedAt string
    When this run was last updated
    workspaceId number
    Workspace ID
    body str
    Log or summary body for this run
    bytes_synced int
    Total bytes synced in this run
    compared_files int
    Number of files compared
    compared_folders int
    Number of folders compared
    completed_at str
    When this run was completed
    created_at str
    When this run was created
    dest_remote_server_type str
    Destination remote server type, if any
    dry_run bool
    Whether this run was a dry run (no actual changes made)
    errored_files int
    Number of files that errored
    estimated_bytes_count int
    Estimated bytes count for this run
    event_errors Sequence[str]
    Array of errors encountered during the run
    id int
    SyncRun ID
    live_transfers Any
    Array of in-progress file transfers with progress data. Only present when the sync run status is in_progress.
    log_url str
    Link to external log file.
    runtime float
    Total runtime in seconds
    site_id int
    Site ID
    src_remote_server_type str
    Source remote server type, if any
    status str
    Status of the sync run (success, failure, partialfailure, inprogress, skipped)
    successful_files int
    Number of files successfully synced
    sync_id int
    ID of the Sync this run belongs to
    sync_name str
    Name of the Sync this run belongs to
    updated_at str
    When this run was last updated
    workspace_id int
    Workspace ID
    body String
    Log or summary body for this run
    bytesSynced Number
    Total bytes synced in this run
    comparedFiles Number
    Number of files compared
    comparedFolders Number
    Number of folders compared
    completedAt String
    When this run was completed
    createdAt String
    When this run was created
    destRemoteServerType String
    Destination remote server type, if any
    dryRun Boolean
    Whether this run was a dry run (no actual changes made)
    erroredFiles Number
    Number of files that errored
    estimatedBytesCount Number
    Estimated bytes count for this run
    eventErrors List<String>
    Array of errors encountered during the run
    id Number
    SyncRun ID
    liveTransfers Any
    Array of in-progress file transfers with progress data. Only present when the sync run status is in_progress.
    logUrl String
    Link to external log file.
    runtime Number
    Total runtime in seconds
    siteId Number
    Site ID
    srcRemoteServerType String
    Source remote server type, if any
    status String
    Status of the sync run (success, failure, partialfailure, inprogress, skipped)
    successfulFiles Number
    Number of files successfully synced
    syncId Number
    ID of the Sync this run belongs to
    syncName String
    Name of the Sync this run belongs to
    updatedAt String
    When this run was last updated
    workspaceId Number
    Workspace ID

    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
    Schema (JSON)
    jschady/pulumi-filescom

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial