ibm.getBackupRecoveryProtectionGroupRuns

func GetBackupRecoveryProtectionGroupRuns(ctx *Context, args *GetBackupRecoveryProtectionGroupRunsArgs, opts ...InvokeOption) (*GetBackupRecoveryProtectionGroupRunsResult, error)
func GetBackupRecoveryProtectionGroupRunsOutput(ctx *Context, args *GetBackupRecoveryProtectionGroupRunsOutputArgs, opts ...InvokeOption) GetBackupRecoveryProtectionGroupRunsResultOutput

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

ProtectionGroupId string

Specifies a unique id of the Protection Group.

• Constraints: The value must match regular expression /^\\d+:\\d+:\\d+$/.

XIbmTenantId string

Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.

ArchivalRunStatuses List<string>

Specifies a list of archival status, runs matching the status will be returned. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Paused' indicates that the ongoing run has been paused. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable list items are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

CloudSpinRunStatuses List<string>

Specifies a list of cloud spin status, runs matching the status will be returned. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Paused' indicates that the ongoing run has been paused. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable list items are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

EndTimeUsecs double

End time for time range filter. Specify the end time as a Unix epoch Timestamp (in microseconds), only runs executing before this time will be returned. By default it is current time.

ExcludeNonRestorableRuns bool

Specifies whether to exclude non restorable runs. Run is treated restorable only if there is atleast one object snapshot (which may be either a local or an archival snapshot) which is not deleted or expired. Default value is false.

• Constraints: The default value is false.

FilterByCopyTaskEndTime bool

If true, then the details of the runs for which any copyTask completed in the given timerange will be returned. Only one of filterByEndTime and filterByCopyTaskEndTime can be set.

FilterByEndTime bool

If true, the runs with backup end time within the specified time range will be returned. Otherwise, the runs with start time in the time range are returned.

Id string

(String) The tenant id.

IncludeObjectDetails bool

Specifies if the result includes the object details for each protection run. If set to true, details of the protected object will be returned. If set to false or not specified, details will not be returned.

LocalBackupRunStatuses List<string>

Specifies a list of local backup status, runs matching the status will be returned. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Paused' indicates that the ongoing run has been paused. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable list items are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

NumRuns double

Specifies the max number of runs. If not specified, at most 100 runs will be returned.

OnlyReturnSuccessfulCopyRun bool

only successful copyruns are returned.

ReplicationRunStatuses List<string>

Specifies a list of replication status, runs matching the status will be returned. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Paused' indicates that the ongoing run has been paused. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable list items are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

RequestInitiatorType string

Specifies the type of request from UI, which is used for services like magneto to determine the priority of requests.

• Constraints: Allowable values are: UIUser, UIAuto, Helios.

RunId string

Specifies the protection run id.

• Constraints: The value must match regular expression /^\\d+:\\d+$/.

RunTags List<string>

Specifies a list of tags for protection runs. If this is specified, only the runs which match these tags will be returned.

RunTypes List<string>

Filter by run type. Only protection run matching the specified types will be returned.

• Constraints: Allowable list items are: kAll, kHydrateCDP, kSystem, kStorageArraySnapshot, kIncremental, kFull, kLog.

SnapshotTargetTypes List<string>

Specifies the snapshot's target type which should be filtered.

• Constraints: Allowable list items are: Local, Archival, RpaasArchival, StorageArraySnapshot, Remote.

StartTimeUsecs double

Start time for time range filter. Specify the start time as a Unix epoch Timestamp (in microseconds), only runs executing after this time will be returned. By default it is endTimeUsecs minus an hour.

UseCachedData bool

Specifies whether we can serve the GET request from the read replica cache. There is a lag of 15 seconds between the read replica and primary data source.

ProtectionGroupId string

Specifies a unique id of the Protection Group.

• Constraints: The value must match regular expression /^\\d+:\\d+:\\d+$/.

XIbmTenantId string

Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.

ArchivalRunStatuses []string

Specifies a list of archival status, runs matching the status will be returned. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Paused' indicates that the ongoing run has been paused. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable list items are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

CloudSpinRunStatuses []string

Specifies a list of cloud spin status, runs matching the status will be returned. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Paused' indicates that the ongoing run has been paused. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable list items are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

EndTimeUsecs float64

End time for time range filter. Specify the end time as a Unix epoch Timestamp (in microseconds), only runs executing before this time will be returned. By default it is current time.

ExcludeNonRestorableRuns bool

Specifies whether to exclude non restorable runs. Run is treated restorable only if there is atleast one object snapshot (which may be either a local or an archival snapshot) which is not deleted or expired. Default value is false.

• Constraints: The default value is false.

FilterByCopyTaskEndTime bool

If true, then the details of the runs for which any copyTask completed in the given timerange will be returned. Only one of filterByEndTime and filterByCopyTaskEndTime can be set.

FilterByEndTime bool

If true, the runs with backup end time within the specified time range will be returned. Otherwise, the runs with start time in the time range are returned.

Id string

(String) The tenant id.

IncludeObjectDetails bool

Specifies if the result includes the object details for each protection run. If set to true, details of the protected object will be returned. If set to false or not specified, details will not be returned.

LocalBackupRunStatuses []string

Specifies a list of local backup status, runs matching the status will be returned. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Paused' indicates that the ongoing run has been paused. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable list items are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

NumRuns float64

Specifies the max number of runs. If not specified, at most 100 runs will be returned.

OnlyReturnSuccessfulCopyRun bool

only successful copyruns are returned.

ReplicationRunStatuses []string

Specifies a list of replication status, runs matching the status will be returned. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Paused' indicates that the ongoing run has been paused. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable list items are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

RequestInitiatorType string

Specifies the type of request from UI, which is used for services like magneto to determine the priority of requests.

• Constraints: Allowable values are: UIUser, UIAuto, Helios.

RunId string

Specifies the protection run id.

• Constraints: The value must match regular expression /^\\d+:\\d+$/.

RunTags []string

Specifies a list of tags for protection runs. If this is specified, only the runs which match these tags will be returned.

RunTypes []string

Filter by run type. Only protection run matching the specified types will be returned.

• Constraints: Allowable list items are: kAll, kHydrateCDP, kSystem, kStorageArraySnapshot, kIncremental, kFull, kLog.

SnapshotTargetTypes []string

Specifies the snapshot's target type which should be filtered.

• Constraints: Allowable list items are: Local, Archival, RpaasArchival, StorageArraySnapshot, Remote.

StartTimeUsecs float64

Start time for time range filter. Specify the start time as a Unix epoch Timestamp (in microseconds), only runs executing after this time will be returned. By default it is endTimeUsecs minus an hour.

UseCachedData bool

Specifies whether we can serve the GET request from the read replica cache. There is a lag of 15 seconds between the read replica and primary data source.

protectionGroupId String

Specifies a unique id of the Protection Group.

• Constraints: The value must match regular expression /^\\d+:\\d+:\\d+$/.

xIbmTenantId String

Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.

archivalRunStatuses List<String>

Specifies a list of archival status, runs matching the status will be returned. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Paused' indicates that the ongoing run has been paused. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable list items are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

cloudSpinRunStatuses List<String>

Specifies a list of cloud spin status, runs matching the status will be returned. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Paused' indicates that the ongoing run has been paused. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable list items are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

endTimeUsecs Double

End time for time range filter. Specify the end time as a Unix epoch Timestamp (in microseconds), only runs executing before this time will be returned. By default it is current time.

excludeNonRestorableRuns Boolean

Specifies whether to exclude non restorable runs. Run is treated restorable only if there is atleast one object snapshot (which may be either a local or an archival snapshot) which is not deleted or expired. Default value is false.

• Constraints: The default value is false.

filterByCopyTaskEndTime Boolean

If true, then the details of the runs for which any copyTask completed in the given timerange will be returned. Only one of filterByEndTime and filterByCopyTaskEndTime can be set.

filterByEndTime Boolean

If true, the runs with backup end time within the specified time range will be returned. Otherwise, the runs with start time in the time range are returned.

id String

(String) The tenant id.

includeObjectDetails Boolean

Specifies if the result includes the object details for each protection run. If set to true, details of the protected object will be returned. If set to false or not specified, details will not be returned.

localBackupRunStatuses List<String>

Specifies a list of local backup status, runs matching the status will be returned. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Paused' indicates that the ongoing run has been paused. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable list items are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

numRuns Double

Specifies the max number of runs. If not specified, at most 100 runs will be returned.

onlyReturnSuccessfulCopyRun Boolean

only successful copyruns are returned.

replicationRunStatuses List<String>

Specifies a list of replication status, runs matching the status will be returned. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Paused' indicates that the ongoing run has been paused. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable list items are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

requestInitiatorType String

Specifies the type of request from UI, which is used for services like magneto to determine the priority of requests.

• Constraints: Allowable values are: UIUser, UIAuto, Helios.

runId String

Specifies the protection run id.

• Constraints: The value must match regular expression /^\\d+:\\d+$/.

runTags List<String>

Specifies a list of tags for protection runs. If this is specified, only the runs which match these tags will be returned.

runTypes List<String>

Filter by run type. Only protection run matching the specified types will be returned.

• Constraints: Allowable list items are: kAll, kHydrateCDP, kSystem, kStorageArraySnapshot, kIncremental, kFull, kLog.

