Package google.cloud.backupdr.v1

Index

BackupDR (interface)
BackupDrProtectionSummary (interface)
AbandonBackupRequest (message)
AcceleratorConfig (message)
AccessConfig (message)
AccessConfig.AccessType (enum)
AccessConfig.NetworkTier (enum)
AdvancedMachineFeatures (message)
AliasIpRange (message)
AllocationAffinity (message)
AllocationAffinity.Type (enum)
AttachedDisk (message)
AttachedDisk.DiskInterface (enum)
AttachedDisk.DiskMode (enum)
AttachedDisk.DiskSavedState (enum)
AttachedDisk.DiskType (enum)
AttachedDisk.InitializeParams (message)
Backup (message)
Backup.BackupType (enum)
Backup.GCPBackupPlanInfo (message)
Backup.State (enum)
BackupApplianceBackupConfig (message)
BackupApplianceBackupProperties (message)
BackupApplianceLockInfo (message)
BackupConfigDetails (message)
BackupConfigDetails.State (enum)
BackupConfigDetails.Type (enum)
BackupConfigInfo (message)
BackupConfigInfo.LastBackupState (enum)
BackupConfigState (enum)
BackupDrPlanConfig (message)
BackupDrPlanRule (message)
BackupDrTemplateConfig (message)
BackupLocation (message)
BackupLocation.Type (enum)
BackupLock (message)
BackupPlan (message)
BackupPlan.State (enum)
BackupPlanAssociation (message)
BackupPlanAssociation.State (enum)
BackupPlanRevision (message)
BackupPlanRevision.State (enum)
BackupRule (message)
BackupVault (message)
BackupVault.AccessRestriction (enum)
BackupVault.State (enum)
BackupVaultView (enum)
BackupView (enum)
BackupWindow (message)
CloudSqlInstanceBackupPlanAssociationProperties (message)
CloudSqlInstanceBackupProperties (message)
CloudSqlInstanceDataSourceProperties (message)
CloudSqlInstanceDataSourceReferenceProperties (message)
CloudSqlInstanceInitializationConfig (message)
CloudSqlInstanceInitializationConfig.Edition (enum)
ComputeInstanceBackupProperties (message)
ComputeInstanceDataSourceProperties (message)
ComputeInstanceRestoreProperties (message)
ComputeInstanceRestoreProperties.InstancePrivateIpv6GoogleAccess (enum)
ComputeInstanceTargetEnvironment (message)
ConfidentialInstanceConfig (message)
CreateBackupPlanAssociationRequest (message)
CreateBackupPlanRequest (message)
CreateBackupVaultRequest (message)
CreateManagementServerRequest (message)
CustomerEncryptionKey (message)
DataSource (message)
DataSource.State (enum)
DataSourceBackupApplianceApplication (message)
DataSourceBackupConfigInfo (message)
DataSourceGcpResource (message)
DataSourceGcpResourceInfo (message)
DataSourceReference (message)
DeleteBackupPlanAssociationRequest (message)
DeleteBackupPlanRequest (message)
DeleteBackupRequest (message)
DeleteBackupVaultRequest (message)
DeleteManagementServerRequest (message)
DiskBackupProperties (message)
DiskBackupProperties.Architecture (enum)
DiskDataSourceProperties (message)
DiskRestoreProperties (message)
DiskRestoreProperties.AccessMode (enum)
DiskRestoreProperties.Architecture (enum)
DiskTargetEnvironment (message)
DisplayDevice (message)
Entry (message)
FetchAccessTokenRequest (message)
FetchAccessTokenResponse (message)
FetchBackupPlanAssociationsForResourceTypeRequest (message)
FetchBackupPlanAssociationsForResourceTypeResponse (message)
FetchDataSourceReferencesForResourceTypeRequest (message)
FetchDataSourceReferencesForResourceTypeResponse (message)
FetchMsComplianceMetadataRequest (message)
FetchMsComplianceMetadataResponse (message)
FetchUsableBackupVaultsRequest (message)
FetchUsableBackupVaultsResponse (message)
FinalizeBackupRequest (message)
GcpBackupConfig (message)
GcpResource (message)
GetBackupPlanAssociationRequest (message)
GetBackupPlanRequest (message)
GetBackupPlanRevisionRequest (message)
GetBackupRequest (message)
GetBackupVaultRequest (message)
GetDataSourceReferenceRequest (message)
GetDataSourceRequest (message)
GetManagementServerRequest (message)
GetTrialRequest (message)
GuestOsFeature (message)
GuestOsFeature.FeatureType (enum)
InitializeServiceRequest (message)
InitializeServiceResponse (message)
InitiateBackupRequest (message)
InitiateBackupResponse (message)
InstanceParams (message)
KeyRevocationActionType (enum)
ListBackupPlanAssociationsRequest (message)
ListBackupPlanAssociationsResponse (message)
ListBackupPlanRevisionsRequest (message)
ListBackupPlanRevisionsResponse (message)
ListBackupPlansRequest (message)
ListBackupPlansResponse (message)
ListBackupVaultsRequest (message)
ListBackupVaultsResponse (message)
ListBackupsRequest (message)
ListBackupsResponse (message)
ListDataSourcesRequest (message)
ListDataSourcesResponse (message)
ListManagementServersRequest (message)
ListManagementServersResponse (message)
ListResourceBackupConfigsRequest (message)
ListResourceBackupConfigsResponse (message)
ManagementServer (message)
ManagementServer.InstanceState (enum)
ManagementServer.InstanceType (enum)
ManagementURI (message)
Metadata (message)
NetworkConfig (message)
NetworkConfig.PeeringMode (enum)
NetworkInterface (message)
NetworkInterface.Ipv6AccessType (enum)
NetworkInterface.NicType (enum)
NetworkInterface.StackType (enum)
NetworkPerformanceConfig (message)
NetworkPerformanceConfig.Tier (enum)
OperationMetadata (message)
PitrSettings (message)
RegionDiskTargetEnvironment (message)
RemoveDataSourceRequest (message)
ResourceBackupConfig (message)
ResourceBackupConfig.ResourceType (enum)
RestoreBackupRequest (message)
RestoreBackupResponse (message)
RuleConfigInfo (message)
RuleConfigInfo.LastBackupState (enum)
Scheduling (message)
Scheduling.InstanceTerminationAction (enum)
Scheduling.NodeAffinity (message)
Scheduling.NodeAffinity.Operator (enum)
Scheduling.OnHostMaintenance (enum)
Scheduling.ProvisioningModel (enum)
SchedulingDuration (message)
ServiceAccount (message)
ServiceLockInfo (message)
SetInternalStatusRequest (message)
SetInternalStatusResponse (message)
StandardSchedule (message)
StandardSchedule.RecurrenceType (enum)
SubscribeTrialRequest (message)
Tags (message)
TargetResource (message)
Trial (message)
Trial.State (enum)
TriggerBackupRequest (message)
UpdateBackupPlanAssociationRequest (message)
UpdateBackupPlanRequest (message)
UpdateBackupRequest (message)
UpdateBackupVaultRequest (message)
UpdateDataSourceRequest (message)
WeekDayOfMonth (message)
WeekDayOfMonth.WeekOfMonth (enum)
WorkforceIdentityBasedManagementURI (message)
WorkforceIdentityBasedOAuth2ClientID (message)

BackupDR

The BackupDR Service

AbandonBackup

rpc AbandonBackup( AbandonBackupRequest ) returns ( Operation )

Internal only. Abandons a backup.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the dataSource resource:

backupdr.bvdataSources.abandonBackup

For more information, see the IAM documentation .

CreateBackupPlan

rpc CreateBackupPlan( CreateBackupPlanRequest ) returns ( Operation )

Create a BackupPlan

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

CreateBackupPlanAssociation

rpc CreateBackupPlanAssociation( CreateBackupPlanAssociationRequest ) returns ( Operation )

Create a BackupPlanAssociation

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

CreateBackupVault

rpc CreateBackupVault( CreateBackupVaultRequest ) returns ( Operation )

Creates a new BackupVault in a given project and location.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the parent resource:

backupdr.backupVaults.create

For more information, see the IAM documentation .

CreateManagementServer

rpc CreateManagementServer( CreateManagementServerRequest ) returns ( Operation )

Creates a new ManagementServer in a given project and location.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

DeleteBackup

rpc DeleteBackup( DeleteBackupRequest ) returns ( Operation )

Deletes a Backup.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the name resource:

backupdr.bvbackups.delete

For more information, see the IAM documentation .

DeleteBackupPlan

rpc DeleteBackupPlan( DeleteBackupPlanRequest ) returns ( Operation )

Deletes a single BackupPlan.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

DeleteBackupPlanAssociation

rpc DeleteBackupPlanAssociation( DeleteBackupPlanAssociationRequest ) returns ( Operation )

Deletes a single BackupPlanAssociation.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

DeleteBackupVault

rpc DeleteBackupVault( DeleteBackupVaultRequest ) returns ( Operation )

Deletes a BackupVault.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the name resource:

backupdr.backupVaults.delete

For more information, see the IAM documentation .

DeleteManagementServer

rpc DeleteManagementServer( DeleteManagementServerRequest ) returns ( Operation )

Deletes a single ManagementServer.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

FetchAccessToken

rpc FetchAccessToken( FetchAccessTokenRequest ) returns ( FetchAccessTokenResponse )

Internal only. Fetch access token for a given data source.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the name resource:

backupdr.bvdataSources.fetchAccessToken

For more information, see the IAM documentation .

FetchBackupPlanAssociationsForResourceType

rpc FetchBackupPlanAssociationsForResourceType( FetchBackupPlanAssociationsForResourceTypeRequest ) returns ( FetchBackupPlanAssociationsForResourceTypeResponse )

List BackupPlanAssociations for a given resource type.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

FetchDataSourceReferencesForResourceType

rpc FetchDataSourceReferencesForResourceType( FetchDataSourceReferencesForResourceTypeRequest ) returns ( FetchDataSourceReferencesForResourceTypeResponse )

Fetch DataSourceReferences for a given project, location and resource type.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

FetchMsComplianceMetadata

rpc FetchMsComplianceMetadata( FetchMsComplianceMetadataRequest ) returns ( FetchMsComplianceMetadataResponse )

Returns the Assured Workloads compliance metadata for a given project.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

FetchUsableBackupVaults

rpc FetchUsableBackupVaults( FetchUsableBackupVaultsRequest ) returns ( FetchUsableBackupVaultsResponse )

FetchUsableBackupVaults lists usable BackupVaults in a given project and location. Usable BackupVault are the ones that user has backupdr.backupVaults.get permission.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

FinalizeBackup

rpc FinalizeBackup( FinalizeBackupRequest ) returns ( Operation )

Internal only. Finalize a backup that was started by a call to InitiateBackup.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the dataSource resource:

backupdr.bvdataSources.finalizeBackup

For more information, see the IAM documentation .

GetBackup

rpc GetBackup( GetBackupRequest ) returns ( Backup )

Gets details of a Backup.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the name resource:

backupdr.bvbackups.get

For more information, see the IAM documentation .

GetBackupPlan

rpc GetBackupPlan( GetBackupPlanRequest ) returns ( BackupPlan )

Gets details of a single BackupPlan.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

GetBackupPlanAssociation

rpc GetBackupPlanAssociation( GetBackupPlanAssociationRequest ) returns ( BackupPlanAssociation )

Gets details of a single BackupPlanAssociation.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

GetBackupPlanRevision

rpc GetBackupPlanRevision( GetBackupPlanRevisionRequest ) returns ( BackupPlanRevision )

Gets details of a single BackupPlanRevision.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

GetBackupVault

rpc GetBackupVault( GetBackupVaultRequest ) returns ( BackupVault )

Gets details of a BackupVault.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the name resource:

backupdr.backupVaults.get

For more information, see the IAM documentation .

GetDataSource

rpc GetDataSource( GetDataSourceRequest ) returns ( DataSource )

Gets details of a DataSource.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the name resource:

backupdr.bvdataSources.get

For more information, see the IAM documentation .

GetDataSourceReference

rpc GetDataSourceReference( GetDataSourceReferenceRequest ) returns ( DataSourceReference )

Gets details of a single DataSourceReference.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

GetManagementServer

rpc GetManagementServer( GetManagementServerRequest ) returns ( ManagementServer )

Gets details of a single ManagementServer.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

GetTrial

rpc GetTrial( GetTrialRequest ) returns ( Trial )

Gets the Trial state for a given project

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

InitializeService

rpc InitializeService( InitializeServiceRequest ) returns ( Operation )

Initializes the service related config for a project.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

InitiateBackup

rpc InitiateBackup( InitiateBackupRequest ) returns ( InitiateBackupResponse )

Internal only. Initiates a backup.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the dataSource resource:

backupdr.bvdataSources.initiateBackup

For more information, see the IAM documentation .

ListBackupPlanAssociations

rpc ListBackupPlanAssociations( ListBackupPlanAssociationsRequest ) returns ( ListBackupPlanAssociationsResponse )

Lists BackupPlanAssociations in a given project and location.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

ListBackupPlanRevisions

rpc ListBackupPlanRevisions( ListBackupPlanRevisionsRequest ) returns ( ListBackupPlanRevisionsResponse )

Lists BackupPlanRevisions in a given project and location.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

ListBackupPlans

