1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. getSchedule
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 Schedule is a named, reusable weekday-and-time schedule shared by scheduled resources across a Site.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as filescom from "pulumi-filescom";
    
    const exampleSchedule = filescom.getSchedule({
        id: 1,
    });
    
    import pulumi
    import pulumi_filescom as filescom
    
    example_schedule = filescom.get_schedule(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.GetSchedule(ctx, &filescom.LookupScheduleArgs{
    			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 exampleSchedule = Filescom.GetSchedule.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.GetScheduleArgs;
    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 exampleSchedule = FilescomFunctions.getSchedule(GetScheduleArgs.builder()
                .id(1)
                .build());
    
        }
    }
    
    variables:
      exampleSchedule:
        fn::invoke:
          function: filescom:getSchedule
          arguments:
            id: 1
    
    pulumi {
      required_providers {
        filescom = {
          source = "pulumi/filescom"
        }
      }
    }
    
    data "filescom_getschedule" "exampleSchedule" {
      id = 1
    }
    

    Using getSchedule

    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 getSchedule(args: GetScheduleArgs, opts?: InvokeOptions): Promise<GetScheduleResult>
    function getScheduleOutput(args: GetScheduleOutputArgs, opts?: InvokeOutputOptions): Output<GetScheduleResult>
    def get_schedule(id: Optional[int] = None,
                     opts: Optional[InvokeOptions] = None) -> GetScheduleResult
    def get_schedule_output(id: pulumi.Input[Optional[int]] = None,
                     opts: Optional[InvokeOutputOptions] = None) -> Output[GetScheduleResult]
    func LookupSchedule(ctx *Context, args *LookupScheduleArgs, opts ...InvokeOption) (*LookupScheduleResult, error)
    func LookupScheduleOutput(ctx *Context, args *LookupScheduleOutputArgs, opts ...InvokeOption) LookupScheduleResultOutput

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

    public static class GetSchedule 
    {
        public static Task<GetScheduleResult> InvokeAsync(GetScheduleArgs args, InvokeOptions? opts = null)
        public static Output<GetScheduleResult> Invoke(GetScheduleInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetScheduleResult> Invoke(GetScheduleInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetScheduleResult> getSchedule(GetScheduleArgs args, InvokeOptions options)
    public static Output<GetScheduleResult> getSchedule(GetScheduleArgs args, InvokeOptions options)
    public static Output<GetScheduleResult> getSchedule(GetScheduleArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: filescom:index/getSchedule:getSchedule
      arguments:
        # arguments dictionary
    data "filescom_get_schedule" "name" {
        # arguments
    }

    The following arguments are supported:

    Id int
    Schedule ID.
    Id int
    Schedule ID.
    id number
    Schedule ID.
    id Integer
    Schedule ID.
    id number
    Schedule ID.
    id int
    Schedule ID.
    id Number
    Schedule ID.

    getSchedule Result

    The following output properties are available:

    CreatedAt string
    Creation time.
    HolidayRegion string
    Optional holiday region on which linked resources do not run.
    HumanReadableSchedule string
    Human-readable Schedule description.
    Id int
    Schedule ID.
    Name string
    Schedule name.
    ScheduleDaysOfWeeks List<int>
    0-based weekdays used by the Schedule. 0 is Sunday.
    ScheduleTimeZone string
    Time zone for scheduled times. If not set, times are interpreted as UTC.
    ScheduleTimesOfDays List<string>
    Times of day in HH:MM format (24-hour).
    UpdatedAt string
    Last update time.
    CreatedAt string
    Creation time.
    HolidayRegion string
    Optional holiday region on which linked resources do not run.
    HumanReadableSchedule string
    Human-readable Schedule description.
    Id int
    Schedule ID.
    Name string
    Schedule name.
    ScheduleDaysOfWeeks []int
    0-based weekdays used by the Schedule. 0 is Sunday.
    ScheduleTimeZone string
    Time zone for scheduled times. If not set, times are interpreted as UTC.
    ScheduleTimesOfDays []string
    Times of day in HH:MM format (24-hour).
    UpdatedAt string
    Last update time.
    created_at string
    Creation time.
    holiday_region string
    Optional holiday region on which linked resources do not run.
    human_readable_schedule string
    Human-readable Schedule description.
    id number
    Schedule ID.
    name string
    Schedule name.
    schedule_days_of_weeks list(number)
    0-based weekdays used by the Schedule. 0 is Sunday.
    schedule_time_zone string
    Time zone for scheduled times. If not set, times are interpreted as UTC.
    schedule_times_of_days list(string)
    Times of day in HH:MM format (24-hour).
    updated_at string
    Last update time.
    createdAt String
    Creation time.
    holidayRegion String
    Optional holiday region on which linked resources do not run.
    humanReadableSchedule String
    Human-readable Schedule description.
    id Integer
    Schedule ID.
    name String
    Schedule name.
    scheduleDaysOfWeeks List<Integer>
    0-based weekdays used by the Schedule. 0 is Sunday.
    scheduleTimeZone String
    Time zone for scheduled times. If not set, times are interpreted as UTC.
    scheduleTimesOfDays List<String>
    Times of day in HH:MM format (24-hour).
    updatedAt String
    Last update time.
    createdAt string
    Creation time.
    holidayRegion string
    Optional holiday region on which linked resources do not run.
    humanReadableSchedule string
    Human-readable Schedule description.
    id number
    Schedule ID.
    name string
    Schedule name.
    scheduleDaysOfWeeks number[]
    0-based weekdays used by the Schedule. 0 is Sunday.
    scheduleTimeZone string
    Time zone for scheduled times. If not set, times are interpreted as UTC.
    scheduleTimesOfDays string[]
    Times of day in HH:MM format (24-hour).
    updatedAt string
    Last update time.
    created_at str
    Creation time.
    holiday_region str
    Optional holiday region on which linked resources do not run.
    human_readable_schedule str
    Human-readable Schedule description.
    id int
    Schedule ID.
    name str
    Schedule name.
    schedule_days_of_weeks Sequence[int]
    0-based weekdays used by the Schedule. 0 is Sunday.
    schedule_time_zone str
    Time zone for scheduled times. If not set, times are interpreted as UTC.
    schedule_times_of_days Sequence[str]
    Times of day in HH:MM format (24-hour).
    updated_at str
    Last update time.
    createdAt String
    Creation time.
    holidayRegion String
    Optional holiday region on which linked resources do not run.
    humanReadableSchedule String
    Human-readable Schedule description.
    id Number
    Schedule ID.
    name String
    Schedule name.
    scheduleDaysOfWeeks List<Number>
    0-based weekdays used by the Schedule. 0 is Sunday.
    scheduleTimeZone String
    Time zone for scheduled times. If not set, times are interpreted as UTC.
    scheduleTimesOfDays List<String>
    Times of day in HH:MM format (24-hour).
    updatedAt String
    Last update time.

    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