snapshotTargetTypes List<String>

Specifies the snapshot's target type which should be filtered.

• Constraints: Allowable list items are: Local, Archival, RpaasArchival, StorageArraySnapshot, Remote.

startTimeUsecs Double

Start time for time range filter. Specify the start time as a Unix epoch Timestamp (in microseconds), only runs executing after this time will be returned. By default it is endTimeUsecs minus an hour.

useCachedData Boolean

Specifies whether we can serve the GET request from the read replica cache. There is a lag of 15 seconds between the read replica and primary data source.

protectionGroupId string

Specifies a unique id of the Protection Group.

• Constraints: The value must match regular expression /^\\d+:\\d+:\\d+$/.

xIbmTenantId string

Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.

archivalRunStatuses string[]

Specifies a list of archival status, runs matching the status will be returned. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Paused' indicates that the ongoing run has been paused. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable list items are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

cloudSpinRunStatuses string[]

Specifies a list of cloud spin status, runs matching the status will be returned. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Paused' indicates that the ongoing run has been paused. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable list items are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

endTimeUsecs number

End time for time range filter. Specify the end time as a Unix epoch Timestamp (in microseconds), only runs executing before this time will be returned. By default it is current time.

excludeNonRestorableRuns boolean

Specifies whether to exclude non restorable runs. Run is treated restorable only if there is atleast one object snapshot (which may be either a local or an archival snapshot) which is not deleted or expired. Default value is false.

• Constraints: The default value is false.

filterByCopyTaskEndTime boolean

If true, then the details of the runs for which any copyTask completed in the given timerange will be returned. Only one of filterByEndTime and filterByCopyTaskEndTime can be set.

filterByEndTime boolean

If true, the runs with backup end time within the specified time range will be returned. Otherwise, the runs with start time in the time range are returned.

id string

(String) The tenant id.

includeObjectDetails boolean

Specifies if the result includes the object details for each protection run. If set to true, details of the protected object will be returned. If set to false or not specified, details will not be returned.

localBackupRunStatuses string[]

Specifies a list of local backup status, runs matching the status will be returned. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Paused' indicates that the ongoing run has been paused. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable list items are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

numRuns number

Specifies the max number of runs. If not specified, at most 100 runs will be returned.

onlyReturnSuccessfulCopyRun boolean

only successful copyruns are returned.

replicationRunStatuses string[]

Specifies a list of replication status, runs matching the status will be returned. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Paused' indicates that the ongoing run has been paused. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable list items are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

requestInitiatorType string

Specifies the type of request from UI, which is used for services like magneto to determine the priority of requests.

• Constraints: Allowable values are: UIUser, UIAuto, Helios.

runId string

Specifies the protection run id.

• Constraints: The value must match regular expression /^\\d+:\\d+$/.

runTags string[]

Specifies a list of tags for protection runs. If this is specified, only the runs which match these tags will be returned.

runTypes string[]

Filter by run type. Only protection run matching the specified types will be returned.

• Constraints: Allowable list items are: kAll, kHydrateCDP, kSystem, kStorageArraySnapshot, kIncremental, kFull, kLog.

snapshotTargetTypes string[]

Specifies the snapshot's target type which should be filtered.

• Constraints: Allowable list items are: Local, Archival, RpaasArchival, StorageArraySnapshot, Remote.

startTimeUsecs number

Start time for time range filter. Specify the start time as a Unix epoch Timestamp (in microseconds), only runs executing after this time will be returned. By default it is endTimeUsecs minus an hour.

useCachedData boolean

Specifies whether we can serve the GET request from the read replica cache. There is a lag of 15 seconds between the read replica and primary data source.

protection_group_id str

Specifies a unique id of the Protection Group.

• Constraints: The value must match regular expression /^\\d+:\\d+:\\d+$/.

x_ibm_tenant_id str

Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.

archival_run_statuses Sequence[str]

Specifies a list of archival status, runs matching the status will be returned. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Paused' indicates that the ongoing run has been paused. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable list items are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

cloud_spin_run_statuses Sequence[str]

Specifies a list of cloud spin status, runs matching the status will be returned. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Paused' indicates that the ongoing run has been paused. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable list items are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

end_time_usecs float

End time for time range filter. Specify the end time as a Unix epoch Timestamp (in microseconds), only runs executing before this time will be returned. By default it is current time.

exclude_non_restorable_runs bool

Specifies whether to exclude non restorable runs. Run is treated restorable only if there is atleast one object snapshot (which may be either a local or an archival snapshot) which is not deleted or expired. Default value is false.

• Constraints: The default value is false.

filter_by_copy_task_end_time bool

If true, then the details of the runs for which any copyTask completed in the given timerange will be returned. Only one of filterByEndTime and filterByCopyTaskEndTime can be set.

filter_by_end_time bool

If true, the runs with backup end time within the specified time range will be returned. Otherwise, the runs with start time in the time range are returned.

id str

(String) The tenant id.

include_object_details bool

Specifies if the result includes the object details for each protection run. If set to true, details of the protected object will be returned. If set to false or not specified, details will not be returned.

local_backup_run_statuses Sequence[str]

Specifies a list of local backup status, runs matching the status will be returned. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Paused' indicates that the ongoing run has been paused. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable list items are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

num_runs float

Specifies the max number of runs. If not specified, at most 100 runs will be returned.

only_return_successful_copy_run bool

only successful copyruns are returned.

replication_run_statuses Sequence[str]

Specifies a list of replication status, runs matching the status will be returned. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Paused' indicates that the ongoing run has been paused. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable list items are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

request_initiator_type str

Specifies the type of request from UI, which is used for services like magneto to determine the priority of requests.

• Constraints: Allowable values are: UIUser, UIAuto, Helios.

run_id str

Specifies the protection run id.

• Constraints: The value must match regular expression /^\\d+:\\d+$/.

run_tags Sequence[str]

Specifies a list of tags for protection runs. If this is specified, only the runs which match these tags will be returned.

run_types Sequence[str]

Filter by run type. Only protection run matching the specified types will be returned.

• Constraints: Allowable list items are: kAll, kHydrateCDP, kSystem, kStorageArraySnapshot, kIncremental, kFull, kLog.

snapshot_target_types Sequence[str]

Specifies the snapshot's target type which should be filtered.

• Constraints: Allowable list items are: Local, Archival, RpaasArchival, StorageArraySnapshot, Remote.

start_time_usecs float

Start time for time range filter. Specify the start time as a Unix epoch Timestamp (in microseconds), only runs executing after this time will be returned. By default it is endTimeUsecs minus an hour.

use_cached_data bool

Specifies whether we can serve the GET request from the read replica cache. There is a lag of 15 seconds between the read replica and primary data source.

protectionGroupId String

Specifies a unique id of the Protection Group.

• Constraints: The value must match regular expression /^\\d+:\\d+:\\d+$/.

xIbmTenantId String

Specifies the key to be used to encrypt the source credential. If includeSourceCredentials is set to true this key must be specified.

archivalRunStatuses List<String>

Specifies a list of archival status, runs matching the status will be returned. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Paused' indicates that the ongoing run has been paused. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable list items are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

cloudSpinRunStatuses List<String>

Specifies a list of cloud spin status, runs matching the status will be returned. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Paused' indicates that the ongoing run has been paused. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable list items are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

endTimeUsecs Number

End time for time range filter. Specify the end time as a Unix epoch Timestamp (in microseconds), only runs executing before this time will be returned. By default it is current time.

excludeNonRestorableRuns Boolean

Specifies whether to exclude non restorable runs. Run is treated restorable only if there is atleast one object snapshot (which may be either a local or an archival snapshot) which is not deleted or expired. Default value is false.

• Constraints: The default value is false.

filterByCopyTaskEndTime Boolean

If true, then the details of the runs for which any copyTask completed in the given timerange will be returned. Only one of filterByEndTime and filterByCopyTaskEndTime can be set.

filterByEndTime Boolean

If true, the runs with backup end time within the specified time range will be returned. Otherwise, the runs with start time in the time range are returned.

id String

(String) The tenant id.

includeObjectDetails Boolean

Specifies if the result includes the object details for each protection run. If set to true, details of the protected object will be returned. If set to false or not specified, details will not be returned.

localBackupRunStatuses List<String>

Specifies a list of local backup status, runs matching the status will be returned. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Paused' indicates that the ongoing run has been paused. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable list items are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

numRuns Number

Specifies the max number of runs. If not specified, at most 100 runs will be returned.

onlyReturnSuccessfulCopyRun Boolean

only successful copyruns are returned.

replicationRunStatuses List<String>

Specifies a list of replication status, runs matching the status will be returned. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Paused' indicates that the ongoing run has been paused. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable list items are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

requestInitiatorType String

Specifies the type of request from UI, which is used for services like magneto to determine the priority of requests.

• Constraints: Allowable values are: UIUser, UIAuto, Helios.

runId String

Specifies the protection run id.

• Constraints: The value must match regular expression /^\\d+:\\d+$/.

runTags List<String>

Specifies a list of tags for protection runs. If this is specified, only the runs which match these tags will be returned.

runTypes List<String>

Filter by run type. Only protection run matching the specified types will be returned.