rpc ListBackupPlans( ListBackupPlansRequest ) returns ( ListBackupPlansResponse )

Lists BackupPlans in a given project and location.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

ListBackupVaults

rpc ListBackupVaults( ListBackupVaultsRequest ) returns ( ListBackupVaultsResponse )

Lists BackupVaults in a given project and location.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the parent resource:

backupdr.backupVaults.list

For more information, see the IAM documentation .

ListBackups

rpc ListBackups( ListBackupsRequest ) returns ( ListBackupsResponse )

Lists Backups in a given project and location.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the parent resource:

backupdr.bvbackups.list

For more information, see the IAM documentation .

ListDataSources

rpc ListDataSources( ListDataSourcesRequest ) returns ( ListDataSourcesResponse )

Lists DataSources in a given project and location.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the parent resource:

backupdr.bvdataSources.list

For more information, see the IAM documentation .

ListManagementServers

rpc ListManagementServers( ListManagementServersRequest ) returns ( ListManagementServersResponse )

Lists ManagementServers in a given project and location.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

RemoveDataSource

rpc RemoveDataSource( RemoveDataSourceRequest ) returns ( Operation )

Deletes a DataSource. This is a custom method instead of a standard delete method because external clients will not delete DataSources except for BackupDR backup appliances.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the name resource:

backupdr.bvdataSources.remove

For more information, see the IAM documentation .

RestoreBackup

rpc RestoreBackup( RestoreBackupRequest ) returns ( Operation )

Restore from a Backup

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the name resource:

backupdr.bvbackups.restore

For more information, see the IAM documentation .

SetInternalStatus

rpc SetInternalStatus( SetInternalStatusRequest ) returns ( Operation )

Sets the internal status of a DataSource.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the dataSource resource:

backupdr.bvdataSources.setInternalStatus

For more information, see the IAM documentation .

SubscribeTrial

rpc SubscribeTrial( SubscribeTrialRequest ) returns ( Trial )

Subscribes to a trial for a project

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

TestIamPermissions

rpc TestIamPermissions( TestIamPermissionsRequest ) returns ( TestIamPermissionsResponse )

Returns the caller's permissions on a BackupVault resource.

A caller is not required to have Google IAM permission to make this request.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

TriggerBackup

rpc TriggerBackup( TriggerBackupRequest ) returns ( Operation )

Triggers a new Backup.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

UpdateBackup

rpc UpdateBackup( UpdateBackupRequest ) returns ( Operation )

Updates the settings of a Backup.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the name resource:

backupdr.bvbackups.update

For more information, see the IAM documentation .

UpdateBackupPlan

rpc UpdateBackupPlan( UpdateBackupPlanRequest ) returns ( Operation )

Update a BackupPlan.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

UpdateBackupPlanAssociation

rpc UpdateBackupPlanAssociation( UpdateBackupPlanAssociationRequest ) returns ( Operation )

Update a BackupPlanAssociation.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

UpdateBackupVault

rpc UpdateBackupVault( UpdateBackupVaultRequest ) returns ( Operation )

Updates the settings of a BackupVault.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the name resource:

backupdr.backupVaults.update

For more information, see the IAM documentation .

UpdateDataSource

rpc UpdateDataSource( UpdateDataSourceRequest ) returns ( Operation )

Updates the settings of a DataSource.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

IAM Permissions

Requires the following IAM permission on the name resource:

backupdr.bvdataSources.update

For more information, see the IAM documentation .

BackupDrProtectionSummary

The Protection Summary service.

ListResourceBackupConfigs

rpc ListResourceBackupConfigs( ListResourceBackupConfigsRequest ) returns ( ListResourceBackupConfigsResponse )

Lists ResourceBackupConfigs.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview .

AbandonBackupRequest

request message for AbandonBackup.

Fields

data_source

string

Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.

request_id

string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

AcceleratorConfig

A specification of the type and number of accelerator cards attached to the instance.

Fields

Fields
`accelerator_type`	`string` Optional. Full or partial URL of the accelerator type resource to attach to this instance.
`accelerator_count`	`int32` Optional. The number of the guest accelerator cards exposed to this instance.

accelerator_type

string

Optional. Full or partial URL of the accelerator type resource to attach to this instance.

accelerator_count

int32

Optional. The number of the guest accelerator cards exposed to this instance.

AccessConfig

An access configuration attached to an instance's network interface. Only one access config per instance is supported.

Fields
`type`	`AccessType` Optional. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.
`name`	`string` Optional. The name of this access configuration.
`external_ip`	`string` Optional. The external IP address of this access configuration.
`external_ipv6`	`string` Optional. The external IPv6 address of this access configuration.
`external_ipv6_prefix_length`	`int32` Optional. The prefix length of the external IPv6 range.
`set_public_ptr`	`bool` Optional. Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.
`public_ptr_domain_name`	`string` Optional. The DNS domain name for the public PTR record.
`network_tier`	`NetworkTier` Optional. This signifies the networking tier used for configuring this access

AccessType

The type of configuration.

Enums
`ACCESS_TYPE_UNSPECIFIED`	Default value. This value is unused.
`ONE_TO_ONE_NAT`	ONE_TO_ONE_NAT
`DIRECT_IPV6`	Direct IPv6 access.

NetworkTier

Network tier property used by addresses, instances and forwarding rules.

Enums
`NETWORK_TIER_UNSPECIFIED`	Default value. This value is unused.
`PREMIUM`	High quality, Google-grade network tier, support for all networking products.
`STANDARD`	Public internet quality, only limited support for other networking products.

AdvancedMachineFeatures

Specifies options for controlling advanced machine features.

Fields
`enable_nested_virtualization`	`bool` Optional. Whether to enable nested virtualization or not (default is false).
`threads_per_core`	`int32` Optional. The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.
`visible_core_count`	`int32` Optional. The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.
`enable_uefi_networking`	`bool` Optional. Whether to enable UEFI networking for instance creation.

AliasIpRange

An alias IP range attached to an instance's network interface.

Fields

Fields
`ip_cidr_range`	`string` Optional. The IP alias ranges to allocate for this interface.
`subnetwork_range_name`	`string` Optional. The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.

ip_cidr_range

string

Optional. The IP alias ranges to allocate for this interface.

subnetwork_range_name

string

Optional. The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.

AllocationAffinity

Specifies the reservations that this instance can consume from.

Fields

Fields
`values[]`	`string` Optional. Corresponds to the label values of a reservation resource.
`consume_allocation_type`	`Type` Optional. Specifies the type of reservation from which this instance can consume
`key`	`string` Optional. Corresponds to the label key of a reservation resource.

values[]

string

Optional. Corresponds to the label values of a reservation resource.

consume_allocation_type

Type

Optional. Specifies the type of reservation from which this instance can consume

key

string

Optional. Corresponds to the label key of a reservation resource.

Type

Indicates whether to consume from a reservation or not.

Enums
`TYPE_UNSPECIFIED`	Default value. This value is unused.
`NO_RESERVATION`	Do not consume from any allocated capacity.
`ANY_RESERVATION`	Consume any allocation available.
`SPECIFIC_RESERVATION`	Must consume from a specific reservation. Must specify key value fields for specifying the reservations.

AttachedDisk

An instance-attached disk resource.

Fields
`license[]`	`string` Optional. Any valid publicly visible licenses.
`guest_os_feature[]`	`GuestOsFeature` Optional. A list of features to enable on the guest operating system. Applicable only for bootable images.
`initialize_params`	`InitializeParams` Optional. Specifies the parameters to initialize this disk.
`device_name`	`string` Optional. This is used as an identifier for the disks. This is the unique name has to provided to modify disk parameters like disk_name and replica_zones (in case of RePDs)
`kind`	`string` Optional. Type of the resource.
`disk_type_deprecated (deprecated)`	`DiskType` This item is deprecated! Specifies the type of the disk.
`mode`	`DiskMode` Optional. The mode in which to attach this disk.
`source`	`string` Optional. Specifies a valid partial or full URL to an existing Persistent Disk resource.
`index`	`int64` Optional. A zero-based index to this disk, where 0 is reserved for the boot disk.
`boot`	`bool` Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
`auto_delete`	`bool` Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
`disk_interface`	`DiskInterface` Optional. Specifies the disk interface to use for attaching this disk.
`disk_encryption_key`	`CustomerEncryptionKey` Optional. Encrypts or decrypts a disk using a customer-supplied encryption key.
`disk_size_gb`	`int64` Optional. The size of the disk in GB.
`saved_state`	`DiskSavedState` Optional. Output only. The state of the disk.
`disk_type`	`string` Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd
`type`	`DiskType` Optional. Specifies the type of the disk.

DiskInterface

List of the Disk Interfaces.

Enums
`DISK_INTERFACE_UNSPECIFIED`	Default value, which is unused.
`SCSI`	SCSI Disk Interface.
`NVME`	NVME Disk Interface.
`NVDIMM`	NVDIMM Disk Interface.
`ISCSI`	ISCSI Disk Interface.

DiskMode

List of the Disk Modes.

Enums
`DISK_MODE_UNSPECIFIED`	Default value, which is unused.
`READ_WRITE`	Attaches this disk in read-write mode. Only one virtual machine at a time can be attached to a disk in read-write mode.
`READ_ONLY`	Attaches this disk in read-only mode. Multiple virtual machines can use a disk in read-only mode at a time.
`LOCKED`	The disk is locked for administrative reasons. Nobody else can use the disk. This mode is used (for example) when taking a snapshot of a disk to prevent mounting the disk while it is being snapshotted.

DiskSavedState

List of the states of the Disk.

Enums
`DISK_SAVED_STATE_UNSPECIFIED`	Default Disk state has not been preserved.
`PRESERVED`	Disk state has been preserved.

DiskType

List of the Disk Types.

Enums
`DISK_TYPE_UNSPECIFIED`	Default value, which is unused.
`SCRATCH`	A scratch disk type.
`PERSISTENT`	A persistent disk type.

InitializeParams

Specifies the parameters to initialize this disk.

Fields

Fields
`replica_zones[]`	`string` Optional. URL of the zone where the disk should be created. Required for each regional disk associated with the instance.
`disk_name`	`string` Optional. Specifies the disk name. If not specified, the default is to use the name of the instance.

replica_zones[]

string

Optional. URL of the zone where the disk should be created. Required for each regional disk associated with the instance.

disk_name

string

Optional. Specifies the disk name. If not specified, the default is to use the name of the instance.

Backup

Message describing a Backup object.

Fields

name

string

Output only. Identifier. Name of the backup to create. It must have the format "projects/<project>/locations/<location>/backupVaults/<backupvault>/dataSources/{datasource}/backups/{backup}" . {backup} cannot be changed after creation. It must be between 3-63 characters long and must be unique within the datasource.

labels

map<string, string>

Optional. Resource labels to represent user provided metadata. No labels currently defined.

state

State

Output only. The Backup resource instance state.

service_locks[]

BackupLock

Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup.

backup_appliance_locks[]

BackupLock

Optional. The list of BackupLocks taken by the accessor Backup Appliance.

backup_type

BackupType

Output only. Type of the backup, unspecified, scheduled or ondemand.

resource_size_bytes

int64

Output only. source resource size in bytes at the time of the backup.

description

string

Output only. The description of the Backup instance (2048 characters or less).

create_time

Timestamp

Output only. The time when the instance was created.

update_time

Timestamp

Output only. The time when the instance was updated.

enforced_retention_end_time

Timestamp

Optional. The backup can not be deleted before this time.

expire_time

Timestamp

Optional. When this backup is automatically expired.

consistency_time

Timestamp

Output only. The point in time when this backup was captured from the source.

etag

string

Optional. Server specified ETag to prevent updates from overwriting each other.

Union field backup_properties . Workload specific backup properties. backup_properties can be only one of the following:

compute_instance_backup_properties

ComputeInstanceBackupProperties

Output only. Compute Engine specific backup properties.

cloud_sql_instance_backup_properties

CloudSqlInstanceBackupProperties

Output only. Cloud SQL specific backup properties.

backup_appliance_backup_properties

BackupApplianceBackupProperties

Output only. Backup Appliance specific backup properties.

disk_backup_properties

DiskBackupProperties

Output only. Disk specific backup properties.

Union field plan_info . Configuration Info has the resource format-specific configuration. plan_info can be only one of the following:

gcp_backup_plan_info

GCPBackupPlanInfo

Output only. Configuration for a Google Cloud resource.

satisfies_pzs

bool

Optional. Output only. Reserved for future use.

satisfies_pzi

bool

Optional. Output only. Reserved for future use.

BackupType

Type of the backup, scheduled or ondemand.

Enums
`BACKUP_TYPE_UNSPECIFIED`	Backup type is unspecified.
`SCHEDULED`	Scheduled backup.
`ON_DEMAND`	On demand backup.
`ON_DEMAND_OPERATIONAL`	Operational backup.

GCPBackupPlanInfo

GCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup.

Fields
`backup_plan`	`string` Resource name of backup plan by which workload is protected at the time of the backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
`backup_plan_rule_id`	`string` The rule id of the backup plan which triggered this backup in case of scheduled backup or used for
`backup_plan_revision_name`	`string` Resource name of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}/revisions/{revisionId}
`backup_plan_revision_id`	`string` The user friendly id of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup.

State

Holds the state of the backup resource.

