Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.firestore/v1.getBackupSchedule
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
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:
- Backup
Schedule stringId - Database
Id string - Project string
- Backup
Schedule stringId - Database
Id string - Project string
- backup
Schedule StringId - database
Id String - project String
- backup
Schedule stringId - database
Id string - project string
- backup_
schedule_ strid - database_
id str - project str
- backup
Schedule StringId - database
Id String - project String
getBackupSchedule Result
The following output properties are available:
- Create
Time string 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 Pulumi.Google Native. Firestore. V1. Outputs. Google Firestore Admin V1Daily Recurrence Response 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 the creation time of the backup should the backup be deleted, i.e. keep backups for 7 days.
- Update
Time 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.
- Weekly
Recurrence Pulumi.Google Native. Firestore. V1. Outputs. Google Firestore Admin V1Weekly Recurrence Response For a schedule that runs weekly on a specific day and time.
- Create
Time string 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 GoogleFirestore Admin V1Daily Recurrence Response 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 the creation time of the backup should the backup be deleted, i.e. keep backups for 7 days.
- Update
Time 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.
- Weekly
Recurrence GoogleFirestore Admin V1Weekly Recurrence Response For a schedule that runs weekly on a specific day and time.
- create
Time String 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 GoogleFirestore Admin V1Daily Recurrence Response 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 the creation time of the backup should the backup be deleted, i.e. keep backups for 7 days.
- update
Time 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.
- weekly
Recurrence GoogleFirestore Admin V1Weekly Recurrence Response For a schedule that runs weekly on a specific day and time.
- create
Time string 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 GoogleFirestore Admin V1Daily Recurrence Response 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 the creation time of the backup should the backup be deleted, i.e. keep backups for 7 days.
- update
Time 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.
- weekly
Recurrence GoogleFirestore Admin V1Weekly Recurrence Response 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 GoogleFirestore Admin V1Daily Recurrence Response 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 the creation time of the backup should the backup be deleted, i.e. 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 GoogleFirestore Admin V1Weekly Recurrence Response For a schedule that runs weekly on a specific day and time.
- create
Time String 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 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 the creation time of the backup should the backup be deleted, i.e. keep backups for 7 days.
- update
Time 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.
- weekly
Recurrence 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 Cloud Native is in preview. Google Cloud Classic is fully supported.