• Constraints: Allowable list items are: kAll, kHydrateCDP, kSystem, kStorageArraySnapshot, kIncremental, kFull, kLog.

snapshotTargetTypes List<String>

Specifies the snapshot's target type which should be filtered.

• Constraints: Allowable list items are: Local, Archival, RpaasArchival, StorageArraySnapshot, Remote.

startTimeUsecs Number

Start time for time range filter. Specify the start time as a Unix epoch Timestamp (in microseconds), only runs executing after this time will be returned. By default it is endTimeUsecs minus an hour.

useCachedData Boolean

Specifies whether we can serve the GET request from the read replica cache. There is a lag of 15 seconds between the read replica and primary data source.

Id string

(String) The tenant id.

ProtectionGroupId string

(String) ProtectionGroupId to which this run belongs.

Runs List<GetBackupRecoveryProtectionGroupRunsRun>

(List) Specifies the list of Protection Group runs. Nested schema for runs:

TotalRuns double

(Integer) Specifies the count of total runs exist for the given set of filters. The number of runs in single API call are limited and this count can be used to estimate query filter values to get next set of remaining runs. Please note that this field will only be populated if startTimeUsecs or endTimeUsecs or both are specified in query parameters.

XIbmTenantId string

ArchivalRunStatuses List<string>

CloudSpinRunStatuses List<string>

EndTimeUsecs double

(Integer) Specifies the end time of replication in Unix epoch Timestamp(in microseconds) for a target.

ExcludeNonRestorableRuns bool

FilterByCopyTaskEndTime bool

FilterByEndTime bool

IncludeObjectDetails bool

LocalBackupRunStatuses List<string>

NumRuns double

OnlyReturnSuccessfulCopyRun bool

ReplicationRunStatuses List<string>

RequestInitiatorType string

RunId string

RunTags List<string>

RunTypes List<string>

SnapshotTargetTypes List<string>

StartTimeUsecs double

(Integer) Specifies the start time of replication in Unix epoch Timestamp(in microseconds) for a target.

UseCachedData bool

Id string

(String) The tenant id.

ProtectionGroupId string

(String) ProtectionGroupId to which this run belongs.

Runs []GetBackupRecoveryProtectionGroupRunsRun

(List) Specifies the list of Protection Group runs. Nested schema for runs:

TotalRuns float64

(Integer) Specifies the count of total runs exist for the given set of filters. The number of runs in single API call are limited and this count can be used to estimate query filter values to get next set of remaining runs. Please note that this field will only be populated if startTimeUsecs or endTimeUsecs or both are specified in query parameters.

XIbmTenantId string

ArchivalRunStatuses []string

CloudSpinRunStatuses []string

EndTimeUsecs float64

(Integer) Specifies the end time of replication in Unix epoch Timestamp(in microseconds) for a target.

ExcludeNonRestorableRuns bool

FilterByCopyTaskEndTime bool

FilterByEndTime bool

IncludeObjectDetails bool

LocalBackupRunStatuses []string

NumRuns float64

OnlyReturnSuccessfulCopyRun bool

ReplicationRunStatuses []string

RequestInitiatorType string

RunId string

RunTags []string

RunTypes []string

SnapshotTargetTypes []string

StartTimeUsecs float64

(Integer) Specifies the start time of replication in Unix epoch Timestamp(in microseconds) for a target.

UseCachedData bool

id String

(String) The tenant id.

protectionGroupId String

(String) ProtectionGroupId to which this run belongs.

runs List<GetBackupRecoveryProtectionGroupRunsRun>

(List) Specifies the list of Protection Group runs. Nested schema for runs:

totalRuns Double

(Integer) Specifies the count of total runs exist for the given set of filters. The number of runs in single API call are limited and this count can be used to estimate query filter values to get next set of remaining runs. Please note that this field will only be populated if startTimeUsecs or endTimeUsecs or both are specified in query parameters.

xIbmTenantId String

archivalRunStatuses List<String>

cloudSpinRunStatuses List<String>

endTimeUsecs Double

(Integer) Specifies the end time of replication in Unix epoch Timestamp(in microseconds) for a target.

excludeNonRestorableRuns Boolean

filterByCopyTaskEndTime Boolean

filterByEndTime Boolean

includeObjectDetails Boolean

localBackupRunStatuses List<String>

numRuns Double

onlyReturnSuccessfulCopyRun Boolean

replicationRunStatuses List<String>

requestInitiatorType String

runId String

runTags List<String>

runTypes List<String>

snapshotTargetTypes List<String>

startTimeUsecs Double

(Integer) Specifies the start time of replication in Unix epoch Timestamp(in microseconds) for a target.

useCachedData Boolean

id string

(String) The tenant id.

protectionGroupId string

(String) ProtectionGroupId to which this run belongs.

runs GetBackupRecoveryProtectionGroupRunsRun[]

(List) Specifies the list of Protection Group runs. Nested schema for runs:

totalRuns number

(Integer) Specifies the count of total runs exist for the given set of filters. The number of runs in single API call are limited and this count can be used to estimate query filter values to get next set of remaining runs. Please note that this field will only be populated if startTimeUsecs or endTimeUsecs or both are specified in query parameters.

xIbmTenantId string

archivalRunStatuses string[]

cloudSpinRunStatuses string[]

endTimeUsecs number

(Integer) Specifies the end time of replication in Unix epoch Timestamp(in microseconds) for a target.

excludeNonRestorableRuns boolean

filterByCopyTaskEndTime boolean

filterByEndTime boolean

includeObjectDetails boolean

localBackupRunStatuses string[]

numRuns number

onlyReturnSuccessfulCopyRun boolean

replicationRunStatuses string[]

requestInitiatorType string

runId string

runTags string[]

runTypes string[]

snapshotTargetTypes string[]

startTimeUsecs number

(Integer) Specifies the start time of replication in Unix epoch Timestamp(in microseconds) for a target.

useCachedData boolean

id str

(String) The tenant id.

protection_group_id str

(String) ProtectionGroupId to which this run belongs.

runs Sequence[GetBackupRecoveryProtectionGroupRunsRun]

(List) Specifies the list of Protection Group runs. Nested schema for runs:

total_runs float

(Integer) Specifies the count of total runs exist for the given set of filters. The number of runs in single API call are limited and this count can be used to estimate query filter values to get next set of remaining runs. Please note that this field will only be populated if startTimeUsecs or endTimeUsecs or both are specified in query parameters.

x_ibm_tenant_id str

archival_run_statuses Sequence[str]

cloud_spin_run_statuses Sequence[str]

end_time_usecs float

(Integer) Specifies the end time of replication in Unix epoch Timestamp(in microseconds) for a target.

exclude_non_restorable_runs bool

filter_by_copy_task_end_time bool

filter_by_end_time bool

include_object_details bool

local_backup_run_statuses Sequence[str]

num_runs float

only_return_successful_copy_run bool

replication_run_statuses Sequence[str]

request_initiator_type str

run_id str

run_tags Sequence[str]

run_types Sequence[str]

snapshot_target_types Sequence[str]

start_time_usecs float

(Integer) Specifies the start time of replication in Unix epoch Timestamp(in microseconds) for a target.

use_cached_data bool

id String

(String) The tenant id.

protectionGroupId String

(String) ProtectionGroupId to which this run belongs.

runs List<Property Map>

(List) Specifies the list of Protection Group runs. Nested schema for runs:

totalRuns Number

(Integer) Specifies the count of total runs exist for the given set of filters. The number of runs in single API call are limited and this count can be used to estimate query filter values to get next set of remaining runs. Please note that this field will only be populated if startTimeUsecs or endTimeUsecs or both are specified in query parameters.

xIbmTenantId String

archivalRunStatuses List<String>

cloudSpinRunStatuses List<String>

endTimeUsecs Number

(Integer) Specifies the end time of replication in Unix epoch Timestamp(in microseconds) for a target.

excludeNonRestorableRuns Boolean

filterByCopyTaskEndTime Boolean

filterByEndTime Boolean

includeObjectDetails Boolean

localBackupRunStatuses List<String>

numRuns Number

onlyReturnSuccessfulCopyRun Boolean

replicationRunStatuses List<String>

requestInitiatorType String

runId String

runTags List<String>

runTypes List<String>

snapshotTargetTypes List<String>

startTimeUsecs Number

(Integer) Specifies the start time of replication in Unix epoch Timestamp(in microseconds) for a target.

useCachedData Boolean

ArchivalInfos List<GetBackupRecoveryProtectionGroupRunsRunArchivalInfo>

(List) Specifies information about archival run for an object. Nested schema for archival_info:

CloudSpinInfos List<GetBackupRecoveryProtectionGroupRunsRunCloudSpinInfo>

(List) Specifies information about Cloud Spin run for an object. Nested schema for cloud_spin_info:

Environment string

(String) Specifies the environment of the object.

• Constraints: Allowable values are: kPhysical, kSQL.

ExternallyTriggeredBackupTag string

(String) The tag of externally triggered backup job.

HasLocalSnapshot bool

(Boolean) Specifies whether the run has a local snapshot. For cloud retrieved runs there may not be local snapshots.

Id string

(String) The tenant id.

IsCloudArchivalDirect bool

(Boolean) Specifies whether the run is a CAD run if cloud archive direct feature is enabled. If this field is true, the primary backup copy will only be available at the given archived location.