Enums
`STATE_UNSPECIFIED`	State not set.
`CREATING`	The backup is being created.
`ACTIVE`	The backup has been created and is fully usable.
`DELETING`	The backup is being deleted.
`ERROR`	The backup is experiencing an issue and might be unusable.
`UPLOADING`	The backup is being uploaded.

BackupApplianceBackupConfig

BackupApplianceBackupConfig captures the backup configuration for applications that are protected by Backup Appliances.

Fields
`backup_appliance_name`	`string` The name of the backup appliance.
`backup_appliance_id`	`int64` The ID of the backup appliance.
`sla_id`	`int64` The ID of the SLA of this application.
`application_name`	`string` The name of the application.
`host_name`	`string` The name of the host where the application is running.
`slt_name`	`string` The name of the SLT associated with the application.
`slp_name`	`string` The name of the SLP associated with the application.

BackupApplianceBackupProperties

BackupApplianceBackupProperties represents BackupDR backup appliance's properties.

Fields
`generation_id`	`int32` Output only. The numeric generation ID of the backup (monotonically increasing).
`finalize_time`	`Timestamp` Output only. The time when this backup object was finalized (if none, backup is not finalized).
`recovery_range_start_time`	`Timestamp` Optional. The earliest timestamp of data available in this Backup.
`recovery_range_end_time`	`Timestamp` Optional. The latest timestamp of data available in this Backup.

BackupApplianceLockInfo

BackupApplianceLockInfo contains metadata about the backupappliance that created the lock.

Fields

backup_appliance_id

int64

Required. The ID of the backup/recovery appliance that created this lock.

backup_appliance_name

string

Required. The name of the backup/recovery appliance that created this lock.

lock_reason

string

Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The value of this string is only meaningful to the client and it is not interpreted by the BackupVault service.

Union field lock_source . The information about this lock. lock_source can be only one of the following:

job_name

string

The job name on the backup/recovery appliance that created this lock.

backup_image

string

The image name that depends on this Backup.

sla_id

int64

The SLA on the backup/recovery appliance that owns the lock.

BackupConfigDetails

BackupConfigDetails has information about how the resource is configured for backups and about the most recent backup taken for this configuration.

Fields

backup_config_source

string

Output only. The full resource name of the backup config source resource. For example, "//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupPlans/{backupplanId}" or "//compute.googleapis.com/projects/{project}/locations/{region}/resourcePolicies/{resourcePolicyId}".

backup_config_source_display_name

string

Output only. The display name of the backup config source resource.

type

Type

Output only. The type of the backup config resource.

state

State

Output only. The state of the backup config resource.

pitr_settings

PitrSettings

Output only. Point in time recovery settings of the backup configuration resource.

latest_successful_backup_time

Timestamp

Output only. Timestamp of the latest successful backup created via this backup configuration.

applicable_resource

string

Output only. The full resource name of the resource that is applicable for the backup configuration. Example: "//compute.googleapis.com/projects/{project}/zones/{zone}/instances/{instance}"

backup_vault

string

Output only. The full resource name of the backup vault that will store the backups generated through this backup configuration. Example: "//backupdr.googleapis.com/v1/projects/{project}/locations/{region}/backupVaults/{backupvaultId}"

backup_locations[]

BackupLocation

The locations where the backups are to be stored.

Union field plan_specific_config . The plan specific config. This depends on the value of

 BackupConfigDetails.type

. For type=BACKUPDR_BACKUP_PLAN, backup_dr_plan_config would be populated to capture information related to Backup and DR's Backup Plans. For type=BACKUPDR_TEMPLATE, backup_dr_template_config would be populated to capture information related to Backup and DR's Template details. plan_specific_config can be only one of the following:

backup_dr_plan_config

BackupDrPlanConfig

Backup and DR's Backup Plan specific data.

backup_dr_template_config

BackupDrTemplateConfig

Backup and DR's Template specific data.

State

The state tells whether the backup config is active or not.

Enums
`STATE_UNSPECIFIED`	Backup config state not set.
`ACTIVE`	The config is in an active state protecting the resource
`INACTIVE`	The config is currently not protecting the resource. Either because it is disabled or the owning project has been deleted without cleanup of the actual resource.
`ERROR`	The config still exists but because of some error state it is not protecting the resource. Like the source project is deleted. For eg. PlanAssociation, BackupPlan is deleted.

Type

Type of the backup configuration. This enum may receive new values in the future.

Enums
`TYPE_UNSPECIFIED`	Backup config type is unspecified.
`CLOUD_SQL_INSTANCE_BACKUP_CONFIG`	Backup config is Cloud SQL instance's automated backup config.
`COMPUTE_ENGINE_RESOURCE_POLICY`	Backup config is Compute Engine Resource Policy.
`BACKUPDR_BACKUP_PLAN`	Backup config is Backup and DR's Backup Plan.
`BACKUPDR_TEMPLATE`	Backup config is Backup and DR's Template.

BackupConfigInfo

BackupConfigInfo has information about how the resource is configured for Backup and about the most recent backup to this vault.

Fields

last_backup_state

LastBackupState

Output only. The status of the last backup to this BackupVault

last_successful_backup_consistency_time

Timestamp

Output only. If the last backup were successful, this field has the consistency date.

last_backup_error

Status

Output only. If the last backup failed, this field has the error message.

Union field backup_config . Configuration Info has the resource format-specific configuration. backup_config can be only one of the following:

gcp_backup_config

GcpBackupConfig

Configuration for a Google Cloud resource.

backup_appliance_backup_config

BackupApplianceBackupConfig

Configuration for an application backed up by a Backup Appliance.

LastBackupState

LastBackupstate tracks whether the last backup was not yet started, successful, failed, or could not be run because of the lack of permissions.

Enums
`LAST_BACKUP_STATE_UNSPECIFIED`	Status not set.
`FIRST_BACKUP_PENDING`	The first backup has not yet completed
`SUCCEEDED`	The most recent backup was successful
`FAILED`	The most recent backup failed
`PERMISSION_DENIED`	The most recent backup could not be run/failed because of the lack of permissions

BackupConfigState

Backup configuration state. Is the resource configured for backup?

Enums
`BACKUP_CONFIG_STATE_UNSPECIFIED`	The possible states of backup configuration. Status not set.
`ACTIVE`	The data source is actively protected (i.e. there is a BackupPlanAssociation or Appliance SLA pointing to it)
`PASSIVE`	The data source is no longer protected (but may have backups under it)

BackupDrPlanConfig

BackupDrPlanConfig has additional information about Backup and DR's Plan backup configuration.

Fields

Fields
`backup_dr_plan_rules[]`	`BackupDrPlanRule` Backup rules of the backup plan resource.

backup_dr_plan_rules[]

BackupDrPlanRule

Backup rules of the backup plan resource.

BackupDrPlanRule

BackupDrPlanRule has rule specific information of the backup plan resource.

Fields

Fields
`rule_id`	`string` Output only. Unique Id of the backup rule.
`last_successful_backup_time`	`Timestamp` Output only. Timestamp of the latest successful backup created via this backup rule.

rule_id

string

Output only. Unique Id of the backup rule.

last_successful_backup_time

Timestamp

Output only. Timestamp of the latest successful backup created via this backup rule.

BackupDrTemplateConfig

BackupDrTemplateConfig has additional information about Backup and DR's Template backup configuration.

Fields

Fields
`first_party_management_uri`	`string` Output only. The URI of the BackupDr template resource for the first party identity users.
`third_party_management_uri`	`string` Output only. The URI of the BackupDr template resource for the third party identity users.

first_party_management_uri

string

Output only. The URI of the BackupDr template resource for the first party identity users.

third_party_management_uri

string

Output only. The URI of the BackupDr template resource for the third party identity users.

BackupLocation

BackupLocation represents a cloud location where a backup can be stored.

Fields

Fields
`type`	`Type` Output only. The type of the location.
`location_id`	`string` Output only. The id of the cloud location. Example: "us-central1"

type

Type

Output only. The type of the location.

location_id

string

Output only. The id of the cloud location. Example: "us-central1"

Type

The type of the location.

Enums
`TYPE_UNSPECIFIED`	Location type is unspecified.
`ZONAL`	Location type is zonal.
`REGIONAL`	Location type is regional.
`MULTI_REGIONAL`	Location type is multi regional.

BackupLock

BackupLock represents a single lock on a Backup resource. An unexpired lock on a Backup prevents the Backup from being deleted.

Fields

lock_until_time

Timestamp

Required. The time after which this lock is not considered valid and will no longer protect the Backup from deletion.

Union field ClientLockInfo . Metadata about the owner and reason for the lock. ClientLockInfo can be only one of the following:

backup_appliance_lock_info

BackupApplianceLockInfo

If the client is a backup and recovery appliance, this contains metadata about why the lock exists.

service_lock_info

ServiceLockInfo

Output only. Contains metadata about the lock exist for Google Cloud native backups.

BackupPlan

A BackupPlan specifies some common fields, such as description as well as one or more BackupRule messages. Each BackupRule has a retention policy and defines a schedule by which the system is to perform backup workloads.

Fields
`name`	`string` Output only. Identifier. The resource name of the `BackupPlan` . Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
`description`	`string` Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters.
`labels`	`map<string, string>` Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}.
`create_time`	`Timestamp` Output only. When the `BackupPlan` was created.
`update_time`	`Timestamp` Output only. When the `BackupPlan` was last updated.
`backup_rules[]`	`BackupRule` Optional. The backup rules for this `BackupPlan` .
`state`	`State` Output only. The `State` for the `BackupPlan` .
`resource_type`	`string` Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance", "alloydb.googleapis.com/Cluster", "compute.googleapis.com/Disk".
`etag`	`string` Optional. `etag` is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources.
`backup_vault`	`string` Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}
`backup_vault_service_account`	`string` Output only. The Google Cloud Platform Service Account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account.
`log_retention_days`	`int64` Optional. Applicable only for CloudSQL resource_type. Configures how long logs will be stored. It is defined in “days”. This value should be greater than or equal to minimum enforced log retention duration of the backup vault.
`supported_resource_types[]`	`string` Output only. All resource types to which backupPlan can be applied.
`revision_id`	`string` Output only. The user friendly revision ID of the `BackupPlanRevision` . Example: v0, v1, v2, etc.
`revision_name`	`string` Output only. The resource id of the `BackupPlanRevision` . Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}`

State

State enumerates the possible states for a BackupPlan .

Enums
`STATE_UNSPECIFIED`	State not set.
`CREATING`	The resource is being created.
`ACTIVE`	The resource has been created and is fully usable.
`DELETING`	The resource is being deleted.
`INACTIVE`	The resource has been created but is not usable.
`UPDATING`	The resource is being updated.

BackupPlanAssociation

A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc

Fields

name

string

Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}

resource_type

string

Required. Immutable. Resource type of workload on which backupplan is applied

resource

string

Required. Immutable. Resource name of workload on which the backup plan is applied.

The format can either be the resource name (e.g., "projects/my-project/zones/us-central1-a/instances/my-instance") or the full resource URI (e.g., "https://www.googleapis.com/compute/v1/projects/my-project/zones/us-central1-a/instances/my-instance").

backup_plan

string

Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}

create_time

Timestamp

Output only. The time when the instance was created.

update_time

Timestamp

Output only. The time when the instance was updated.

state

State

Output only. The BackupPlanAssociation resource state.

rules_config_info[]

RuleConfigInfo

Output only. The config info related to backup rules.

data_source

string

Output only. Resource name of data source which will be used as storage location for backups taken. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}

backup_plan_revision_id

string

Output only. The user friendly revision ID of the BackupPlanRevision .

Example: v0, v1, v2, etc.

backup_plan_revision_name

string

Output only. The resource id of the BackupPlanRevision .

Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}

Union field resource_properties . Properties of the protected GCP resource. resource_properties can be only one of the following:

cloud_sql_instance_backup_plan_association_properties

CloudSqlInstanceBackupPlanAssociationProperties

Output only. Cloud SQL instance's backup plan association properties.

State

Enum for State of BackupPlan Association

Enums
`STATE_UNSPECIFIED`	State not set.
`CREATING`	The resource is being created.
`ACTIVE`	The resource has been created and is fully usable.
`DELETING`	The resource is being deleted.
`INACTIVE`	The resource has been created but is not usable.
`UPDATING`	The resource is being updated.

BackupPlanRevision

BackupPlanRevision represents a snapshot of a BackupPlan at a point in time.

Fields
`name`	`string` Output only. Identifier. The resource name of the `BackupPlanRevision` . Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision}`
`revision_id`	`string` Output only. The user friendly revision ID of the `BackupPlanRevision` . Example: v0, v1, v2, etc.
`state`	`State` Output only. Resource State
`backup_plan_snapshot`	`BackupPlan` The Backup Plan being encompassed by this revision.
`create_time`	`Timestamp` Output only. The timestamp that the revision was created.

State

The state of the BackupPlanRevision .

Enums
`STATE_UNSPECIFIED`	State not set.
`CREATING`	The resource is being created.
`ACTIVE`	The resource has been created and is fully usable.
`DELETING`	The resource is being deleted.
`INACTIVE`	The resource has been created but is not usable.

BackupRule

BackupRule binds the backup schedule to a retention policy.

Fields

rule_id

string

Required. Immutable. The unique id of this BackupRule . The rule_id is unique per BackupPlan .The rule_id must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /[a-z][a-z0-9-]{,62}/.

