Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. firestore
  5. firestore/v1
  6. getBackupSchedule

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.firestore/v1.getBackupSchedule

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Gets information about a backup schedule.

    Using getBackupSchedule

    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 getBackupSchedule(args: GetBackupScheduleArgs, opts?: InvokeOptions): Promise<GetBackupScheduleResult>
function getBackupScheduleOutput(args: GetBackupScheduleOutputArgs, opts?: InvokeOptions): Output<GetBackupScheduleResult>
    def get_backup_schedule(backup_schedule_id: Optional[str] = None,
                        database_id: Optional[str] = None,
                        project: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetBackupScheduleResult
def get_backup_schedule_output(backup_schedule_id: Optional[pulumi.Input[str]] = None,
                        database_id: Optional[pulumi.Input[str]] = None,
                        project: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetBackupScheduleResult]
    func LookupBackupSchedule(ctx *Context, args *LookupBackupScheduleArgs, opts ...InvokeOption) (*LookupBackupScheduleResult, error)
func LookupBackupScheduleOutput(ctx *Context, args *LookupBackupScheduleOutputArgs, opts ...InvokeOption) LookupBackupScheduleResultOutput

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

    public static class GetBackupSchedule 
{
    public static Task<GetBackupScheduleResult> InvokeAsync(GetBackupScheduleArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupScheduleResult> Invoke(GetBackupScheduleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBackupScheduleResult> getBackupSchedule(GetBackupScheduleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:firestore/v1:getBackupSchedule
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getBackupSchedule Result

    The following output properties are available:

    CreateTime string
    The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.
    DailyRecurrence Pulumi.GoogleNative.Firestore.V1.Outputs.GoogleFirestoreAdminV1DailyRecurrenceResponse
    For a schedule that runs daily at a specified time.
    Name string
    The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is projects/{project}/databases/{database}/backupSchedules/{backup_schedule}
    Retention string
    At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.
    UpdateTime string
    The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.
    WeeklyRecurrence Pulumi.GoogleNative.Firestore.V1.Outputs.GoogleFirestoreAdminV1WeeklyRecurrenceResponse
    For a schedule that runs weekly on a specific day and time.
    CreateTime string
    The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.
    DailyRecurrence GoogleFirestoreAdminV1DailyRecurrenceResponse
    For a schedule that runs daily at a specified time.
    Name string
    The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is projects/{project}/databases/{database}/backupSchedules/{backup_schedule}
    Retention string
    At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.
    UpdateTime string
    The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.
    WeeklyRecurrence GoogleFirestoreAdminV1WeeklyRecurrenceResponse
    For a schedule that runs weekly on a specific day and time.
    createTime String
    The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.
    dailyRecurrence GoogleFirestoreAdminV1DailyRecurrenceResponse
    For a schedule that runs daily at a specified time.
    name String
    The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is projects/{project}/databases/{database}/backupSchedules/{backup_schedule}
    retention String
    At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.
    updateTime String
    The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.
    weeklyRecurrence GoogleFirestoreAdminV1WeeklyRecurrenceResponse
    For a schedule that runs weekly on a specific day and time.
    createTime string
    The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.
    dailyRecurrence GoogleFirestoreAdminV1DailyRecurrenceResponse
    For a schedule that runs daily at a specified time.
    name string
    The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is projects/{project}/databases/{database}/backupSchedules/{backup_schedule}
    retention string
    At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.
    updateTime string
    The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.
    weeklyRecurrence GoogleFirestoreAdminV1WeeklyRecurrenceResponse
    For a schedule that runs weekly on a specific day and time.
    create_time str
    The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.
    daily_recurrence GoogleFirestoreAdminV1DailyRecurrenceResponse
    For a schedule that runs daily at a specified time.
    name str
    The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is projects/{project}/databases/{database}/backupSchedules/{backup_schedule}
    retention str
    At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.
    update_time str
    The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.
    weekly_recurrence GoogleFirestoreAdminV1WeeklyRecurrenceResponse
    For a schedule that runs weekly on a specific day and time.
    createTime String
    The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.
    dailyRecurrence Property Map
    For a schedule that runs daily at a specified time.
    name String
    The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is projects/{project}/databases/{database}/backupSchedules/{backup_schedule}
    retention String
    At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.
    updateTime String
    The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.
    weeklyRecurrence Property Map
    For a schedule that runs weekly on a specific day and time.

    Supporting Types

    GoogleFirestoreAdminV1WeeklyRecurrenceResponse

    Day string
    The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
    Day string
    The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
    day String
    The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
    day string
    The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
    day str
    The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
    day String
    The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native