IsLocalSnapshotsDeleted bool

(Boolean) Specifies if snapshots for this run has been deleted.

IsReplicationRun bool

(Boolean) Specifies if this protection run is a replication run.

LocalBackupInfos List<GetBackupRecoveryProtectionGroupRunsRunLocalBackupInfo>

(List) Specifies summary information about local snapshot run across all objects. Nested schema for local_backup_info:

Objects List<GetBackupRecoveryProtectionGroupRunsRunObject>

(List) Snapahot, replication, archival results for each object. Nested schema for objects:

OnLegalHold bool

(Boolean) Specifies the legal hold status for a replication target.

OriginClusterIdentifiers List<GetBackupRecoveryProtectionGroupRunsRunOriginClusterIdentifier>

(List) Specifies the information about a cluster. Nested schema for origin_cluster_identifier:

OriginProtectionGroupId string

(String) ProtectionGroupId to which this run belongs on the primary cluster if this run is a replication run.

OriginalBackupInfos List<GetBackupRecoveryProtectionGroupRunsRunOriginalBackupInfo>

(List) Specifies summary information about local snapshot run across all objects. Nested schema for original_backup_info:

Permissions List<GetBackupRecoveryProtectionGroupRunsRunPermission>

(List) Specifies the list of tenants that have permissions for this protection group run. Nested schema for permissions:

ProtectionGroupId string

Specifies a unique id of the Protection Group.

• Constraints: The value must match regular expression /^\\d+:\\d+:\\d+$/.

ProtectionGroupInstanceId double

(Integer) Protection Group instance Id. This field will be removed later.

ProtectionGroupName string

(String) Name of the Protection Group to which this run belongs.

ReplicationInfos List<GetBackupRecoveryProtectionGroupRunsRunReplicationInfo>

(List) Specifies summary information about replication run. Nested schema for replication_info:

ArchivalInfos []GetBackupRecoveryProtectionGroupRunsRunArchivalInfo

(List) Specifies information about archival run for an object. Nested schema for archival_info:

CloudSpinInfos []GetBackupRecoveryProtectionGroupRunsRunCloudSpinInfo

(List) Specifies information about Cloud Spin run for an object. Nested schema for cloud_spin_info:

Environment string

(String) Specifies the environment of the object.

• Constraints: Allowable values are: kPhysical, kSQL.

ExternallyTriggeredBackupTag string

(String) The tag of externally triggered backup job.

HasLocalSnapshot bool

(Boolean) Specifies whether the run has a local snapshot. For cloud retrieved runs there may not be local snapshots.

Id string

(String) The tenant id.

IsCloudArchivalDirect bool

(Boolean) Specifies whether the run is a CAD run if cloud archive direct feature is enabled. If this field is true, the primary backup copy will only be available at the given archived location.

IsLocalSnapshotsDeleted bool

(Boolean) Specifies if snapshots for this run has been deleted.

IsReplicationRun bool

(Boolean) Specifies if this protection run is a replication run.

LocalBackupInfos []GetBackupRecoveryProtectionGroupRunsRunLocalBackupInfo

(List) Specifies summary information about local snapshot run across all objects. Nested schema for local_backup_info:

Objects []GetBackupRecoveryProtectionGroupRunsRunObject

(List) Snapahot, replication, archival results for each object. Nested schema for objects:

OnLegalHold bool

(Boolean) Specifies the legal hold status for a replication target.

OriginClusterIdentifiers []GetBackupRecoveryProtectionGroupRunsRunOriginClusterIdentifier

(List) Specifies the information about a cluster. Nested schema for origin_cluster_identifier:

OriginProtectionGroupId string

(String) ProtectionGroupId to which this run belongs on the primary cluster if this run is a replication run.

OriginalBackupInfos []GetBackupRecoveryProtectionGroupRunsRunOriginalBackupInfo

(List) Specifies summary information about local snapshot run across all objects. Nested schema for original_backup_info:

Permissions []GetBackupRecoveryProtectionGroupRunsRunPermission

(List) Specifies the list of tenants that have permissions for this protection group run. Nested schema for permissions:

ProtectionGroupId string

Specifies a unique id of the Protection Group.

• Constraints: The value must match regular expression /^\\d+:\\d+:\\d+$/.

ProtectionGroupInstanceId float64

(Integer) Protection Group instance Id. This field will be removed later.

ProtectionGroupName string

(String) Name of the Protection Group to which this run belongs.

ReplicationInfos []GetBackupRecoveryProtectionGroupRunsRunReplicationInfo

(List) Specifies summary information about replication run. Nested schema for replication_info:

archivalInfos List<GetBackupRecoveryProtectionGroupRunsRunArchivalInfo>

(List) Specifies information about archival run for an object. Nested schema for archival_info:

cloudSpinInfos List<GetBackupRecoveryProtectionGroupRunsRunCloudSpinInfo>

(List) Specifies information about Cloud Spin run for an object. Nested schema for cloud_spin_info:

environment String

(String) Specifies the environment of the object.

• Constraints: Allowable values are: kPhysical, kSQL.

externallyTriggeredBackupTag String

(String) The tag of externally triggered backup job.

hasLocalSnapshot Boolean

(Boolean) Specifies whether the run has a local snapshot. For cloud retrieved runs there may not be local snapshots.

id String

(String) The tenant id.

isCloudArchivalDirect Boolean

(Boolean) Specifies whether the run is a CAD run if cloud archive direct feature is enabled. If this field is true, the primary backup copy will only be available at the given archived location.

isLocalSnapshotsDeleted Boolean

(Boolean) Specifies if snapshots for this run has been deleted.

isReplicationRun Boolean

(Boolean) Specifies if this protection run is a replication run.

localBackupInfos List<GetBackupRecoveryProtectionGroupRunsRunLocalBackupInfo>

(List) Specifies summary information about local snapshot run across all objects. Nested schema for local_backup_info:

objects List<GetBackupRecoveryProtectionGroupRunsRunObject>

(List) Snapahot, replication, archival results for each object. Nested schema for objects:

onLegalHold Boolean

(Boolean) Specifies the legal hold status for a replication target.

originClusterIdentifiers List<GetBackupRecoveryProtectionGroupRunsRunOriginClusterIdentifier>

(List) Specifies the information about a cluster. Nested schema for origin_cluster_identifier:

originProtectionGroupId String

(String) ProtectionGroupId to which this run belongs on the primary cluster if this run is a replication run.

originalBackupInfos List<GetBackupRecoveryProtectionGroupRunsRunOriginalBackupInfo>

(List) Specifies summary information about local snapshot run across all objects. Nested schema for original_backup_info:

permissions List<GetBackupRecoveryProtectionGroupRunsRunPermission>

(List) Specifies the list of tenants that have permissions for this protection group run. Nested schema for permissions:

protectionGroupId String

Specifies a unique id of the Protection Group.

• Constraints: The value must match regular expression /^\\d+:\\d+:\\d+$/.

protectionGroupInstanceId Double

(Integer) Protection Group instance Id. This field will be removed later.

protectionGroupName String

(String) Name of the Protection Group to which this run belongs.

replicationInfos List<GetBackupRecoveryProtectionGroupRunsRunReplicationInfo>

(List) Specifies summary information about replication run. Nested schema for replication_info:

archivalInfos GetBackupRecoveryProtectionGroupRunsRunArchivalInfo[]

(List) Specifies information about archival run for an object. Nested schema for archival_info:

cloudSpinInfos GetBackupRecoveryProtectionGroupRunsRunCloudSpinInfo[]

(List) Specifies information about Cloud Spin run for an object. Nested schema for cloud_spin_info:

environment string

(String) Specifies the environment of the object.

• Constraints: Allowable values are: kPhysical, kSQL.

externallyTriggeredBackupTag string

(String) The tag of externally triggered backup job.

hasLocalSnapshot boolean

(Boolean) Specifies whether the run has a local snapshot. For cloud retrieved runs there may not be local snapshots.

id string

(String) The tenant id.

isCloudArchivalDirect boolean

(Boolean) Specifies whether the run is a CAD run if cloud archive direct feature is enabled. If this field is true, the primary backup copy will only be available at the given archived location.

isLocalSnapshotsDeleted boolean

(Boolean) Specifies if snapshots for this run has been deleted.

isReplicationRun boolean

(Boolean) Specifies if this protection run is a replication run.

localBackupInfos GetBackupRecoveryProtectionGroupRunsRunLocalBackupInfo[]

(List) Specifies summary information about local snapshot run across all objects. Nested schema for local_backup_info:

objects GetBackupRecoveryProtectionGroupRunsRunObject[]

(List) Snapahot, replication, archival results for each object. Nested schema for objects:

onLegalHold boolean

(Boolean) Specifies the legal hold status for a replication target.

originClusterIdentifiers GetBackupRecoveryProtectionGroupRunsRunOriginClusterIdentifier[]

(List) Specifies the information about a cluster. Nested schema for origin_cluster_identifier:

originProtectionGroupId string

(String) ProtectionGroupId to which this run belongs on the primary cluster if this run is a replication run.

originalBackupInfos GetBackupRecoveryProtectionGroupRunsRunOriginalBackupInfo[]

(List) Specifies summary information about local snapshot run across all objects. Nested schema for original_backup_info:

permissions GetBackupRecoveryProtectionGroupRunsRunPermission[]

(List) Specifies the list of tenants that have permissions for this protection group run. Nested schema for permissions:

protectionGroupId string

Specifies a unique id of the Protection Group.

• Constraints: The value must match regular expression /^\\d+:\\d+:\\d+$/.

protectionGroupInstanceId number

(Integer) Protection Group instance Id. This field will be removed later.

protectionGroupName string

(String) Name of the Protection Group to which this run belongs.

replicationInfos GetBackupRecoveryProtectionGroupRunsRunReplicationInfo[]

(List) Specifies summary information about replication run. Nested schema for replication_info:

archival_infos Sequence[GetBackupRecoveryProtectionGroupRunsRunArchivalInfo]

(List) Specifies information about archival run for an object. Nested schema for archival_info:

cloud_spin_infos Sequence[GetBackupRecoveryProtectionGroupRunsRunCloudSpinInfo]

(List) Specifies information about Cloud Spin run for an object. Nested schema for cloud_spin_info:

environment str

(String) Specifies the environment of the object.

• Constraints: Allowable values are: kPhysical, kSQL.

externally_triggered_backup_tag str

(String) The tag of externally triggered backup job.

has_local_snapshot bool

(Boolean) Specifies whether the run has a local snapshot. For cloud retrieved runs there may not be local snapshots.

id str

(String) The tenant id.

is_cloud_archival_direct bool

(Boolean) Specifies whether the run is a CAD run if cloud archive direct feature is enabled. If this field is true, the primary backup copy will only be available at the given archived location.

is_local_snapshots_deleted bool

(Boolean) Specifies if snapshots for this run has been deleted.

is_replication_run bool

(Boolean) Specifies if this protection run is a replication run.

local_backup_infos Sequence[GetBackupRecoveryProtectionGroupRunsRunLocalBackupInfo]

(List) Specifies summary information about local snapshot run across all objects. Nested schema for local_backup_info:

objects Sequence[GetBackupRecoveryProtectionGroupRunsRunObject]

(List) Snapahot, replication, archival results for each object. Nested schema for objects:

on_legal_hold bool

(Boolean) Specifies the legal hold status for a replication target.

origin_cluster_identifiers Sequence[GetBackupRecoveryProtectionGroupRunsRunOriginClusterIdentifier]

(List) Specifies the information about a cluster. Nested schema for origin_cluster_identifier:

origin_protection_group_id str

(String) ProtectionGroupId to which this run belongs on the primary cluster if this run is a replication run.

original_backup_infos Sequence[GetBackupRecoveryProtectionGroupRunsRunOriginalBackupInfo]

(List) Specifies summary information about local snapshot run across all objects. Nested schema for original_backup_info:

permissions Sequence[GetBackupRecoveryProtectionGroupRunsRunPermission]

(List) Specifies the list of tenants that have permissions for this protection group run. Nested schema for permissions:

protection_group_id str

Specifies a unique id of the Protection Group.

• Constraints: The value must match regular expression /^\\d+:\\d+:\\d+$/.

protection_group_instance_id float

(Integer) Protection Group instance Id. This field will be removed later.

protection_group_name str

(String) Name of the Protection Group to which this run belongs.

replication_infos Sequence[GetBackupRecoveryProtectionGroupRunsRunReplicationInfo]

(List) Specifies summary information about replication run. Nested schema for replication_info:

archivalInfos List<Property Map>

(List) Specifies information about archival run for an object. Nested schema for archival_info:

cloudSpinInfos List<Property Map>

(List) Specifies information about Cloud Spin run for an object. Nested schema for cloud_spin_info:

environment String

(String) Specifies the environment of the object.

• Constraints: Allowable values are: kPhysical, kSQL.

externallyTriggeredBackupTag String

(String) The tag of externally triggered backup job.

hasLocalSnapshot Boolean

(Boolean) Specifies whether the run has a local snapshot. For cloud retrieved runs there may not be local snapshots.

id String

(String) The tenant id.

isCloudArchivalDirect Boolean

(Boolean) Specifies whether the run is a CAD run if cloud archive direct feature is enabled. If this field is true, the primary backup copy will only be available at the given archived location.

isLocalSnapshotsDeleted Boolean

(Boolean) Specifies if snapshots for this run has been deleted.

isReplicationRun Boolean

(Boolean) Specifies if this protection run is a replication run.

localBackupInfos List<Property Map>

(List) Specifies summary information about local snapshot run across all objects. Nested schema for local_backup_info:

objects List<Property Map>

(List) Snapahot, replication, archival results for each object. Nested schema for objects:

onLegalHold Boolean

(Boolean) Specifies the legal hold status for a replication target.

originClusterIdentifiers List<Property Map>

(List) Specifies the information about a cluster. Nested schema for origin_cluster_identifier:

originProtectionGroupId String

(String) ProtectionGroupId to which this run belongs on the primary cluster if this run is a replication run.

originalBackupInfos List<Property Map>

(List) Specifies summary information about local snapshot run across all objects. Nested schema for original_backup_info:

permissions List<Property Map>

(List) Specifies the list of tenants that have permissions for this protection group run. Nested schema for permissions:

protectionGroupId String

Specifies a unique id of the Protection Group.

• Constraints: The value must match regular expression /^\\d+:\\d+:\\d+$/.

protectionGroupInstanceId Number

(Integer) Protection Group instance Id. This field will be removed later.

protectionGroupName String

(String) Name of the Protection Group to which this run belongs.

replicationInfos List<Property Map>

(List) Specifies summary information about replication run. Nested schema for replication_info:

ArchivalTargetResults List<GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResult>

(List) Archival result for an archival target. Nested schema for archival_target_results:

ArchivalTargetResults []GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResult

(List) Archival result for an archival target. Nested schema for archival_target_results:

archivalTargetResults List<GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResult>

(List) Archival result for an archival target. Nested schema for archival_target_results:

archivalTargetResults GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResult[]

(List) Archival result for an archival target. Nested schema for archival_target_results:

archival_target_results Sequence[GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResult]

(List) Archival result for an archival target. Nested schema for archival_target_results:

archivalTargetResults List<Property Map>

(List) Archival result for an archival target. Nested schema for archival_target_results:

ArchivalTaskId string

(String) Specifies the archival task id. This is a protection group UID which only applies when archival type is 'Tape'.

CancelledAppObjectsCount double

(Integer) Specifies the count of app objects for which backup was cancelled.

CancelledObjectsCount double

(Integer) Specifies the count of objects for which backup was cancelled.

DataLockConstraints List<GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResultDataLockConstraint>

(List) Specifies the dataLock constraints for local or target snapshot. Nested schema for data_lock_constraints:

EndTimeUsecs double

End time for time range filter. Specify the end time as a Unix epoch Timestamp (in microseconds), only runs executing before this time will be returned. By default it is current time.

ExpiryTimeUsecs double

(Integer) Specifies the expiry time of attempt in Unix epoch Timestamp (in microseconds) for an object.

FailedAppObjectsCount double

(Integer) Specifies the count of app objects for which backup failed.

FailedObjectsCount double

(Integer) Specifies the count of objects for which backup failed.

IndexingTaskId string

(String) Progress monitor task for indexing.

IsCadArchive bool

(Boolean) Whether this is CAD archive or not.

IsForeverIncremental bool

(Boolean) Whether this is forever incremental or not.

IsIncremental bool

(Boolean) Whether this is an incremental archive. If set to true, this is an incremental archive, otherwise this is a full archive.

IsManuallyDeleted bool

(Boolean) Specifies whether the snapshot is deleted manually.

IsSlaViolated bool

(Boolean) Indicated if SLA has been violated for this run.

Message string

(String) Message about the replication run.

OnLegalHold bool

(Boolean) Specifies the legal hold status for a replication target.

OwnershipContext string

(String) Specifies the ownership context for the target.

• Constraints: Allowable values are: Local, FortKnox.

ProgressTaskId string

(String) Progress monitor task id for local backup run.

QueuedTimeUsecs double

(Integer) Specifies the time when the replication is queued for schedule in Unix epoch Timestamp(in microseconds) for a target.

RunType string

(String) Type of Protection Group run. 'kRegular' indicates an incremental (CBT) backup. Incremental backups utilizing CBT (if supported) are captured of the target protection objects. The first run of a kRegular schedule captures all the blocks. 'kFull' indicates a full (no CBT) backup. A complete backup (all blocks) of the target protection objects are always captured and Change Block Tracking (CBT) is not utilized. 'kLog' indicates a Database Log backup. Capture the database transaction logs to allow rolling back to a specific point in time. 'kSystem' indicates system volume backup. It produces an image for bare metal recovery. 'kStorageArraySnapshot' indicates storage array snapshot backup.

• Constraints: Allowable values are: kRegular, kFull, kLog, kSystem, kHydrateCDP, kStorageArraySnapshot.

SnapshotId string

(String) Snapshot id for a successful snapshot. This field will not be set if the Protection Group Run has no successful attempt.

StartTimeUsecs double

Start time for time range filter. Specify the start time as a Unix epoch Timestamp (in microseconds), only runs executing after this time will be returned. By default it is endTimeUsecs minus an hour.

Stats List<GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResultStat>

(List) Specifies statistics about replication data. Nested schema for stats:

StatsTaskId string

(String) Stats task id for local backup run.

Status string

(String) Status of the replication for a target. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Paused' indicates that the ongoing run has been paused. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

SuccessfulAppObjectsCount double

(Integer) Specifies the count of app objects for which backup was successful.

SuccessfulObjectsCount double

(Integer) Specifies the count of objects for which backup was successful.

TargetId double

(Integer) Specifies the archival target ID.

TargetName string

(String) Specifies the archival target name.

TargetType string

(String) Specifies the archival target type.

• Constraints: Allowable values are: Tape, Cloud, Nas.

TierSettings List<GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResultTierSetting>

(List) Specifies the tier info for archival. Nested schema for tier_settings:

UsageType string

(String) Specifies the usage type for the target.

• Constraints: Allowable values are: Archival, Tiering, Rpaas.

WormProperties List<GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResultWormProperty>

(List) Specifies the WORM related properties for this archive. Nested schema for worm_properties:

ArchivalTaskId string

(String) Specifies the archival task id. This is a protection group UID which only applies when archival type is 'Tape'.

CancelledAppObjectsCount float64

(Integer) Specifies the count of app objects for which backup was cancelled.

CancelledObjectsCount float64

(Integer) Specifies the count of objects for which backup was cancelled.

DataLockConstraints []GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResultDataLockConstraint

(List) Specifies the dataLock constraints for local or target snapshot. Nested schema for data_lock_constraints:

EndTimeUsecs float64

End time for time range filter. Specify the end time as a Unix epoch Timestamp (in microseconds), only runs executing before this time will be returned. By default it is current time.

ExpiryTimeUsecs float64

(Integer) Specifies the expiry time of attempt in Unix epoch Timestamp (in microseconds) for an object.

FailedAppObjectsCount float64

(Integer) Specifies the count of app objects for which backup failed.

FailedObjectsCount float64

(Integer) Specifies the count of objects for which backup failed.

IndexingTaskId string

(String) Progress monitor task for indexing.

IsCadArchive bool

(Boolean) Whether this is CAD archive or not.

IsForeverIncremental bool

(Boolean) Whether this is forever incremental or not.

IsIncremental bool

(Boolean) Whether this is an incremental archive. If set to true, this is an incremental archive, otherwise this is a full archive.

IsManuallyDeleted bool

(Boolean) Specifies whether the snapshot is deleted manually.

IsSlaViolated bool

(Boolean) Indicated if SLA has been violated for this run.

Message string

(String) Message about the replication run.

OnLegalHold bool

(Boolean) Specifies the legal hold status for a replication target.

OwnershipContext string

(String) Specifies the ownership context for the target.

• Constraints: Allowable values are: Local, FortKnox.

ProgressTaskId string

(String) Progress monitor task id for local backup run.

QueuedTimeUsecs float64

(Integer) Specifies the time when the replication is queued for schedule in Unix epoch Timestamp(in microseconds) for a target.

RunType string

(String) Type of Protection Group run. 'kRegular' indicates an incremental (CBT) backup. Incremental backups utilizing CBT (if supported) are captured of the target protection objects. The first run of a kRegular schedule captures all the blocks. 'kFull' indicates a full (no CBT) backup. A complete backup (all blocks) of the target protection objects are always captured and Change Block Tracking (CBT) is not utilized. 'kLog' indicates a Database Log backup. Capture the database transaction logs to allow rolling back to a specific point in time. 'kSystem' indicates system volume backup. It produces an image for bare metal recovery. 'kStorageArraySnapshot' indicates storage array snapshot backup.

• Constraints: Allowable values are: kRegular, kFull, kLog, kSystem, kHydrateCDP, kStorageArraySnapshot.

SnapshotId string

(String) Snapshot id for a successful snapshot. This field will not be set if the Protection Group Run has no successful attempt.

StartTimeUsecs float64

Start time for time range filter. Specify the start time as a Unix epoch Timestamp (in microseconds), only runs executing after this time will be returned. By default it is endTimeUsecs minus an hour.

Stats []GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResultStat

(List) Specifies statistics about replication data. Nested schema for stats:

StatsTaskId string

(String) Stats task id for local backup run.

Status string

(String) Status of the replication for a target. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Paused' indicates that the ongoing run has been paused. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

SuccessfulAppObjectsCount float64

(Integer) Specifies the count of app objects for which backup was successful.

SuccessfulObjectsCount float64

(Integer) Specifies the count of objects for which backup was successful.

TargetId float64

(Integer) Specifies the archival target ID.

TargetName string

(String) Specifies the archival target name.

TargetType string

(String) Specifies the archival target type.

• Constraints: Allowable values are: Tape, Cloud, Nas.

TierSettings []GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResultTierSetting

(List) Specifies the tier info for archival. Nested schema for tier_settings:

UsageType string

(String) Specifies the usage type for the target.

• Constraints: Allowable values are: Archival, Tiering, Rpaas.

WormProperties []GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResultWormProperty

(List) Specifies the WORM related properties for this archive. Nested schema for worm_properties:

archivalTaskId String

(String) Specifies the archival task id. This is a protection group UID which only applies when archival type is 'Tape'.

cancelledAppObjectsCount Double

(Integer) Specifies the count of app objects for which backup was cancelled.

cancelledObjectsCount Double

(Integer) Specifies the count of objects for which backup was cancelled.

dataLockConstraints List<GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResultDataLockConstraint>

(List) Specifies the dataLock constraints for local or target snapshot. Nested schema for data_lock_constraints:

endTimeUsecs Double

End time for time range filter. Specify the end time as a Unix epoch Timestamp (in microseconds), only runs executing before this time will be returned. By default it is current time.

expiryTimeUsecs Double

(Integer) Specifies the expiry time of attempt in Unix epoch Timestamp (in microseconds) for an object.

failedAppObjectsCount Double

(Integer) Specifies the count of app objects for which backup failed.

failedObjectsCount Double

(Integer) Specifies the count of objects for which backup failed.

indexingTaskId String

(String) Progress monitor task for indexing.

isCadArchive Boolean

(Boolean) Whether this is CAD archive or not.

isForeverIncremental Boolean

(Boolean) Whether this is forever incremental or not.

isIncremental Boolean

(Boolean) Whether this is an incremental archive. If set to true, this is an incremental archive, otherwise this is a full archive.

isManuallyDeleted Boolean

(Boolean) Specifies whether the snapshot is deleted manually.

isSlaViolated Boolean

(Boolean) Indicated if SLA has been violated for this run.

message String

(String) Message about the replication run.

onLegalHold Boolean

(Boolean) Specifies the legal hold status for a replication target.

ownershipContext String

(String) Specifies the ownership context for the target.

• Constraints: Allowable values are: Local, FortKnox.

progressTaskId String

(String) Progress monitor task id for local backup run.

queuedTimeUsecs Double

(Integer) Specifies the time when the replication is queued for schedule in Unix epoch Timestamp(in microseconds) for a target.

runType String

(String) Type of Protection Group run. 'kRegular' indicates an incremental (CBT) backup. Incremental backups utilizing CBT (if supported) are captured of the target protection objects. The first run of a kRegular schedule captures all the blocks. 'kFull' indicates a full (no CBT) backup. A complete backup (all blocks) of the target protection objects are always captured and Change Block Tracking (CBT) is not utilized. 'kLog' indicates a Database Log backup. Capture the database transaction logs to allow rolling back to a specific point in time. 'kSystem' indicates system volume backup. It produces an image for bare metal recovery. 'kStorageArraySnapshot' indicates storage array snapshot backup.

• Constraints: Allowable values are: kRegular, kFull, kLog, kSystem, kHydrateCDP, kStorageArraySnapshot.

snapshotId String

(String) Snapshot id for a successful snapshot. This field will not be set if the Protection Group Run has no successful attempt.

startTimeUsecs Double

Start time for time range filter. Specify the start time as a Unix epoch Timestamp (in microseconds), only runs executing after this time will be returned. By default it is endTimeUsecs minus an hour.

stats List<GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResultStat>

(List) Specifies statistics about replication data. Nested schema for stats:

statsTaskId String

(String) Stats task id for local backup run.

status String

(String) Status of the replication for a target. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Paused' indicates that the ongoing run has been paused. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

successfulAppObjectsCount Double

(Integer) Specifies the count of app objects for which backup was successful.

successfulObjectsCount Double

(Integer) Specifies the count of objects for which backup was successful.

targetId Double

(Integer) Specifies the archival target ID.

targetName String

(String) Specifies the archival target name.

targetType String

(String) Specifies the archival target type.

• Constraints: Allowable values are: Tape, Cloud, Nas.

tierSettings List<GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResultTierSetting>

(List) Specifies the tier info for archival. Nested schema for tier_settings:

usageType String

(String) Specifies the usage type for the target.

• Constraints: Allowable values are: Archival, Tiering, Rpaas.

wormProperties List<GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResultWormProperty>

(List) Specifies the WORM related properties for this archive. Nested schema for worm_properties:

archivalTaskId string

(String) Specifies the archival task id. This is a protection group UID which only applies when archival type is 'Tape'.

cancelledAppObjectsCount number

(Integer) Specifies the count of app objects for which backup was cancelled.