backup_retention_days

int32

Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault.

Minimum value is 1 and maximum value is 36159 for custom retention on-demand backup. Minimum and maximum values are workload specific for all other rules. Note: Longer retention can lead to higher storage costs post introductory trial. We recommend starting with a short duration of 3 days or less.

Union field backup_schedule_oneof . The schedule that defines the automated backup workloads for this BackupRule . backup_schedule_oneof can be only one of the following:

standard_schedule

StandardSchedule

Optional. Defines a schedule that runs within the confines of a defined window of time.

BackupVault

Message describing a BackupVault object.

Fields
`name`	`string` Output only. Identifier. Name of the backup vault to create. It must have the format `"projects/{project}/locations/{location}/backupVaults/{backupvault}"` . `{backupvault}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location.
`labels`	`map<string, string>` Optional. Resource labels to represent user provided metadata. No labels currently defined:
`state`	`State` Output only. The BackupVault resource instance state.
`backup_count`	`int64` Output only. The number of backups in this backup vault.
`service_account`	`string` Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.
`total_stored_bytes`	`int64` Output only. Total size of the storage used by all backup resources.
`uid`	`string` Output only. Immutable after resource creation until resource deletion.
`annotations`	`map<string, string>` Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.
`access_restriction`	`AccessRestriction` Optional. Note: This field is added for future use case and will not be supported in the current release. Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation.
`description`	`string` Optional. The description of the BackupVault instance (2048 characters or less).
`create_time`	`Timestamp` Output only. The time when the instance was created.
`update_time`	`Timestamp` Output only. The time when the instance was updated.
`backup_minimum_enforced_retention_duration`	`Duration` Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended. Note: Longer minimum enforced retention period impacts potential storage costs post introductory trial. We recommend starting with a short duration of 3 days or less.
`deletable`	`bool` Output only. Set to true when there are no backups nested under this resource.
`etag`	`string` Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.
`effective_time`	`Timestamp` Optional. Time after which the BackupVault resource is locked.

AccessRestriction

Holds the access restriction for the backup vault.

Enums
`ACCESS_RESTRICTION_UNSPECIFIED`	Access restriction not set. If user does not provide any value or pass this value, it will be changed to WITHIN_ORGANIZATION.
`WITHIN_PROJECT`	Access to or from resources outside your current project will be denied.
`WITHIN_ORGANIZATION`	Access to or from resources outside your current organization will be denied.
`UNRESTRICTED`	No access restriction.
`WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA`	Access to or from resources outside your current organization will be denied except for backup appliance.

State

Holds the state of the backup vault resource.

Enums
`STATE_UNSPECIFIED`	State not set.
`CREATING`	The backup vault is being created.
`ACTIVE`	The backup vault has been created and is fully usable.
`DELETING`	The backup vault is being deleted.
`ERROR`	The backup vault is experiencing an issue and might be unusable.
`UPDATING`	The backup vault is being updated.

BackupVaultView

BackupVaultView contains enum options for Partial and Full view.

Enums
`BACKUP_VAULT_VIEW_UNSPECIFIED`	If the value is not set, the default 'FULL' view is used.
`BACKUP_VAULT_VIEW_BASIC`	Includes basic data about the Backup Vault, but not the full contents.
`BACKUP_VAULT_VIEW_FULL`	Includes all data about the Backup Vault. This is the default value (for both ListBackupVaults and GetBackupVault).

BackupView

BackupView contains enum options for Partial and Full view.

Enums
`BACKUP_VIEW_UNSPECIFIED`	If the value is not set, the default 'FULL' view is used.
`BACKUP_VIEW_BASIC`	Includes basic data about the Backup, but not the full contents.
`BACKUP_VIEW_FULL`	Includes all data about the Backup. This is the default value (for both ListBackups and GetBackup).

BackupWindow

BackupWindow defines a window of the day during which backup jobs will run.

Fields

Fields
`start_hour_of_day`	`int32` Required. The hour of day (0-23) when the window starts for e.g. if value of start hour of day is 6 that mean backup window start at 6:00.
`end_hour_of_day`	`int32` Required. The hour of day (1-24) when the window end for e.g. if value of end hour of day is 10 that mean backup window end time is 10:00. End hour of day should be greater than start hour of day. 0 <= start_hour_of_day < end_hour_of_day <= 24 End hour of day is not include in backup window that mean if end_hour_of_day= 10 jobs should start before 10:00.

start_hour_of_day

int32

Required. The hour of day (0-23) when the window starts for e.g. if value of start hour of day is 6 that mean backup window start at 6:00.

end_hour_of_day

int32

Required. The hour of day (1-24) when the window end for e.g. if value of end hour of day is 10 that mean backup window end time is 10:00.

End hour of day should be greater than start hour of day. 0 <= start_hour_of_day < end_hour_of_day <= 24

End hour of day is not include in backup window that mean if end_hour_of_day= 10 jobs should start before 10:00.

CloudSqlInstanceBackupPlanAssociationProperties

Cloud SQL instance's BPA properties.

Fields

Fields
`instance_create_time`	`Timestamp` Output only. The time when the instance was created.

instance_create_time

Timestamp

Output only. The time when the instance was created.

CloudSqlInstanceBackupProperties

CloudSqlInstanceBackupProperties represents Cloud SQL Instance Backup properties.

Fields
`database_installed_version`	`string` Output only. The installed database version of the Cloud SQL instance when the backup was taken.
`final_backup`	`bool` Output only. Whether the backup is a final backup.
`source_instance`	`string` Output only. The source instance of the backup. Format: projects/{project}/instances/{instance}
`instance_tier`	`string` Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840`

CloudSqlInstanceDataSourceProperties

CloudSqlInstanceDataSourceProperties represents the properties of a Cloud SQL resource that are stored in the DataSource.

Fields
`name`	`string` Output only. Name of the Cloud SQL instance backed up by the datasource. Format: projects/{project}/instances/{instance}
`database_installed_version`	`string` Output only. The installed database version of the Cloud SQL instance.
`instance_create_time`	`Timestamp` Output only. The instance creation timestamp.
`instance_tier`	`string` Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840`

CloudSqlInstanceDataSourceReferenceProperties

CloudSqlInstanceDataSourceReferenceProperties represents the properties of a Cloud SQL resource that are stored in the DataSourceReference.

Fields
`name`	`string` Output only. Name of the Cloud SQL instance backed up by the datasource. Format: projects/{project}/instances/{instance}
`database_installed_version`	`string` Output only. The installed database version of the Cloud SQL instance.
`instance_create_time`	`Timestamp` Output only. The instance creation timestamp.
`instance_tier`	`string` Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840`

CloudSqlInstanceInitializationConfig

CloudSqlInstanceInitializationConfig contains the configuration for initializing a Cloud SQL instance.

Fields

Fields
`edition`	`Edition` Required. The edition of the Cloud SQL instance.

edition

Edition

Required. The edition of the Cloud SQL instance.

Edition

The edition of the Cloud SQL instance. For details, see https://cloud.google.com/sql/docs/editions-intro .

Enums
`EDITION_UNSPECIFIED`	Unspecified edition.
`ENTERPRISE`	Enterprise edition.
`ENTERPRISE_PLUS`	Enterprise Plus edition.

ComputeInstanceBackupProperties

ComputeInstanceBackupProperties represents Compute Engine instance backup properties.