cancelledObjectsCount number

(Integer) Specifies the count of objects for which backup was cancelled.

dataLockConstraints GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResultDataLockConstraint[]

(List) Specifies the dataLock constraints for local or target snapshot. Nested schema for data_lock_constraints:

endTimeUsecs number

End time for time range filter. Specify the end time as a Unix epoch Timestamp (in microseconds), only runs executing before this time will be returned. By default it is current time.

expiryTimeUsecs number

(Integer) Specifies the expiry time of attempt in Unix epoch Timestamp (in microseconds) for an object.

failedAppObjectsCount number

(Integer) Specifies the count of app objects for which backup failed.

failedObjectsCount number

(Integer) Specifies the count of objects for which backup failed.

indexingTaskId string

(String) Progress monitor task for indexing.

isCadArchive boolean

(Boolean) Whether this is CAD archive or not.

isForeverIncremental boolean

(Boolean) Whether this is forever incremental or not.

isIncremental boolean

(Boolean) Whether this is an incremental archive. If set to true, this is an incremental archive, otherwise this is a full archive.

isManuallyDeleted boolean

(Boolean) Specifies whether the snapshot is deleted manually.

isSlaViolated boolean

(Boolean) Indicated if SLA has been violated for this run.

message string

(String) Message about the replication run.

onLegalHold boolean

(Boolean) Specifies the legal hold status for a replication target.

ownershipContext string

(String) Specifies the ownership context for the target.

• Constraints: Allowable values are: Local, FortKnox.

progressTaskId string

(String) Progress monitor task id for local backup run.

queuedTimeUsecs number

(Integer) Specifies the time when the replication is queued for schedule in Unix epoch Timestamp(in microseconds) for a target.

runType string

(String) Type of Protection Group run. 'kRegular' indicates an incremental (CBT) backup. Incremental backups utilizing CBT (if supported) are captured of the target protection objects. The first run of a kRegular schedule captures all the blocks. 'kFull' indicates a full (no CBT) backup. A complete backup (all blocks) of the target protection objects are always captured and Change Block Tracking (CBT) is not utilized. 'kLog' indicates a Database Log backup. Capture the database transaction logs to allow rolling back to a specific point in time. 'kSystem' indicates system volume backup. It produces an image for bare metal recovery. 'kStorageArraySnapshot' indicates storage array snapshot backup.

• Constraints: Allowable values are: kRegular, kFull, kLog, kSystem, kHydrateCDP, kStorageArraySnapshot.

snapshotId string

(String) Snapshot id for a successful snapshot. This field will not be set if the Protection Group Run has no successful attempt.

startTimeUsecs number

Start time for time range filter. Specify the start time as a Unix epoch Timestamp (in microseconds), only runs executing after this time will be returned. By default it is endTimeUsecs minus an hour.

stats GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResultStat[]

(List) Specifies statistics about replication data. Nested schema for stats:

statsTaskId string

(String) Stats task id for local backup run.

status string

(String) Status of the replication for a target. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Paused' indicates that the ongoing run has been paused. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

successfulAppObjectsCount number

(Integer) Specifies the count of app objects for which backup was successful.

successfulObjectsCount number

(Integer) Specifies the count of objects for which backup was successful.

targetId number

(Integer) Specifies the archival target ID.

targetName string

(String) Specifies the archival target name.

targetType string

(String) Specifies the archival target type.

• Constraints: Allowable values are: Tape, Cloud, Nas.

tierSettings GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResultTierSetting[]

(List) Specifies the tier info for archival. Nested schema for tier_settings:

usageType string

(String) Specifies the usage type for the target.

• Constraints: Allowable values are: Archival, Tiering, Rpaas.

wormProperties GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResultWormProperty[]

(List) Specifies the WORM related properties for this archive. Nested schema for worm_properties:

archival_task_id str

(String) Specifies the archival task id. This is a protection group UID which only applies when archival type is 'Tape'.

cancelled_app_objects_count float

(Integer) Specifies the count of app objects for which backup was cancelled.

cancelled_objects_count float

(Integer) Specifies the count of objects for which backup was cancelled.

data_lock_constraints Sequence[GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResultDataLockConstraint]

(List) Specifies the dataLock constraints for local or target snapshot. Nested schema for data_lock_constraints:

end_time_usecs float

End time for time range filter. Specify the end time as a Unix epoch Timestamp (in microseconds), only runs executing before this time will be returned. By default it is current time.

expiry_time_usecs float

(Integer) Specifies the expiry time of attempt in Unix epoch Timestamp (in microseconds) for an object.

failed_app_objects_count float

(Integer) Specifies the count of app objects for which backup failed.

failed_objects_count float

(Integer) Specifies the count of objects for which backup failed.

indexing_task_id str

(String) Progress monitor task for indexing.

is_cad_archive bool

(Boolean) Whether this is CAD archive or not.

is_forever_incremental bool

(Boolean) Whether this is forever incremental or not.

is_incremental bool

(Boolean) Whether this is an incremental archive. If set to true, this is an incremental archive, otherwise this is a full archive.

is_manually_deleted bool

(Boolean) Specifies whether the snapshot is deleted manually.

is_sla_violated bool

(Boolean) Indicated if SLA has been violated for this run.

message str

(String) Message about the replication run.

on_legal_hold bool

(Boolean) Specifies the legal hold status for a replication target.

ownership_context str

(String) Specifies the ownership context for the target.

• Constraints: Allowable values are: Local, FortKnox.

progress_task_id str

(String) Progress monitor task id for local backup run.

queued_time_usecs float

(Integer) Specifies the time when the replication is queued for schedule in Unix epoch Timestamp(in microseconds) for a target.

run_type str

(String) Type of Protection Group run. 'kRegular' indicates an incremental (CBT) backup. Incremental backups utilizing CBT (if supported) are captured of the target protection objects. The first run of a kRegular schedule captures all the blocks. 'kFull' indicates a full (no CBT) backup. A complete backup (all blocks) of the target protection objects are always captured and Change Block Tracking (CBT) is not utilized. 'kLog' indicates a Database Log backup. Capture the database transaction logs to allow rolling back to a specific point in time. 'kSystem' indicates system volume backup. It produces an image for bare metal recovery. 'kStorageArraySnapshot' indicates storage array snapshot backup.

• Constraints: Allowable values are: kRegular, kFull, kLog, kSystem, kHydrateCDP, kStorageArraySnapshot.

snapshot_id str

(String) Snapshot id for a successful snapshot. This field will not be set if the Protection Group Run has no successful attempt.

start_time_usecs float

Start time for time range filter. Specify the start time as a Unix epoch Timestamp (in microseconds), only runs executing after this time will be returned. By default it is endTimeUsecs minus an hour.

stats Sequence[GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResultStat]

(List) Specifies statistics about replication data. Nested schema for stats:

stats_task_id str

(String) Stats task id for local backup run.

status str

(String) Status of the replication for a target. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Paused' indicates that the ongoing run has been paused. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

successful_app_objects_count float

(Integer) Specifies the count of app objects for which backup was successful.

successful_objects_count float

(Integer) Specifies the count of objects for which backup was successful.

target_id float

(Integer) Specifies the archival target ID.

target_name str

(String) Specifies the archival target name.

target_type str

(String) Specifies the archival target type.

• Constraints: Allowable values are: Tape, Cloud, Nas.

tier_settings Sequence[GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResultTierSetting]

(List) Specifies the tier info for archival. Nested schema for tier_settings:

usage_type str

(String) Specifies the usage type for the target.

• Constraints: Allowable values are: Archival, Tiering, Rpaas.

worm_properties Sequence[GetBackupRecoveryProtectionGroupRunsRunArchivalInfoArchivalTargetResultWormProperty]

(List) Specifies the WORM related properties for this archive. Nested schema for worm_properties:

archivalTaskId String

(String) Specifies the archival task id. This is a protection group UID which only applies when archival type is 'Tape'.

cancelledAppObjectsCount Number

(Integer) Specifies the count of app objects for which backup was cancelled.

cancelledObjectsCount Number

(Integer) Specifies the count of objects for which backup was cancelled.

dataLockConstraints List<Property Map>

(List) Specifies the dataLock constraints for local or target snapshot. Nested schema for data_lock_constraints:

endTimeUsecs Number

End time for time range filter. Specify the end time as a Unix epoch Timestamp (in microseconds), only runs executing before this time will be returned. By default it is current time.

expiryTimeUsecs Number

(Integer) Specifies the expiry time of attempt in Unix epoch Timestamp (in microseconds) for an object.

failedAppObjectsCount Number

(Integer) Specifies the count of app objects for which backup failed.

failedObjectsCount Number

(Integer) Specifies the count of objects for which backup failed.

indexingTaskId String

(String) Progress monitor task for indexing.

isCadArchive Boolean

(Boolean) Whether this is CAD archive or not.

isForeverIncremental Boolean

(Boolean) Whether this is forever incremental or not.

isIncremental Boolean

(Boolean) Whether this is an incremental archive. If set to true, this is an incremental archive, otherwise this is a full archive.

isManuallyDeleted Boolean

(Boolean) Specifies whether the snapshot is deleted manually.

isSlaViolated Boolean

(Boolean) Indicated if SLA has been violated for this run.

message String

(String) Message about the replication run.