Fields
`network_interface[]`	`NetworkInterface` An array of network access configurations for this interface.
`disk[]`	`AttachedDisk` An array of disks that are associated with the instances that are created from these properties.
`service_account[]`	`ServiceAccount` A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.
`guest_accelerator[]`	`AcceleratorConfig` A list of guest accelerator cards' type and count to use for instances created from these properties.
`labels`	`map<string, string>` Labels to apply to instances that are created from these properties.
`description`	`string` An optional text description for the instances that are created from these properties.
`tags`	`Tags` A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 ( https://www.ietf.org/rfc/rfc1035.txt) .
`machine_type`	`string` The machine type to use for instances that are created from these properties.
`can_ip_forward`	`bool` Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify `true` . If unsure, leave this set to `false` . See the https://cloud.google.com/vpc/docs/using-routes#canipforward documentation for more information.
`metadata`	`Metadata` The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See https://cloud.google.com/compute/docs/metadata/overview for more information.
`scheduling`	`Scheduling` Specifies the scheduling options for the instances that are created from these properties.
`min_cpu_platform`	`string` Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: Intel Haswell` or `minCpuPlatform: Intel Sandy Bridge` . For more information, read https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform .
`key_revocation_action_type`	`KeyRevocationActionType` KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.
`source_instance`	`string` The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance

ComputeInstanceDataSourceProperties

ComputeInstanceDataSourceProperties represents the properties of a ComputeEngine resource that are stored in the DataSource.

Fields
`name`	`string` Name of the compute instance backed up by the datasource.
`description`	`string` The description of the Compute Engine instance.
`machine_type`	`string` The machine type of the instance.
`total_disk_count`	`int64` The total number of disks attached to the Instance.
`total_disk_size_gb`	`int64` The sum of all the disk sizes.

ComputeInstanceRestoreProperties

ComputeInstanceRestoreProperties represents Compute Engine instance properties to be overridden during restore.

Fields
`disks[]`	`AttachedDisk` Optional. Array of disks associated with this instance. Persistent disks must be created before you can assign them. Source regional persistent disks will be restored with default replica zones if not specified.
`guest_accelerators[]`	`AcceleratorConfig` Optional. A list of the type and count of accelerator cards attached to the instance.
`labels`	`map<string, string>` Optional. Labels to apply to this instance.
`network_interfaces[]`	`NetworkInterface` Optional. An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance. Required to restore in different project or region.
`resource_policies[]`	`string` Optional. Resource policies applied to this instance. By default, no resource policies will be applied.
`service_accounts[]`	`ServiceAccount` Optional. A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.
`name`	`string` Required. Name of the compute instance.
`advanced_machine_features`	`AdvancedMachineFeatures` Optional. Controls for advanced machine-related behavior features.
`can_ip_forward`	`bool` Optional. Allows this instance to send and receive packets with non-matching destination or source IPs.
`confidential_instance_config`	`ConfidentialInstanceConfig` Optional. Controls Confidential compute options on the instance
`deletion_protection`	`bool` Optional. Whether the resource should be protected against deletion.
`description`	`string` Optional. An optional description of this resource. Provide this property when you create the resource.
`display_device`	`DisplayDevice` Optional. Enables display device for the instance.
`hostname`	`string` Optional. Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.
`instance_encryption_key`	`CustomerEncryptionKey` Optional. Encrypts suspended data for an instance with a customer-managed encryption key.
`key_revocation_action_type`	`KeyRevocationActionType` Optional. KeyRevocationActionType of the instance.
`machine_type`	`string` Optional. Full or partial URL of the machine type resource to use for this instance.
`metadata`	`Metadata` Optional. This includes custom metadata and predefined keys.
`min_cpu_platform`	`string` Optional. Minimum CPU platform to use for this instance.
`network_performance_config`	`NetworkPerformanceConfig` Optional. Configure network performance such as egress bandwidth tier.
`params`	`InstanceParams` Input only. Additional params passed with the request, but not persisted as part of resource payload.
`private_ipv6_google_access`	`InstancePrivateIpv6GoogleAccess` Optional. The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
`allocation_affinity`	`AllocationAffinity` Optional. Specifies the reservations that this instance can consume from.
`scheduling`	`Scheduling` Optional. Sets the scheduling options for this instance.
`tags`	`Tags` Optional. Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation.

InstancePrivateIpv6GoogleAccess

The private IPv6 google access type for the VMs.

Enums
`INSTANCE_PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED`	Default value. This value is unused.
`INHERIT_FROM_SUBNETWORK`	Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
`ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE`	Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.
`ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE`	Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.

ComputeInstanceTargetEnvironment

ComputeInstanceTargetEnvironment represents Compute Engine target environment to be used during restore.

Fields

project

string

Required. Target project for the Compute Engine instance.

zone

string

Required. The zone of the Compute Engine instance.

ConfidentialInstanceConfig

A set of Confidential Instance options.

Fields

enable_confidential_compute

bool

Optional. Defines whether the instance should have confidential compute enabled.

CreateBackupPlanAssociationRequest

Request message for creating a backup plan.

Fields
`parent`	`string` Required. The backup plan association project and location in the format `projects/{project_id}/locations/{location}` . In Cloud BackupDR locations map to GCP regions, for example us-central1.
`backup_plan_association_id`	`string` Required. The name of the backup plan association to create. The name must be unique for the specified project and location.
`backup_plan_association`	`BackupPlanAssociation` Required. The resource being created
`request_id`	`string` Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

CreateBackupPlanRequest

The request message for creating a BackupPlan .

Fields
`parent`	`string` Required. The `BackupPlan` project and location in the format `projects/{project}/locations/{location}` . In Cloud BackupDR locations map to GCP regions, for example us-central1.
`backup_plan_id`	`string` Required. The name of the `BackupPlan` to create. The name must be unique for the specified project and location.The name must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /[a-z][a-z0-9-]{,62}/.
`backup_plan`	`BackupPlan` Required. The `BackupPlan` resource object to create.
`request_id`	`string` Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

CreateBackupVaultRequest

Message for creating a BackupVault.

Fields
`parent`	`string` Required. Value for parent.
`backup_vault_id`	`string` Required. ID of the requesting object If auto-generating ID server-side, remove this field and backup_vault_id from the method_signature of Create RPC
`backup_vault`	`BackupVault` Required. The resource being created
`request_id`	`string` Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
`validate_only`	`bool` Optional. Only validate the request, but do not perform mutations. The default is 'false'.

CreateManagementServerRequest

Request message for creating a management server instance.

Fields
`parent`	`string` Required. The management server project and location in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR locations map to Google Cloud regions, for example us-central1.
`management_server_id`	`string` Required. The name of the management server to create. The name must be unique for the specified project and location.
`management_server`	`ManagementServer` Required. A `management server resource`
`request_id`	`string` Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

CustomerEncryptionKey

A customer-supplied encryption key.

Fields

Union field key . The key to use for encryption. key can be only one of the following:

raw_key

string

Optional. Specifies a 256-bit customer-supplied encryption key.

rsa_encrypted_key

string

Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.

kms_key_name

string

Optional. The name of the encryption key that is stored in Google Cloud KMS.

kms_key_service_account

string

Optional. The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.

DataSource

Message describing a DataSource object. Datasource object used to represent Datasource details for both admin and basic view.

Fields

name

string

Output only. Identifier. Name of the datasource to create. It must have the format "projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}" . {datasource} cannot be changed after creation. It must be between 3-63 characters long and must be unique within the backup vault.

state

State

Output only. The DataSource resource instance state.

labels

map<string, string>

Optional. Resource labels to represent user provided metadata. No labels currently defined:

config_state

BackupConfigState

Output only. The backup configuration state.

backup_config_info

BackupConfigInfo

Output only. Details of how the resource is configured for backup.

backup_blocked_by_vault_access_restriction

bool

Output only. This field is set to true if the backup is blocked by vault access restriction.

create_time

Timestamp

Output only. The time when the instance was created.

update_time

Timestamp

Output only. The time when the instance was updated.

backup_count

int64

Number of backups in the data source.

etag

string

Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.

total_stored_bytes

int64

The number of bytes (metadata and data) stored in this datasource.

Union field source_resource . The source resource that is represented by this DataSource. It can be a Google Cloud resource, or one backed up by a Backup Appliance. source_resource can be only one of the following:

data_source_gcp_resource

DataSourceGcpResource

The backed up resource is a Google Cloud resource. The word 'DataSource' was included in the names to indicate that this is the representation of the Google Cloud resource used within the DataSource object.

data_source_backup_appliance_application

DataSourceBackupApplianceApplication

The backed up resource is a backup appliance application.

State

Holds the state of the data source resource.

Enums
`STATE_UNSPECIFIED`	State not set.
`CREATING`	The data source is being created.
`ACTIVE`	The data source has been created and is fully usable.
`DELETING`	The data source is being deleted.
`ERROR`	The data source is experiencing an issue and might be unusable.

DataSourceBackupApplianceApplication

BackupApplianceApplication describes a Source Resource when it is an application backed up by a BackupAppliance.

Fields
`application_name`	`string` The name of the Application as known to the Backup Appliance.
`backup_appliance`	`string` Appliance name.
`appliance_id`	`int64` Appliance Id of the Backup Appliance.
`type`	`string` The type of the application. e.g. VMBackup
`application_id`	`int64` The appid field of the application within the Backup Appliance.
`hostname`	`string` Hostname of the host where the application is running.
`host_id`	`int64` Hostid of the application host.

DataSourceBackupConfigInfo

Information of backup configuration on the DataSource.

Fields

last_backup_state

LastBackupState

Output only. The status of the last backup in this DataSource

last_successful_backup_consistency_time

Timestamp

Output only. Timestamp of the last successful backup to this DataSource.

DataSourceGcpResource

DataSourceGcpResource is used for protected resources that are Google Cloud Resources. This name is easeier to understand than GcpResourceDataSource or GcpDataSourceResource

Fields

gcp_resourcename

string

Output only. Full resource pathname URL of the source Google Cloud resource.

location

string

Location of the resource: / /"global"/"unspecified".

type

string

The type of the Google Cloud resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance.

Union field gcp_resource_properties . gcp_Properties has properties of the Google Cloud Resource. gcp_resource_properties can be only one of the following:

compute_instance_datasource_properties

ComputeInstanceDataSourceProperties

ComputeInstanceDataSourceProperties has a subset of Compute Instance properties that are useful at the Datasource level.

cloud_sql_instance_datasource_properties

CloudSqlInstanceDataSourceProperties

Output only. CloudSqlInstanceDataSourceProperties has a subset of Cloud SQL Instance properties that are useful at the Datasource level.

disk_datasource_properties

DiskDataSourceProperties

DiskDataSourceProperties has a subset of Disk properties that are useful at the Datasource level.

DataSourceGcpResourceInfo

The GCP resource that the DataSource is associated with.

Fields

gcp_resourcename

string

Output only. The resource name of the GCP resource. Ex: projects/{project}/zones/{zone}/instances/{instance}

type

string

Output only. The type of the GCP resource. Ex: compute.googleapis.com/Instance

location

string

Output only. The location of the GCP resource. Ex: / /"global"/"unspecified"

Union field resource_properties . The properties of the GCP resource. resource_properties can be only one of the following:

cloud_sql_instance_properties

CloudSqlInstanceDataSourceReferenceProperties

Output only. The properties of the Cloud SQL instance.

DataSourceReference

DataSourceReference is a reference to a DataSource resource.

Fields
`name`	`string` Identifier. The resource name of the DataSourceReference. Format: projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference}
`data_source`	`string` Output only. The resource name of the DataSource. Format: projects/{project}/locations/{location}/backupVaults/{backupVault}/dataSources/{dataSource}
`create_time`	`Timestamp` Output only. The time when the DataSourceReference was created.
`data_source_backup_config_state`	`BackupConfigState` Output only. The backup configuration state of the DataSource.
`data_source_backup_count`	`int64` Output only. Number of backups in the DataSource.
`data_source_backup_config_info`	`DataSourceBackupConfigInfo` Output only. Information of backup configuration on the DataSource.
`data_source_gcp_resource_info`	`DataSourceGcpResourceInfo` Output only. The GCP resource that the DataSource is associated with.

DeleteBackupPlanAssociationRequest

Request message for deleting a backup plan association.

Fields

name

string

Required. Name of the backup plan association resource, in the format projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}

request_id

string

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

DeleteBackupPlanRequest

The request message for deleting a BackupPlan .

Fields

name

string

Required. The resource name of the BackupPlan to delete.

Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}

request_id

string

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

DeleteBackupRequest

Message for deleting a Backup.

Fields

name

string

Required. Name of the resource.

request_id

string

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

DeleteBackupVaultRequest

Message for deleting a BackupVault.

Fields
`name`	`string` Required. Name of the resource.
`request_id`	`string` Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
`force`	`bool` Optional. If set to true, any data source from this backup vault will also be deleted.
`etag`	`string` The current etag of the backup vault. If an etag is provided and does not match the current etag of the connection, deletion will be blocked.
`validate_only`	`bool` Optional. Only validate the request, but do not perform mutations. The default is 'false'.
`allow_missing`	`bool` Optional. If true and the BackupVault is not found, the request will succeed but no action will be taken.
`ignore_backup_plan_references`	`bool` Optional. If set to true, backupvault deletion will proceed even if there are backup plans referencing the backupvault. The default is 'false'.

DeleteManagementServerRequest

Request message for deleting a management server instance.

Fields

name

string

Required. Name of the resource

request_id

string

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

DiskBackupProperties

DiskBackupProperties represents the properties of a Disk backup.

Fields
`licenses[]`	`string` A list of publicly available licenses that are applicable to this backup. This is applicable if the original image had licenses attached, e.g. Windows image.
`guest_os_feature[]`	`GuestOsFeature` A list of guest OS features that are applicable to this backup.
`replica_zones[]`	`string` The URL of the Zones where the source disk should be replicated.
`labels`	`map<string, string>` The labels of the source disk.
`description`	`string` A description of the source disk.
`architecture`	`Architecture` The architecture of the source disk. Valid values are ARM64 or X86_64.
`type`	`string` The URL of the type of the disk.
`size_gb`	`int64` Size(in GB) of the source disk.
`region`	`string` Region and zone are mutually exclusive fields. The URL of the region of the source disk.
`zone`	`string` The URL of the Zone where the source disk.
`source_disk`	`string` The source disk used to create this backup.
`access_mode`	`string` The access mode of the source disk.
`provisioned_iops`	`int64` The number of IOPS provisioned for the source disk.
`provisioned_throughput`	`int64` The number of throughput provisioned for the source disk.
`physical_block_size_bytes`	`int64` The physical block size of the source disk.
`enable_confidential_compute`	`bool` Indicates whether the source disk is using confidential compute mode.
`storage_pool`	`string` The storage pool of the source disk.

Architecture

Architecture of the source disk.

Enums
`ARCHITECTURE_UNSPECIFIED`	Default value. This value is unused.
`X86_64`	Disks with architecture X86_64
`ARM64`	Disks with architecture ARM64

DiskDataSourceProperties

DiskDataSourceProperties represents the properties of a Disk resource that are stored in the DataSource. .

Fields
`name`	`string` Name of the disk backed up by the datasource.
`description`	`string` The description of the disk.
`type`	`string` The type of the disk.
`size_gb`	`int64` The size of the disk in GB.

DiskRestoreProperties

DiskRestoreProperties represents the properties of a Disk restore.

Fields
`licenses[]`	`string` Optional. A list of publicly available licenses that are applicable to this backup. This is applicable if the original image had licenses attached, e.g. Windows image
`guest_os_feature[]`	`GuestOsFeature` Optional. A list of features to enable in the guest operating system. This is applicable only for bootable images.
`resource_policy[]`	`string` Optional. Resource policies applied to this disk.
`labels`	`map<string, string>` Optional. Labels to apply to this disk. These can be modified later using `setLabels` method. Label values can be empty.
`resource_manager_tags`	`map<string, string>` Optional. Resource manager tags to be bound to the disk.
`name`	`string` Required. Name of the disk.
`description`	`string` Optional. An optional description of this resource. Provide this property when you create the resource.
`size_gb`	`int64` Required. The size of the disk in GB.
`disk_encryption_key`	`CustomerEncryptionKey` Optional. Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key.
`physical_block_size_bytes`	`int64` Optional. Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently, the supported size is 4096.
`provisioned_iops`	`int64` Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle.
`provisioned_throughput`	`int64` Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput MB per second that the disk can handle.
`enable_confidential_compute`	`bool` Optional. Indicates whether this disk is using confidential compute mode. Encryption with a Cloud KMS key is required to enable this option.
`storage_pool`	`string` Optional. The storage pool in which the new disk is created. You can provide this as a partial or full URL to the resource.
`access_mode`	`AccessMode` Optional. The access mode of the disk.
`architecture`	`Architecture` Optional. The architecture of the source disk. Valid values are ARM64 or X86_64.
`type`	`string` Required. URL of the disk type resource describing which disk type to use to create the disk.

AccessMode

The supported access modes of the disk.

Enums
`READ_WRITE_SINGLE`	The default AccessMode, means the disk can be attached to single instance in RW mode.
`READ_WRITE_MANY`	The AccessMode means the disk can be attached to multiple instances in RW mode.
`READ_ONLY_MANY`	The AccessMode means the disk can be attached to multiple instances in RO mode.

Architecture

Architecture of the source disk.

Enums
`ARCHITECTURE_UNSPECIFIED`	Default value. This value is unused.
`X86_64`	Disks with architecture X86_64
`ARM64`	Disks with architecture ARM64

DiskTargetEnvironment

DiskTargetEnvironment represents the target environment for the disk.

Fields

project

string

Required. Target project for the disk.

zone

string

Required. Target zone for the disk.

DisplayDevice

A set of Display Device options

Fields

enable_display

bool

Optional. Enables display for the Compute Engine VM

Entry

A key/value pair to be used for storing metadata.

Fields

key

string

Optional. Key for the metadata entry.

value

string

Optional. Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).

FetchAccessTokenRequest

Request message for FetchAccessToken.

Fields

name

string

Required. The resource name for the location for which static IPs should be returned. Must be in the format 'projects/*/locations/*/backupVaults/*/dataSources'.

generation_id

int32

Required. The generation of the backup to update.

FetchAccessTokenResponse

Response message for FetchAccessToken.

Fields
`read_location`	`string` The location in bucket that can be used for reading.
`write_location`	`string` The location in bucket that can be used for writing.
`token`	`string` The downscoped token that was created.
`expire_time`	`Timestamp` The token is valid until this time.

FetchBackupPlanAssociationsForResourceTypeRequest

Request for the FetchBackupPlanAssociationsForResourceType method.

Fields
`parent`	`string` Required. The parent resource name. Format: projects/{project}/locations/{location}
`resource_type`	`string` Required. The type of the GCP resource. Ex: sql.googleapis.com/Instance
`page_size`	`int32` Optional. The maximum number of BackupPlanAssociations to return. The service may return fewer than this value. If unspecified, at most 50 BackupPlanAssociations will be returned. The maximum value is 100; values above 100 will be coerced to 100.
`page_token`	`string` Optional. A page token, received from a previous call of `FetchBackupPlanAssociationsForResourceType` . Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchBackupPlanAssociationsForResourceType` must match the call that provided the page token.
`filter`	`string` Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields: * resource * backup_plan * state * data_source * cloud_sql_instance_backup_plan_association_properties.instance_create_time
`order_by`	`string` Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * name

FetchBackupPlanAssociationsForResourceTypeResponse

Response for the FetchBackupPlanAssociationsForResourceType method.

Fields

backup_plan_associations[]

BackupPlanAssociation

Output only. The BackupPlanAssociations from the specified parent.

next_page_token

string

Output only. A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

FetchDataSourceReferencesForResourceTypeRequest

Request for the FetchDataSourceReferencesForResourceType method.

Fields
`parent`	`string` Required. The parent resource name. Format: projects/{project}/locations/{location}
`resource_type`	`string` Required. The type of the GCP resource. Ex: sql.googleapis.com/Instance
`page_size`	`int32` Optional. The maximum number of DataSourceReferences to return. The service may return fewer than this value. If unspecified, at most 50 DataSourceReferences will be returned. The maximum value is 100; values above 100 will be coerced to 100.
`page_token`	`string` Optional. A page token, received from a previous call of `FetchDataSourceReferencesForResourceType` . Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchDataSourceReferencesForResourceType` must match the call that provided the page token.
`filter`	`string` Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields: * data_source * data_source_gcp_resource_info.gcp_resourcename * data_source_backup_config_state * data_source_backup_count * data_source_backup_config_info.last_backup_state * data_source_gcp_resource_info.gcp_resourcename * data_source_gcp_resource_info.type * data_source_gcp_resource_info.location * data_source_gcp_resource_info.cloud_sql_instance_properties.instance_create_time
`order_by`	`string` Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * name

FetchDataSourceReferencesForResourceTypeResponse

Response for the FetchDataSourceReferencesForResourceType method.

Fields

data_source_references[]

DataSourceReference

The DataSourceReferences from the specified parent.

next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

FetchMsComplianceMetadataRequest

Request message for GetMsComplianceMetadata

Fields

parent

string

Required. The project and location to be used to check CSS metadata for target project information, in the format 'projects/{project_id}/locations/{location}'. In Cloud BackupDR, locations map to Google Cloud regions, for example us-central1.

project_id

string

Required. The project id of the target project

FetchMsComplianceMetadataResponse

Response message for GetMsComplianceMetadata

Fields

is_assured_workload

bool

The ms compliance metadata of the target project, if the project is an assured workloads project, values will be true, otherwise false.

FetchUsableBackupVaultsRequest

Request message for fetching usable BackupVaults.

Fields
`parent`	`string` Required. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1. To retrieve backupvault stores for all locations, use "-" for the '{location}' value.
`page_size`	`int32` Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
`page_token`	`string` Optional. A token identifying a page of results the server should return.
`filter`	`string` Optional. Filtering results.
`order_by`	`string` Optional. Hint for how to order the results.

FetchUsableBackupVaultsResponse

Response message for fetching usable BackupVaults.

Fields

backup_vaults[]

BackupVault

The list of BackupVault instances in the project for the specified location.

If the '{location}' value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return backup vaults in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.

next_page_token

string

A token identifying a page of results the server should return.

unreachable[]

string

Locations that could not be reached.

FinalizeBackupRequest

Message for finalizing a Backup.

Fields
`data_source`	`string` Required. The resource name of the instance, in the format 'projects//locations//backupVaults/*/dataSources/'.
`request_id`	`string` Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
`backup_id`	`string` Required. Resource ID of the Backup resource to be finalized. This must be the same backup_id that was used in the InitiateBackupRequest.
`description`	`string` This will be assigned to the description field of the newly created Backup.
`consistency_time`	`Timestamp` The point in time when this backup was captured from the source. This will be assigned to the consistency_time field of the newly created Backup.
`recovery_range_start_time`	`Timestamp` The earliest timestamp of data available in this Backup. This will set on the newly created Backup.
`recovery_range_end_time`	`Timestamp` The latest timestamp of data available in this Backup. This will be set on the newly created Backup.
`retention_duration`	`Duration` The ExpireTime on the backup will be set to FinalizeTime plus this duration. If the resulting ExpireTime is less than EnforcedRetentionEndTime, then ExpireTime is set to EnforcedRetentionEndTime.

GcpBackupConfig

GcpBackupConfig captures the Backup configuration details for Google Cloud resources. All Google Cloud resources regardless of type are protected with backup plan associations.

Fields
`backup_plan`	`string` The name of the backup plan.
`backup_plan_description`	`string` The description of the backup plan.
`backup_plan_association`	`string` The name of the backup plan association.
`backup_plan_rules[]`	`string` The names of the backup plan rules which point to this backupvault
`backup_plan_revision_name`	`string` The name of the backup plan revision.
`backup_plan_revision_id`	`string` The user friendly id of the backup plan revision. E.g. v0, v1 etc.

GcpResource

Minimum details to identify a Google Cloud resource

Fields

gcp_resourcename

string

Name of the Google Cloud resource.

location

string

Location of the resource: / /"global"/"unspecified".

type

string

Type of the resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance.

GetBackupPlanAssociationRequest

Request message for getting a BackupPlanAssociation resource.

Fields

name

string

Required. Name of the backup plan association resource, in the format projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}

GetBackupPlanRequest

The request message for getting a BackupPlan .

Fields

name

string

Required. The resource name of the BackupPlan to retrieve.

Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}

GetBackupPlanRevisionRequest

The request message for getting a BackupPlanRevision .

Fields

name

string

Required. The resource name of the BackupPlanRevision to retrieve.

Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision}

GetBackupRequest

Request message for getting a Backup.

Fields

name

string

Required. Name of the data source resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{backupVault}/dataSources/{datasource}/backups/{backup}'

view

BackupView

Optional. Reserved for future use to provide a BASIC & FULL view of Backup resource.

GetBackupVaultRequest

Request message for getting a BackupVault.

Fields

name

string

Required. Name of the backupvault store resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}'

view

BackupVaultView

Optional. Reserved for future use to provide a BASIC & FULL view of Backup Vault

GetDataSourceReferenceRequest

Request for the GetDataSourceReference method.

Fields

name

string

Required. The name of the DataSourceReference to retrieve. Format: projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference}

GetDataSourceRequest

Request message for getting a DataSource instance.

Fields

name

string

Required. Name of the data source resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}/dataSource/{resource_name}'

GetManagementServerRequest

Request message for getting a management server instance.

Fields

name

string

Required. Name of the management server resource name, in the format 'projects/{project_id}/locations/{location}/managementServers/{resource_name}'

GetTrialRequest

Request message for getting a trial.

Fields

name

string

Required. The name of the trial to retrieve.

GuestOsFeature

Feature type of the Guest OS.

Fields

type

FeatureType

The ID of a supported feature.

FeatureType

List of the Feature Types.

Enums
`FEATURE_TYPE_UNSPECIFIED`	Default value, which is unused.
`VIRTIO_SCSI_MULTIQUEUE`	VIRTIO_SCSI_MULTIQUEUE feature type.
`WINDOWS`	WINDOWS feature type.
`MULTI_IP_SUBNET`	MULTI_IP_SUBNET feature type.
`UEFI_COMPATIBLE`	UEFI_COMPATIBLE feature type.
`SECURE_BOOT`	SECURE_BOOT feature type.
`GVNIC`	GVNIC feature type.
`SEV_CAPABLE`	SEV_CAPABLE feature type.
`BARE_METAL_LINUX_COMPATIBLE`	BARE_METAL_LINUX_COMPATIBLE feature type.
`SUSPEND_RESUME_COMPATIBLE`	SUSPEND_RESUME_COMPATIBLE feature type.
`SEV_LIVE_MIGRATABLE`	SEV_LIVE_MIGRATABLE feature type.
`SEV_SNP_CAPABLE`	SEV_SNP_CAPABLE feature type.
`TDX_CAPABLE`	TDX_CAPABLE feature type.
`IDPF`	IDPF feature type.
`SEV_LIVE_MIGRATABLE_V2`	SEV_LIVE_MIGRATABLE_V2 feature type.

InitializeServiceRequest

Request message for initializing the service.

Fields

name

string

Required. The resource name of the serviceConfig used to initialize the service. Format: projects/{project_id}/locations/{location}/serviceConfig .

resource_type

string

Required. The resource type to which the default service config will be applied. Examples include, "compute.googleapis.com/Instance" and "storage.googleapis.com/Bucket".

request_id

string

For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Union field initialization_config . The configuration for initializing the resource. initialization_config can be only one of the following:

cloud_sql_instance_initialization_config

CloudSqlInstanceInitializationConfig

Optional. The configuration for initializing a Cloud SQL instance.

InitializeServiceResponse

Response message for initializing the service.

Fields

backup_vault_name

string

The resource name of the default BackupVault created. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id} .

backup_plan_name

string

The resource name of the default BackupPlan created. Format: projects/{project_id}/locations/{location}/backupPlans/{backup_plan_id} .

InitiateBackupRequest

request message for InitiateBackup.

Fields

data_source

string

Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.

request_id

string

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

backup_id

string

Required. Resource ID of the Backup resource.

InitiateBackupResponse

Response message for InitiateBackup.

Fields

backup

string

The name of the backup that was created.

new_backup_generation_id

int32

The generation id of the new backup.

base_backup_generation_id

int32

The generation id of the base backup. It is needed for the incremental backups.

InstanceParams

Additional instance params.

Fields

resource_manager_tags

map<string, string>

Optional. Resource manager tags to be bound to the instance.

KeyRevocationActionType

Specifies whether the virtual machine instance will be shut down on key revocation. It is currently used in instance, instance properties and GMI protos

Enums
`KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED`	Default value. This value is unused.
`NONE`	Indicates user chose no operation.
`STOP`	Indicates user chose to opt for VM shutdown on key revocation.

ListBackupPlanAssociationsRequest

Request message for List BackupPlanAssociation

Fields
`parent`	`string` Required. The project and location for which to retrieve backup Plan Associations information, in the format `projects/{project_id}/locations/{location}` . In Cloud BackupDR, locations map to GCP regions, for example us-central1. To retrieve backup plan associations for all locations, use "-" for the `{location}` value.
`page_size`	`int32` Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
`page_token`	`string` Optional. A token identifying a page of results the server should return.
`filter`	`string` Optional. Filtering results

ListBackupPlanAssociationsResponse

Response message for List BackupPlanAssociation

Fields

backup_plan_associations[]

BackupPlanAssociation

The list of Backup Plan Associations in the project for the specified location.

If the {location} value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return backup plan associations in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.

next_page_token

string

A token identifying a page of results the server should return.

unreachable[]

string

Locations that could not be reached.

ListBackupPlanRevisionsRequest

The request message for getting a list of BackupPlanRevision .

Fields

parent

string

Required. The project and location for which to retrieve BackupPlanRevisions information. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan} . In Cloud BackupDR, locations map to GCP regions, for e.g. us-central1.

page_size

int32

Optional. The maximum number of BackupPlans to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.

page_token

string

Optional. The value of next_page_token received from a previous ListBackupPlans call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to ListBackupPlans must match the call that provided the page token.

ListBackupPlanRevisionsResponse

The response message for getting a list of BackupPlanRevision .

Fields

backup_plan_revisions[]

BackupPlanRevision

The list of BackupPlanRevisions in the project for the specified location.

If the {location} value in the request is "-", the response contains a list of resources from all locations. In case any location is unreachable, the response will only return backup plans in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.

next_page_token

string

A token which may be sent as page_token in a subsequent ListBackupPlanRevisions call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.

unreachable[]

string

Locations that could not be reached.

ListBackupPlansRequest

The request message for getting a list BackupPlan .

Fields
`parent`	`string` Required. The project and location for which to retrieve `BackupPlans` information. Format: `projects/{project}/locations/{location}` . In Cloud BackupDR, locations map to GCP regions, for e.g. us-central1. To retrieve backup plans for all locations, use "-" for the `{location}` value.
`page_size`	`int32` Optional. The maximum number of `BackupPlans` to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's `next_page_token` to determine if there are more instances left to be queried.
`page_token`	`string` Optional. The value of `next_page_token` received from a previous `ListBackupPlans` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupPlans` must match the call that provided the page token.
`filter`	`string` Optional. Field match expression used to filter the results.
`order_by`	`string` Optional. Field by which to sort the results.

ListBackupPlansResponse

The response message for getting a list of BackupPlan .

Fields

backup_plans[]

BackupPlan

The list of BackupPlans in the project for the specified location.

next_page_token

string

A token which may be sent as page_token in a subsequent ListBackupPlans call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.

unreachable[]

string

Locations that could not be reached.

ListBackupVaultsRequest

Request message for listing backupvault stores.

Fields
`parent`	`string` Required. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1. To retrieve backupvault stores for all locations, use "-" for the '{location}' value.
`page_size`	`int32` Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
`page_token`	`string` Optional. A token identifying a page of results the server should return.
`filter`	`string` Optional. Filtering results.
`order_by`	`string` Optional. Hint for how to order the results.
`view`	`BackupVaultView` Optional. Reserved for future use to provide a BASIC & FULL view of Backup Vault.

ListBackupVaultsResponse

Response message for listing BackupVaults.

Fields

backup_vaults[]

BackupVault

The list of BackupVault instances in the project for the specified location.

next_page_token

string

A token identifying a page of results the server should return.

unreachable[]

string

Locations that could not be reached.

ListBackupsRequest

Request message for listing Backups.

Fields
`parent`	`string` Required. The project and location for which to retrieve backup information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1. To retrieve data sources for all locations, use "-" for the '{location}' value.
`page_size`	`int32` Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
`page_token`	`string` Optional. A token identifying a page of results the server should return.
`filter`	`string` Optional. Filtering results.
`order_by`	`string` Optional. Hint for how to order the results.
`view`	`BackupView` Optional. Reserved for future use to provide a BASIC & FULL view of Backup resource.

ListBackupsResponse

Response message for listing Backups.

Fields

backups[]

Backup

The list of Backup instances in the project for the specified location.

If the '{location}' value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return data sources in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.

next_page_token

string

A token identifying a page of results the server should return.

unreachable[]

string

Locations that could not be reached.

ListDataSourcesRequest

Request message for listing DataSources.

Fields
`parent`	`string` Required. The project and location for which to retrieve data sources information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1. To retrieve data sources for all locations, use "-" for the '{location}' value.
`page_size`	`int32` Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
`page_token`	`string` Optional. A token identifying a page of results the server should return.
`filter`	`string` Optional. Filtering results.
`order_by`	`string` Optional. Hint for how to order the results.

ListDataSourcesResponse

Response message for listing DataSources.

Fields

data_sources[]

DataSource

The list of DataSource instances in the project for the specified location.

next_page_token

string

A token identifying a page of results the server should return.

unreachable[]

string

Locations that could not be reached.

ListManagementServersRequest

Request message for listing management servers.

Fields
`parent`	`string` Required. The project and location for which to retrieve management servers information, in the format 'projects/{project_id}/locations/{location}'. In Cloud BackupDR, locations map to Google Cloud regions, for example us-central1. To retrieve management servers for all locations, use "-" for the '{location}' value.
`page_size`	`int32` Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
`page_token`	`string` Optional. A token identifying a page of results the server should return.
`filter`	`string` Optional. Filtering results.
`order_by`	`string` Optional. Hint for how to order the results.

ListManagementServersResponse

Response message for listing management servers.

Fields

management_servers[]

ManagementServer

The list of ManagementServer instances in the project for the specified location.

If the '{location}' value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return management servers in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.

next_page_token

string

A token identifying a page of results the server should return.

unreachable[]

string

Locations that could not be reached.

ListResourceBackupConfigsRequest

Request for ListResourceBackupConfigs.

Fields
`parent`	`string` Required. The project and location for which to retrieve resource backup configs. Format: 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example us-central1.
`page_size`	`int32` Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will use 100 as default. Maximum value is 500 and values above 500 will be coerced to 500.
`page_token`	`string` Optional. A token identifying a page of results the server should return.
`filter`	`string` Optional. Filtering results.
`order_by`	`string` Optional. Hint for how to order the results.

ListResourceBackupConfigsResponse

Response for ListResourceBackupConfigs.

Fields

resource_backup_configs[]

ResourceBackupConfig

The list of ResourceBackupConfigs for the specified scope.

next_page_token

string

A token identifying a page of results the server should return.

ManagementServer

ManagementServer describes a single BackupDR ManagementServer instance.

Fields
`name`	`string` Output only. Identifier. The resource name.
`description`	`string` Optional. The description of the ManagementServer instance (2048 characters or less).
`labels`	`map<string, string>` Optional. Resource labels to represent user provided metadata. Labels currently defined: 1. migrate_from_go=<false\|true> If set to true, the MS is created in migration ready mode.
`create_time`	`Timestamp` Output only. The time when the instance was created.
`update_time`	`Timestamp` Output only. The time when the instance was updated.
`type`	`InstanceType` Optional. The type of the ManagementServer resource.
`management_uri`	`ManagementURI` Output only. The hostname or ip address of the exposed AGM endpoints, used by clients to connect to AGM/RD graphical user interface and APIs.
`workforce_identity_based_management_uri`	`WorkforceIdentityBasedManagementURI` Output only. The hostnames of the exposed AGM endpoints for both types of user i.e. 1p and 3p, used to connect AGM/RM UI.
`state`	`InstanceState` Output only. The ManagementServer state.
`networks[]`	`NetworkConfig` Optional. VPC networks to which the ManagementServer instance is connected. For this version, only a single network is supported. This field is optional if MS is created without PSA
`etag`	`string` Optional. Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.
`oauth2_client_id`	`string` Output only. The OAuth 2.0 client id is required to make API calls to the BackupDR instance API of this ManagementServer. This is the value that should be provided in the 'aud' field of the OIDC ID Token (see openid specification https://openid.net/specs/openid-connect-core-1_0.html#IDToken) .
`workforce_identity_based_oauth2_client_id`	`WorkforceIdentityBasedOAuth2ClientID` Output only. The OAuth client IDs for both types of user i.e. 1p and 3p.
`ba_proxy_uri[]`	`string` Output only. The hostname or ip address of the exposed AGM endpoints, used by BAs to connect to BA proxy.
`satisfies_pzs`	`BoolValue` Output only. Reserved for future use.
`satisfies_pzi`	`bool` Output only. Reserved for future use.

InstanceState

State of Management server instance.

Enums
`INSTANCE_STATE_UNSPECIFIED`	State not set.
`CREATING`	The instance is being created.
`READY`	The instance has been created and is fully usable.
`UPDATING`	The instance configuration is being updated. Certain kinds of updates may cause the instance to become unusable while the update is in progress.
`DELETING`	The instance is being deleted.
`REPAIRING`	The instance is being repaired and may be unstable.
`MAINTENANCE`	Maintenance is being performed on this instance.
`ERROR`	The instance is experiencing an issue and might be unusable. You can get further details from the statusMessage field of Instance resource.

InstanceType

Type of backup service resource.

Enums
`INSTANCE_TYPE_UNSPECIFIED`	Instance type is not mentioned.
`BACKUP_RESTORE`	Instance for backup and restore management (i.e., AGM).

ManagementURI

ManagementURI for the Management Server resource.

Fields

web_ui

string

Output only. The ManagementServer AGM/RD WebUI URL.

api

string

Output only. The ManagementServer AGM/RD API URL.

Metadata

A metadata key/value entry.

Fields

items[]

Entry

Optional. Array of key/value pairs. The total size of all keys and values must be less than 512 KB.

NetworkConfig

Network configuration for ManagementServer instance.

Fields

network

string

Optional. The resource name of the Google Compute Engine VPC network to which the ManagementServer instance is connected.

peering_mode

PeeringMode

Optional. The network connect mode of the ManagementServer instance. For this version, only PRIVATE_SERVICE_ACCESS is supported.

PeeringMode

VPC peering modes supported by Cloud BackupDR.

Enums
`PEERING_MODE_UNSPECIFIED`	Peering mode not set.
`PRIVATE_SERVICE_ACCESS`	Connect using Private Service Access to the Management Server. Private services access provides an IP address range for multiple Google Cloud services, including Cloud BackupDR.

NetworkInterface

A network interface resource attached to an instance. s

Fields
`access_configs[]`	`AccessConfig` Optional. An array of configurations for this interface. Currently, only one access config,ONE_TO_ONE_NAT is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
`ipv6_access_configs[]`	`AccessConfig` Optional. An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.
`alias_ip_ranges[]`	`AliasIpRange` Optional. An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.
`network`	`string` Optional. URL of the VPC network resource for this instance.
`subnetwork`	`string` Optional. The URL of the Subnetwork resource for this instance.
`ip_address`	`string` Optional. An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
`ipv6_address`	`string` Optional. An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork.
`internal_ipv6_prefix_length`	`int32` Optional. The prefix length of the primary internal IPv6 range.
`name`	`string` Output only. [Output Only] The name of the network interface, which is generated by the server.
`stack_type`	`StackType` The stack type for this network interface.
`ipv6_access_type`	`Ipv6AccessType` Optional. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.
`queue_count`	`int32` Optional. The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.
`nic_type`	`NicType` Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
`network_attachment`	`string` Optional. The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.

Ipv6AccessType

IPv6 access type for this network interface.

Enums
`UNSPECIFIED_IPV6_ACCESS_TYPE`	IPv6 access type not set. Means this network interface hasn't been turned on IPv6 yet.
`INTERNAL`	This network interface can have internal IPv6.
`EXTERNAL`	This network interface can have external IPv6.

NicType

Nic type for this network interface.

Enums
`NIC_TYPE_UNSPECIFIED`	Default should be NIC_TYPE_UNSPECIFIED.
`VIRTIO_NET`	VIRTIO
`GVNIC`	GVNIC

StackType

Stack type for this network interface.

Enums
`STACK_TYPE_UNSPECIFIED`	Default should be STACK_TYPE_UNSPECIFIED.
`IPV4_ONLY`	The network interface will be assigned IPv4 address.
`IPV4_IPV6`	The network interface can have both IPv4 and IPv6 addresses.

NetworkPerformanceConfig

Network performance configuration.

Fields

total_egress_bandwidth_tier

Tier

Optional. The tier of the total egress bandwidth.

Tier

Network performance tier.

Enums
`TIER_UNSPECIFIED`	This value is unused.
`DEFAULT`	Default network performance config.
`TIER_1`	Tier 1 network performance config.

OperationMetadata

Represents the metadata of the long-running operation.

Fields
`create_time`	`Timestamp` Output only. The time the operation was created.
`end_time`	`Timestamp` Output only. The time the operation finished running.
`target`	`string` Output only. Server-defined resource path for the target of the operation.
`verb`	`string` Output only. Name of the verb executed by the operation.
`status_message`	`string` Output only. Human-readable status of the operation, if any.
`requested_cancellation`	`bool` Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have `google.longrunning.Operation.error` value with a `google.rpc.Status.code` of 1, corresponding to 'Code.CANCELLED'.
`api_version`	`string` Output only. API version used to start the operation.
`additional_info`	`map<string, string>` Output only. AdditionalInfo contains additional Info related to backup plan association resource.

PitrSettings

Point in time recovery settings of the backup configuration resource.

Fields

retention_days

int32

Output only. Number of days to retain the backup.

RegionDiskTargetEnvironment

RegionDiskTargetEnvironment represents the target environment for the disk.

Fields

project

string

Required. Target project for the disk.

region

string

Required. Target region for the disk.

replica_zones[]

string

Required. Target URLs of the replica zones for the disk.

RemoveDataSourceRequest

Message for deleting a DataSource.

Fields

name

string

Required. Name of the resource.

request_id

string

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

ResourceBackupConfig

ResourceBackupConfig represents a resource along with its backup configurations.

Fields
`name`	`string` Identifier. The resource name of the ResourceBackupConfig. Format: projects/{project}/locations/{location}/resourceBackupConfigs/{uid}
`uid`	`string` Output only. The unique identifier of the resource backup config.
`target_resource`	`string` Output only. The full resource name of the cloud resource that this configuration applies to. Supported resource types are `ResourceBackupConfig.ResourceType` .
`target_resource_display_name`	`string` Output only. The human friendly name of the target resource.
`target_resource_type`	`ResourceType` Output only. The type of the target resource.
`target_resource_labels`	`map<string, string>` Labels associated with the target resource.
`backup_configs_details[]`	`BackupConfigDetails` Backup configurations applying to the target resource, including those targeting its related/child resources. For example, backup configuration applicable to Compute Engine disks will be populated in this field for a Compute Engine VM which has the disk associated.
`backup_configured`	`bool` Output only. Whether the target resource is configured for backup. This is true if the backup_configs_details is not empty.
`vaulted`	`bool` Output only. Whether the target resource is protected by a backup vault. This is true if the backup_configs_details is not empty and any of the `ResourceBackupConfig.backup_configs_details` has a backup configuration with `BackupConfigDetails.backup_vault` set. set.

ResourceType

The type of the cloud resource.

Enums
`RESOURCE_TYPE_UNSPECIFIED`	Resource type not set.
`CLOUD_SQL_INSTANCE`	Cloud SQL instance.
`COMPUTE_ENGINE_VM`	Compute Engine VM.
`COMPUTE_ENGINE_DISK`	Compute Engine Disk.
`COMPUTE_ENGINE_REGIONAL_DISK`	Compute Engine Regional Disk.

RestoreBackupRequest

Request message for restoring from a Backup.

Fields

name

string

Required. The resource name of the Backup instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/*/backups/'.

request_id

string

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Union field target_environment . The target environment for the restore operation. target_environment can be only one of the following:

compute_instance_target_environment

ComputeInstanceTargetEnvironment

Compute Engine target environment to be used during restore.

disk_target_environment

DiskTargetEnvironment

Disk target environment to be used during restore.

region_disk_target_environment

RegionDiskTargetEnvironment

Region disk target environment to be used during restore.

Union field instance_properties . The property overrides for the instance being restored. instance_properties can be only one of the following:

compute_instance_restore_properties

ComputeInstanceRestoreProperties

Compute Engine instance properties to be overridden during restore.

disk_restore_properties

DiskRestoreProperties

Disk properties to be overridden during restore.

RestoreBackupResponse

Response message for restoring from a Backup.

Fields

target_resource

TargetResource

Details of the target resource created/modified as part of restore.

RuleConfigInfo

Message for rules config info.

Fields
`rule_id`	`string` Output only. Backup Rule id fetched from backup plan.
`last_backup_state`	`LastBackupState` Output only. The last backup state for rule.
`last_backup_error`	`Status` Output only. google.rpc.Status object to store the last backup error.
`last_successful_backup_consistency_time`	`Timestamp` Output only. The point in time when the last successful backup was captured from the source.

LastBackupState

Enum for LastBackupState

Enums
`LAST_BACKUP_STATE_UNSPECIFIED`	State not set.
`FIRST_BACKUP_PENDING`	The first backup is pending.
`PERMISSION_DENIED`	The most recent backup could not be run/failed because of the lack of permissions.
`SUCCEEDED`	The last backup operation succeeded.
`FAILED`	The last backup operation failed.

Scheduling

Sets the scheduling options for an Instance.

Fields
`node_affinities[]`	`NodeAffinity` Optional. A set of node affinity and anti-affinity configurations. Overrides reservationAffinity.
`on_host_maintenance`	`OnHostMaintenance` Optional. Defines the maintenance behavior for this instance.
`automatic_restart`	`bool` Optional. Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user).
`preemptible`	`bool` Optional. Defines whether the instance is preemptible.
`min_node_cpus`	`int32` Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
`provisioning_model`	`ProvisioningModel` Optional. Specifies the provisioning model of the instance.
`instance_termination_action`	`InstanceTerminationAction` Optional. Specifies the termination action for the instance.
`local_ssd_recovery_timeout`	`SchedulingDuration` Optional. Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour.

InstanceTerminationAction

Defines the supported termination actions for an instance.

Enums
`INSTANCE_TERMINATION_ACTION_UNSPECIFIED`	Default value. This value is unused.
`DELETE`	Delete the VM.
`STOP`	Stop the VM without storing in-memory content. default action.

NodeAffinity

Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.

Fields

values[]

string

Optional. Corresponds to the label values of Node resource.

key

string

Optional. Corresponds to the label key of Node resource.

operator

Operator

Optional. Defines the operation of node selection.

Operator

Defines the type of node selections.

Enums
`OPERATOR_UNSPECIFIED`	Default value. This value is unused.
`IN`	Requires Compute Engine to seek for matched nodes.
`NOT_IN`	Requires Compute Engine to avoid certain nodes.

OnHostMaintenance

Defines the maintenance behavior for this instance=

Enums
`ON_HOST_MAINTENANCE_UNSPECIFIED`	Default value. This value is unused.
`TERMINATE`	Tells Compute Engine to terminate and (optionally) restart the instance away from the maintenance activity.
`MIGRATE`	Default, Allows Compute Engine to automatically migrate instances out of the way of maintenance events.

ProvisioningModel

Defines the provisioning model for an instance.

Enums
`PROVISIONING_MODEL_UNSPECIFIED`	Default value. This value is not used.
`STANDARD`	Standard provisioning with user controlled runtime, no discounts.
`SPOT`	Heavily discounted, no guaranteed runtime.

SchedulingDuration

A SchedulingDuration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years.

Fields

seconds

int64

Optional. Span of time at a resolution of a second.

nanos

int32

Optional. Span of time that's a fraction of a second at nanosecond resolution.

ServiceAccount

A service account.

Fields

scopes[]

string

Optional. The list of scopes to be made available for this service account.

email

string

Optional. Email address of the service account.

ServiceLockInfo

ServiceLockInfo represents the details of a lock taken by the service on a Backup resource.

Fields

operation

string

Output only. The name of the operation that created this lock. The lock will automatically be released when the operation completes.

SetInternalStatusRequest

Request message for SetStatusInternal method.

Fields
`data_source`	`string` Required. The resource name of the instance, in the format 'projects//locations//backupVaults/*/dataSources/'.
`value`	`bytes` Required. The value required for this method to work. This field must be the 32-byte SHA256 hash of the DataSourceID. The DataSourceID used here is only the final piece of the fully qualified resource path for this DataSource (i.e. the part after '.../dataSources/'). This field exists to make this method difficult to call since it is intended for use only by Backup Appliances.
`backup_config_state`	`BackupConfigState` Required. Output only. The new BackupConfigState to set for the DataSource.
`request_id`	`string` Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

SetInternalStatusResponse

This type has no fields.

Response message from SetStatusInternal method.

StandardSchedule

StandardSchedule defines a schedule that run within the confines of a defined window of days. We can define recurrence type for schedule as HOURLY, DAILY, WEEKLY, MONTHLY or YEARLY.

Fields
`recurrence_type`	`RecurrenceType` Required. Specifies the `RecurrenceType` for the schedule.
`hourly_frequency`	`int32` Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for `recurrence_type` , `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY` . Value of hourly frequency should be between 4 and 23. Reason for limit : We found that there is bandwidth limitation of 3GB/S for GMI while taking a backup and 5GB/S while doing a restore. Given the amount of parallel backups and restore we are targeting, this will potentially take the backup time to mins and hours (in worst case scenario).
`days_of_week[]`	`DayOfWeek` Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for `recurrence_type` , `WEEKLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `WEEKLY` .
`days_of_month[]`	`int32` Optional. Specifies days of months like 1, 5, or 14 on which jobs will run. Values for `days_of_month` are only applicable for `recurrence_type` , `MONTHLY` and `YEARLY` . A validation error will occur if other values are supplied.
`week_day_of_month`	`WeekDayOfMonth` Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST MONDAY, on which jobs will run. This will be specified by two fields in `WeekDayOfMonth` , one for the day, e.g. `MONDAY` , and one for the week, e.g. `LAST` . This field is only applicable for `recurrence_type` , `MONTHLY` and `YEARLY` . A validation error will occur if other values are supplied.
`months[]`	`Month` Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY` , on which jobs will run. This field is only applicable when `recurrence_type` is `YEARLY` . A validation error will occur if other values are supplied.
`backup_window`	`BackupWindow` Required. A BackupWindow defines the window of day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as `NOT_RUN` if they do not start by the end of the window. Note: running jobs will not be cancelled at the end of the window.
`time_zone`	`string` Required. The time zone to be used when interpreting the schedule. The value of this field must be a time zone name from the IANA tz database. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the list of valid timezone names. For e.g., Europe/Paris.

RecurrenceType

RecurrenceTypes enumerates the applicable periodicity for the schedule.

Enums
`RECURRENCE_TYPE_UNSPECIFIED`	recurrence type not set
`HOURLY`	The `BackupRule` is to be applied hourly.
`DAILY`	The `BackupRule` is to be applied daily.
`WEEKLY`	The `BackupRule` is to be applied weekly.
`MONTHLY`	The `BackupRule` is to be applied monthly.
`YEARLY`	The `BackupRule` is to be applied yearly.

SubscribeTrialRequest

Request message for subscribing to a trial.

Fields

parent

string

Required. The parent resource where this trial will be created.

TargetResource

Details of the target resource created/modified as part of restore.

Fields

Union field target_resource_info . Minimum details to identify the restored resource. target_resource_info can be only one of the following:

gcp_resource

GcpResource

Details of the native Google Cloud resource created as part of restore.

Trial

Represents a Trial for a project.

Fields
`name`	`string` Identifier. The resource name of the trial. Format: projects/{project}/locations/{location}/trial
`state`	`State` Output only. The state of the trial.
`start_time`	`Timestamp` Output only. The time when the trial was subscribed.
`end_time`	`Timestamp` Output only. The time when the trial will expire.

State

Trial state enum.

Enums
`STATE_UNSPECIFIED`	State not set.
`SUBSCRIBED`	Trial is subscribed.
`UNSUBSCRIBED`	Trial is unsubscribed before expiration.
`EXPIRED`	Trial is expired post 30 days of subscription.
`ELIGIBLE`	Trial is eligible for enablement.
`NOT_ELIGIBLE`	Trial is not eligible for enablement.

TriggerBackupRequest

Request message for triggering a backup.

Fields

name

string

Required. Name of the backup plan association resource, in the format projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}

rule_id

string

Optional. backup rule_id for which a backup needs to be triggered. If not specified, on-demand backup with custom retention will be triggered.

request_id

string

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

UpdateBackupPlanAssociationRequest

Request message for updating a backup plan association.

Fields

backup_plan_association

BackupPlanAssociation

Required. The resource being updated

update_mask

FieldMask

Required. The list of fields to update. Field mask is used to specify the fields to be overwritten in the BackupPlanAssociation resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail. Currently backup_plan_association.backup_plan is the only supported field.

request_id

string

For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

UpdateBackupPlanRequest

Request message for updating a backup plan.

Fields

backup_plan

BackupPlan

Required. The resource being updated

update_mask

FieldMask

Required. The list of fields to update. Field mask is used to specify the fields to be overwritten in the BackupPlan resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail. Currently, these fields are supported in update: description, schedules, retention period, adding and removing Backup Rules.

request_id

string

For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

UpdateBackupRequest

Request message for updating a Backup.

Fields

update_mask

FieldMask

Required. Field mask is used to specify the fields to be overwritten in the Backup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail.

backup

Backup

Required. The resource being updated

request_id

string

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

UpdateBackupVaultRequest

Request message for updating a BackupVault.

Fields
`update_mask`	`FieldMask` Required. Field mask is used to specify the fields to be overwritten in the BackupVault resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail.
`backup_vault`	`BackupVault` Required. The resource being updated
`request_id`	`string` Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
`validate_only`	`bool` Optional. Only validate the request, but do not perform mutations. The default is 'false'.
`force`	`bool` Optional. If set to true, will not check plan duration against backup vault enforcement duration.
`force_update_access_restriction`	`bool` Optional. If set to true, we will force update access restriction even if some non compliant data sources are present. The default is 'false'.

UpdateDataSourceRequest

Request message for updating a data source instance.

Fields
`update_mask`	`FieldMask` Required. Field mask is used to specify the fields to be overwritten in the DataSource resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail.
`data_source`	`DataSource` Required. The resource being updated
`request_id`	`string` Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
`allow_missing`	`bool` Optional. Enable upsert.

WeekDayOfMonth

WeekDayOfMonth defines the week day of the month on which the backups will run. The message combines a WeekOfMonth and DayOfWeek to produce values like FIRST / MONDAY or LAST / FRIDAY .

Fields

week_of_month

WeekOfMonth

Required. Specifies the week of the month.

day_of_week

DayOfWeek

Required. Specifies the day of the week.

WeekOfMonth

WeekOfMonth enumerates possible weeks in the month, e.g. the first, third, or last week of the month.

Enums
`WEEK_OF_MONTH_UNSPECIFIED`	The zero value. Do not use.
`FIRST`	The first week of the month.
`SECOND`	The second week of the month.
`THIRD`	The third week of the month.
`FOURTH`	The fourth week of the month.
`LAST`	The last week of the month.

WorkforceIdentityBasedManagementURI

ManagementURI depending on the Workforce Identity i.e. either 1p or 3p.

Fields

first_party_management_uri

string

Output only. First party Management URI for Google Identities.

third_party_management_uri

string

Output only. Third party Management URI for External Identity Providers.

WorkforceIdentityBasedOAuth2ClientID

OAuth Client ID depending on the Workforce Identity i.e. either 1p or 3p,

Fields

first_party_oauth2_client_id

string

Output only. First party OAuth Client ID for Google Identities.

third_party_oauth2_client_id

string

Output only. Third party OAuth Client ID for External Identity Providers.

Package google.cloud.backupdr.v1 Stay organized with collections Save and categorize content based on your preferences.

Index

BackupDR

BackupDrProtectionSummary

AbandonBackupRequest

AcceleratorConfig

AccessConfig

AccessType

NetworkTier

AdvancedMachineFeatures

AliasIpRange

AllocationAffinity

Type

AttachedDisk

DiskInterface

DiskMode

DiskSavedState

DiskType

InitializeParams

Backup

BackupType

GCPBackupPlanInfo

State

BackupApplianceBackupConfig

BackupApplianceBackupProperties

BackupApplianceLockInfo

BackupConfigDetails

State

Type

BackupConfigInfo

LastBackupState

BackupConfigState

BackupDrPlanConfig

BackupDrPlanRule

BackupDrTemplateConfig

BackupLocation

Type

BackupLock

BackupPlan

State

BackupPlanAssociation

State

BackupPlanRevision

State

BackupRule

BackupVault

AccessRestriction

State

BackupVaultView

BackupView

BackupWindow

CloudSqlInstanceBackupPlanAssociationProperties

CloudSqlInstanceBackupProperties

CloudSqlInstanceDataSourceProperties

CloudSqlInstanceDataSourceReferenceProperties

CloudSqlInstanceInitializationConfig

Edition

ComputeInstanceBackupProperties

ComputeInstanceDataSourceProperties

ComputeInstanceRestoreProperties

InstancePrivateIpv6GoogleAccess

ComputeInstanceTargetEnvironment

ConfidentialInstanceConfig

CreateBackupPlanAssociationRequest

CreateBackupPlanRequest

CreateBackupVaultRequest

CreateManagementServerRequest

CustomerEncryptionKey

DataSource

State

DataSourceBackupApplianceApplication

DataSourceBackupConfigInfo

DataSourceGcpResource

DataSourceGcpResourceInfo

DataSourceReference

DeleteBackupPlanAssociationRequest

DeleteBackupPlanRequest

DeleteBackupRequest

DeleteBackupVaultRequest

DeleteManagementServerRequest

Package google.cloud.backupdr.v1