onLegalHold Boolean

(Boolean) Specifies the legal hold status for a replication target.

ownershipContext String

(String) Specifies the ownership context for the target.

• Constraints: Allowable values are: Local, FortKnox.

progressTaskId String

(String) Progress monitor task id for local backup run.

queuedTimeUsecs Number

(Integer) Specifies the time when the replication is queued for schedule in Unix epoch Timestamp(in microseconds) for a target.

runType String

(String) Type of Protection Group run. 'kRegular' indicates an incremental (CBT) backup. Incremental backups utilizing CBT (if supported) are captured of the target protection objects. The first run of a kRegular schedule captures all the blocks. 'kFull' indicates a full (no CBT) backup. A complete backup (all blocks) of the target protection objects are always captured and Change Block Tracking (CBT) is not utilized. 'kLog' indicates a Database Log backup. Capture the database transaction logs to allow rolling back to a specific point in time. 'kSystem' indicates system volume backup. It produces an image for bare metal recovery. 'kStorageArraySnapshot' indicates storage array snapshot backup.

• Constraints: Allowable values are: kRegular, kFull, kLog, kSystem, kHydrateCDP, kStorageArraySnapshot.

snapshotId String

(String) Snapshot id for a successful snapshot. This field will not be set if the Protection Group Run has no successful attempt.

startTimeUsecs Number

Start time for time range filter. Specify the start time as a Unix epoch Timestamp (in microseconds), only runs executing after this time will be returned. By default it is endTimeUsecs minus an hour.

stats List<Property Map>

(List) Specifies statistics about replication data. Nested schema for stats:

statsTaskId String

(String) Stats task id for local backup run.

status String

(String) Status of the replication for a target. 'Running' indicates that the run is still running. 'Canceled' indicates that the run has been canceled. 'Canceling' indicates that the run is in the process of being canceled. 'Paused' indicates that the ongoing run has been paused. 'Failed' indicates that the run has failed. 'Missed' indicates that the run was unable to take place at the scheduled time because the previous run was still happening. 'Succeeded' indicates that the run has finished successfully. 'SucceededWithWarning' indicates that the run finished successfully, but there were some warning messages. 'Skipped' indicates that the run was skipped.

• Constraints: Allowable values are: Accepted, Running, Canceled, Canceling, Failed, Missed, Succeeded, SucceededWithWarning, OnHold, Finalizing, Skipped, Paused.

successfulAppObjectsCount Number

(Integer) Specifies the count of app objects for which backup was successful.

successfulObjectsCount Number

(Integer) Specifies the count of objects for which backup was successful.

targetId Number

(Integer) Specifies the archival target ID.

targetName String

(String) Specifies the archival target name.

targetType String

(String) Specifies the archival target type.

• Constraints: Allowable values are: Tape, Cloud, Nas.

tierSettings List<Property Map>

(List) Specifies the tier info for archival. Nested schema for tier_settings:

usageType String

(String) Specifies the usage type for the target.

• Constraints: Allowable values are: Archival, Tiering, Rpaas.

wormProperties List<Property Map>

(List) Specifies the WORM related properties for this archive. Nested schema for worm_properties:

ExpiryTimeUsecs double

(Integer) Specifies the expiry time of attempt in Unix epoch Timestamp (in microseconds) for an object.

Mode string

(String) Specifies the type of WORM retention type. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

• Constraints: Allowable values are: Compliance, Administrative.

ExpiryTimeUsecs float64

(Integer) Specifies the expiry time of attempt in Unix epoch Timestamp (in microseconds) for an object.

Mode string

(String) Specifies the type of WORM retention type. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

• Constraints: Allowable values are: Compliance, Administrative.

expiryTimeUsecs Double

(Integer) Specifies the expiry time of attempt in Unix epoch Timestamp (in microseconds) for an object.

mode String

(String) Specifies the type of WORM retention type. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

• Constraints: Allowable values are: Compliance, Administrative.

expiryTimeUsecs number

(Integer) Specifies the expiry time of attempt in Unix epoch Timestamp (in microseconds) for an object.

mode string

(String) Specifies the type of WORM retention type. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

• Constraints: Allowable values are: Compliance, Administrative.

expiry_time_usecs float

(Integer) Specifies the expiry time of attempt in Unix epoch Timestamp (in microseconds) for an object.

mode str

(String) Specifies the type of WORM retention type. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

• Constraints: Allowable values are: Compliance, Administrative.

expiryTimeUsecs Number

(Integer) Specifies the expiry time of attempt in Unix epoch Timestamp (in microseconds) for an object.

mode String

(String) Specifies the type of WORM retention type. 'Compliance' implies WORM retention is set for compliance reason. 'Administrative' implies WORM retention is set for administrative purposes.

• Constraints: Allowable values are: Compliance, Administrative.

AvgLogicalTransferRateBps double

(Integer) Specifies the average rate of transfer in bytes per second.

BackupFileCount double

(Integer) The total number of file and directory entities that are backed up in this run. Only applicable to file based backups.

BytesRead double

(Integer) Specifies total logical bytes read for creating the snapshot.

FileWalkDone bool

(Boolean) Specifies whether the file system walk is done. Only applicable to file based backups.

LogicalBytesTransferred double

(Integer) Specifies the total logical bytes transferred.

LogicalSizeBytes double

(Integer) Specifies the total logical size in bytes.

PhysicalBytesTransferred double

(Integer) Specifies the total physical bytes transferred.

TotalFileCount double

(Integer) The total number of file and directory entities visited in this backup. Only applicable to file based backups.

AvgLogicalTransferRateBps float64

(Integer) Specifies the average rate of transfer in bytes per second.

BackupFileCount float64

(Integer) The total number of file and directory entities that are backed up in this run. Only applicable to file based backups.

BytesRead float64

(Integer) Specifies total logical bytes read for creating the snapshot.

FileWalkDone bool

(Boolean) Specifies whether the file system walk is done. Only applicable to file based backups.

LogicalBytesTransferred float64

(Integer) Specifies the total logical bytes transferred.

LogicalSizeBytes float64

(Integer) Specifies the total logical size in bytes.

PhysicalBytesTransferred float64

(Integer) Specifies the total physical bytes transferred.

TotalFileCount float64

(Integer) The total number of file and directory entities visited in this backup. Only applicable to file based backups.

avgLogicalTransferRateBps Double

(Integer) Specifies the average rate of transfer in bytes per second.

backupFileCount Double

(Integer) The total number of file and directory entities that are backed up in this run. Only applicable to file based backups.

bytesRead Double

(Integer) Specifies total logical bytes read for creating the snapshot.

fileWalkDone Boolean

(Boolean) Specifies whether the file system walk is done. Only applicable to file based backups.

logicalBytesTransferred Double

(Integer) Specifies the total logical bytes transferred.

logicalSizeBytes Double

(Integer) Specifies the total logical size in bytes.

physicalBytesTransferred Double

(Integer) Specifies the total physical bytes transferred.

totalFileCount Double

(Integer) The total number of file and directory entities visited in this backup. Only applicable to file based backups.

avgLogicalTransferRateBps number

(Integer) Specifies the average rate of transfer in bytes per second.

backupFileCount number

(Integer) The total number of file and directory entities that are backed up in this run. Only applicable to file based backups.

bytesRead number

(Integer) Specifies total logical bytes read for creating the snapshot.

fileWalkDone boolean

(Boolean) Specifies whether the file system walk is done. Only applicable to file based backups.

logicalBytesTransferred number

(Integer) Specifies the total logical bytes transferred.

logicalSizeBytes number

(Integer) Specifies the total logical size in bytes.

physicalBytesTransferred number

(Integer) Specifies the total physical bytes transferred.

totalFileCount number

(Integer) The total number of file and directory entities visited in this backup. Only applicable to file based backups.

avg_logical_transfer_rate_bps float

(Integer) Specifies the average rate of transfer in bytes per second.

backup_file_count float

(Integer) The total number of file and directory entities that are backed up in this run. Only applicable to file based backups.

bytes_read float

(Integer) Specifies total logical bytes read for creating the snapshot.

file_walk_done bool

(Boolean) Specifies whether the file system walk is done. Only applicable to file based backups.

logical_bytes_transferred float

(Integer) Specifies the total logical bytes transferred.

logical_size_bytes float

(Integer) Specifies the total logical size in bytes.

physical_bytes_transferred float

(Integer) Specifies the total physical bytes transferred.

total_file_count float

(Integer) The total number of file and directory entities visited in this backup. Only applicable to file based backups.

avgLogicalTransferRateBps Number

(Integer) Specifies the average rate of transfer in bytes per second.

backupFileCount Number

(Integer) The total number of file and directory entities that are backed up in this run. Only applicable to file based backups.

bytesRead Number

(Integer) Specifies total logical bytes read for creating the snapshot.

fileWalkDone Boolean

(Boolean) Specifies whether the file system walk is done. Only applicable to file based backups.

logicalBytesTransferred Number

(Integer) Specifies the total logical bytes transferred.

logicalSizeBytes Number

(Integer) Specifies the total logical size in bytes.

physicalBytesTransferred Number

(Integer) Specifies the total physical bytes transferred.

totalFileCount Number

(Integer) The total number of file and directory entities visited in this backup. Only applicable to file based backups.