From 4c3708d744c4bc927898c71dde476a142e68583e Mon Sep 17 00:00:00 2001
From: Yoshi Automation Method Details
{ # A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc
"backupPlan": "A String", # Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
"createTime": "A String", # Output only. The time when the instance was created.
- "dataSource": "A String", # Output only. 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}
+ "dataSource": "A 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}
"name": "A String", # Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}
"resource": "A String", # Required. Immutable. Resource name of workload on which backupplan is applied
- "resourceType": "A String", # Optional. Required. Resource type of workload on which backupplan is applied
+ "resourceType": "A String", # Required. Immutable. Resource type of workload on which backupplan is applied
"rulesConfigInfo": [ # Output only. The config info related to backup rules.
{ # Message for rules config info.
- "lastBackupError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Output Only. google.rpc.Status object to store the last backup error.
+ "lastBackupError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. google.rpc.Status object to store the last backup error.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
@@ -130,7 +130,7 @@ Method Details
},
"lastBackupState": "A String", # Output only. The last backup state for rule.
"lastSuccessfulBackupConsistencyTime": "A String", # Output only. The point in time when the last successful backup was captured from the source.
- "ruleId": "A String", # Output only. Output Only. Backup Rule id fetched from backup plan.
+ "ruleId": "A String", # Output only. Backup Rule id fetched from backup plan.
},
],
"state": "A String", # Output only. The BackupPlanAssociation resource state.
@@ -221,13 +221,13 @@ Method Details
{ # A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc
"backupPlan": "A String", # Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
"createTime": "A String", # Output only. The time when the instance was created.
- "dataSource": "A String", # Output only. 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}
+ "dataSource": "A 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}
"name": "A String", # Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}
"resource": "A String", # Required. Immutable. Resource name of workload on which backupplan is applied
- "resourceType": "A String", # Optional. Required. Resource type of workload on which backupplan is applied
+ "resourceType": "A String", # Required. Immutable. Resource type of workload on which backupplan is applied
"rulesConfigInfo": [ # Output only. The config info related to backup rules.
{ # Message for rules config info.
- "lastBackupError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Output Only. google.rpc.Status object to store the last backup error.
+ "lastBackupError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. google.rpc.Status object to store the last backup error.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
@@ -238,7 +238,7 @@ Method Details
},
"lastBackupState": "A String", # Output only. The last backup state for rule.
"lastSuccessfulBackupConsistencyTime": "A String", # Output only. The point in time when the last successful backup was captured from the source.
- "ruleId": "A String", # Output only. Output Only. Backup Rule id fetched from backup plan.
+ "ruleId": "A String", # Output only. Backup Rule id fetched from backup plan.
},
],
"state": "A String", # Output only. The BackupPlanAssociation resource state.
@@ -268,13 +268,13 @@ Method Details
{ # A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc
"backupPlan": "A String", # Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}
"createTime": "A String", # Output only. The time when the instance was created.
- "dataSource": "A String", # Output only. 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}
+ "dataSource": "A 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}
"name": "A String", # Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}
"resource": "A String", # Required. Immutable. Resource name of workload on which backupplan is applied
- "resourceType": "A String", # Optional. Required. Resource type of workload on which backupplan is applied
+ "resourceType": "A String", # Required. Immutable. Resource type of workload on which backupplan is applied
"rulesConfigInfo": [ # Output only. The config info related to backup rules.
{ # Message for rules config info.
- "lastBackupError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Output Only. google.rpc.Status object to store the last backup error.
+ "lastBackupError": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. google.rpc.Status object to store the last backup error.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
@@ -285,7 +285,7 @@ Method Details
},
"lastBackupState": "A String", # Output only. The last backup state for rule.
"lastSuccessfulBackupConsistencyTime": "A String", # Output only. The point in time when the last successful backup was captured from the source.
- "ruleId": "A String", # Output only. Output Only. Backup Rule id fetched from backup plan.
+ "ruleId": "A String", # Output only. Backup Rule id fetched from backup plan.
},
],
"state": "A String", # Output only. The BackupPlanAssociation resource state.
diff --git a/docs/dyn/backupdr_v1.projects.locations.backupPlans.html b/docs/dyn/backupdr_v1.projects.locations.backupPlans.html
index 3fd7332f20d..ea20466b674 100644
--- a/docs/dyn/backupdr_v1.projects.locations.backupPlans.html
+++ b/docs/dyn/backupdr_v1.projects.locations.backupPlans.html
@@ -110,7 +110,7 @@ Method Details
{ # 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.
"backupRules": [ # Required. The backup rules for this `BackupPlan`. There must be at least one `BackupRule` message.
{ # `BackupRule` binds the backup schedule to a retention policy.
- "backupRetentionDays": 42, # 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 90 for hourly backups. Minimum value is 1 and maximum value is 90 for daily backups. Minimum value is 7 and maximum value is 186 for weekly backups. Minimum value is 30 and maximum value is 732 for monthly backups. Minimum value is 30 and maximum value is 36159 for yearly backups.
+ "backupRetentionDays": 42, # 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 90 for hourly backups. Minimum value is 1 and maximum value is 90 for daily backups. Minimum value is 7 and maximum value is 186 for weekly backups. Minimum value is 30 and maximum value is 732 for monthly backups. Minimum value is 365 and maximum value is 36159 for yearly backups.
"ruleId": "A 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{,62}/.
"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. # Required. Defines a schedule that runs within the confines of a defined window of time.
"backupWindow": { # `BackupWindow` defines a window of the day during which backup jobs will run. # 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.
@@ -145,7 +145,7 @@ Method Details
"a_key": "A String",
},
"name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
- "resourceType": "A String", # Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance" and "storage.googleapis.com/Bucket".
+ "resourceType": "A String", # Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance", or "alloydb.googleapis.com/Cluster".
"state": "A String", # Output only. The `State` for the `BackupPlan`.
"updateTime": "A String", # Output only. When the `BackupPlan` was last updated.
}
@@ -234,7 +234,7 @@ Method Details
{ # 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.
"backupRules": [ # Required. The backup rules for this `BackupPlan`. There must be at least one `BackupRule` message.
{ # `BackupRule` binds the backup schedule to a retention policy.
- "backupRetentionDays": 42, # 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 90 for hourly backups. Minimum value is 1 and maximum value is 90 for daily backups. Minimum value is 7 and maximum value is 186 for weekly backups. Minimum value is 30 and maximum value is 732 for monthly backups. Minimum value is 30 and maximum value is 36159 for yearly backups.
+ "backupRetentionDays": 42, # 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 90 for hourly backups. Minimum value is 1 and maximum value is 90 for daily backups. Minimum value is 7 and maximum value is 186 for weekly backups. Minimum value is 30 and maximum value is 732 for monthly backups. Minimum value is 365 and maximum value is 36159 for yearly backups.
"ruleId": "A 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{,62}/.
"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. # Required. Defines a schedule that runs within the confines of a defined window of time.
"backupWindow": { # `BackupWindow` defines a window of the day during which backup jobs will run. # 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.
@@ -269,7 +269,7 @@ Method Details
"a_key": "A String",
},
"name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
- "resourceType": "A String", # Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance" and "storage.googleapis.com/Bucket".
+ "resourceType": "A String", # Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance", or "alloydb.googleapis.com/Cluster".
"state": "A String", # Output only. The `State` for the `BackupPlan`.
"updateTime": "A String", # Output only. When the `BackupPlan` was last updated.
}
@@ -298,7 +298,7 @@ Method Details
{ # 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.
"backupRules": [ # Required. The backup rules for this `BackupPlan`. There must be at least one `BackupRule` message.
{ # `BackupRule` binds the backup schedule to a retention policy.
- "backupRetentionDays": 42, # 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 90 for hourly backups. Minimum value is 1 and maximum value is 90 for daily backups. Minimum value is 7 and maximum value is 186 for weekly backups. Minimum value is 30 and maximum value is 732 for monthly backups. Minimum value is 30 and maximum value is 36159 for yearly backups.
+ "backupRetentionDays": 42, # 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 90 for hourly backups. Minimum value is 1 and maximum value is 90 for daily backups. Minimum value is 7 and maximum value is 186 for weekly backups. Minimum value is 30 and maximum value is 732 for monthly backups. Minimum value is 365 and maximum value is 36159 for yearly backups.
"ruleId": "A 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{,62}/.
"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. # Required. Defines a schedule that runs within the confines of a defined window of time.
"backupWindow": { # `BackupWindow` defines a window of the day during which backup jobs will run. # 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.
@@ -333,7 +333,7 @@ Method Details
"a_key": "A String",
},
"name": "A String", # Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
- "resourceType": "A String", # Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance" and "storage.googleapis.com/Bucket".
+ "resourceType": "A String", # Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance", "sqladmin.googleapis.com/Instance", or "alloydb.googleapis.com/Cluster".
"state": "A String", # Output only. The `State` for the `BackupPlan`.
"updateTime": "A String", # Output only. When the `BackupPlan` was last updated.
},
diff --git a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html
index 9b0b88388e1..f82c0107aeb 100644
--- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html
+++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html
@@ -336,6 +336,8 @@ Method Details
},
"name": "A String", # Output only. Identifier. Name of the backup to create. It must have the format`"projects//locations//backupVaults//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.
"resourceSizeBytes": "A String", # Output only. source resource size in bytes at the time of the backup.
+ "satisfiesPzi": True or False, # Optional. Output only. Reserved for future use.
+ "satisfiesPzs": True or False, # Optional. Output only. Reserved for future use.
"serviceLocks": [ # Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup.
{ # BackupLock represents a single lock on a Backup resource. An unexpired lock on a Backup prevents the Backup from being deleted.
"backupApplianceLockInfo": { # BackupApplianceLockInfo contains metadata about the backupappliance that created the lock. # If the client is a backup and recovery appliance, this contains metadata about why the lock exists.
@@ -562,6 +564,8 @@ Method Details
},
"name": "A String", # Output only. Identifier. Name of the backup to create. It must have the format`"projects//locations//backupVaults//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.
"resourceSizeBytes": "A String", # Output only. source resource size in bytes at the time of the backup.
+ "satisfiesPzi": True or False, # Optional. Output only. Reserved for future use.
+ "satisfiesPzs": True or False, # Optional. Output only. Reserved for future use.
"serviceLocks": [ # Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup.
{ # BackupLock represents a single lock on a Backup resource. An unexpired lock on a Backup prevents the Backup from being deleted.
"backupApplianceLockInfo": { # BackupApplianceLockInfo contains metadata about the backupappliance that created the lock. # If the client is a backup and recovery appliance, this contains metadata about why the lock exists.
@@ -792,6 +796,8 @@ Method Details
},
"name": "A String", # Output only. Identifier. Name of the backup to create. It must have the format`"projects//locations//backupVaults//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.
"resourceSizeBytes": "A String", # Output only. source resource size in bytes at the time of the backup.
+ "satisfiesPzi": True or False, # Optional. Output only. Reserved for future use.
+ "satisfiesPzs": True or False, # Optional. Output only. Reserved for future use.
"serviceLocks": [ # Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup.
{ # BackupLock represents a single lock on a Backup resource. An unexpired lock on a Backup prevents the Backup from being deleted.
"backupApplianceLockInfo": { # BackupApplianceLockInfo contains metadata about the backupappliance that created the lock. # If the client is a backup and recovery appliance, this contains metadata about why the lock exists.
diff --git a/docs/dyn/backupdr_v1.projects.locations.backupVaults.html b/docs/dyn/backupdr_v1.projects.locations.backupVaults.html
index 96ff5a60ca8..1f3b168e148 100644
--- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.html
+++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.html
@@ -125,7 +125,7 @@ Method Details
The object takes the form of:
{ # Message describing a BackupVault object.
- "accessRestriction": "A String", # Optional. Note: This field is added for future use case and will not be supported in the current release. Optional. Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation.
+ "accessRestriction": "A String", # 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.
"annotations": { # Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.
"a_key": "A String",
},
@@ -143,7 +143,7 @@ Method Details
"serviceAccount": "A 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.
"state": "A String", # Output only. The BackupVault resource instance state.
"totalStoredBytes": "A String", # Output only. Total size of the storage used by all backup resources.
- "uid": "A String", # Output only. Output only Immutable after resource creation until resource deletion.
+ "uid": "A String", # Output only. Immutable after resource creation until resource deletion.
"updateTime": "A String", # Output only. The time when the instance was updated.
}
@@ -241,7 +241,7 @@ Method Details
{ # Response message for fetching usable BackupVaults.
"backupVaults": [ # 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.
{ # Message describing a BackupVault object.
- "accessRestriction": "A String", # Optional. Note: This field is added for future use case and will not be supported in the current release. Optional. Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation.
+ "accessRestriction": "A String", # 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.
"annotations": { # Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.
"a_key": "A String",
},
@@ -259,7 +259,7 @@ Method Details
"serviceAccount": "A 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.
"state": "A String", # Output only. The BackupVault resource instance state.
"totalStoredBytes": "A String", # Output only. Total size of the storage used by all backup resources.
- "uid": "A String", # Output only. Output only Immutable after resource creation until resource deletion.
+ "uid": "A String", # Output only. Immutable after resource creation until resource deletion.
"updateTime": "A String", # Output only. The time when the instance was updated.
},
],
@@ -304,7 +304,7 @@ Method Details
An object of the form:
{ # Message describing a BackupVault object.
- "accessRestriction": "A String", # Optional. Note: This field is added for future use case and will not be supported in the current release. Optional. Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation.
+ "accessRestriction": "A String", # 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.
"annotations": { # Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.
"a_key": "A String",
},
@@ -322,7 +322,7 @@ Method Details
"serviceAccount": "A 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.
"state": "A String", # Output only. The BackupVault resource instance state.
"totalStoredBytes": "A String", # Output only. Total size of the storage used by all backup resources.
- "uid": "A String", # Output only. Output only Immutable after resource creation until resource deletion.
+ "uid": "A String", # Output only. Immutable after resource creation until resource deletion.
"updateTime": "A String", # Output only. The time when the instance was updated.
}
@@ -353,7 +353,7 @@ Method Details
{ # Response message for listing BackupVaults.
"backupVaults": [ # 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.
{ # Message describing a BackupVault object.
- "accessRestriction": "A String", # Optional. Note: This field is added for future use case and will not be supported in the current release. Optional. Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation.
+ "accessRestriction": "A String", # 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.
"annotations": { # Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.
"a_key": "A String",
},
@@ -371,7 +371,7 @@ Method Details
"serviceAccount": "A 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.
"state": "A String", # Output only. The BackupVault resource instance state.
"totalStoredBytes": "A String", # Output only. Total size of the storage used by all backup resources.
- "uid": "A String", # Output only. Output only Immutable after resource creation until resource deletion.
+ "uid": "A String", # Output only. Immutable after resource creation until resource deletion.
"updateTime": "A String", # Output only. The time when the instance was updated.
},
],
@@ -406,7 +406,7 @@ Method Details
The object takes the form of:
{ # Message describing a BackupVault object.
- "accessRestriction": "A String", # Optional. Note: This field is added for future use case and will not be supported in the current release. Optional. Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation.
+ "accessRestriction": "A String", # 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.
"annotations": { # Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.
"a_key": "A String",
},
@@ -424,7 +424,7 @@ Method Details
"serviceAccount": "A 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.
"state": "A String", # Output only. The BackupVault resource instance state.
"totalStoredBytes": "A String", # Output only. Total size of the storage used by all backup resources.
- "uid": "A String", # Output only. Output only Immutable after resource creation until resource deletion.
+ "uid": "A String", # Output only. Immutable after resource creation until resource deletion.
"updateTime": "A String", # Output only. The time when the instance was updated.
}
diff --git a/docs/dyn/backupdr_v1.projects.locations.html b/docs/dyn/backupdr_v1.projects.locations.html
index 12d413d2b75..59ceecc53b6 100644
--- a/docs/dyn/backupdr_v1.projects.locations.html
+++ b/docs/dyn/backupdr_v1.projects.locations.html
@@ -99,6 +99,11 @@ Instance Methods
Returns the operations Resource.
+
+ serviceConfig()
+
Returns the serviceConfig Resource.
+Close httplib2 connections.
diff --git a/docs/dyn/backupdr_v1.projects.locations.operations.html b/docs/dyn/backupdr_v1.projects.locations.operations.html index 95b243c4a7d..c61d9abd1cb 100644 --- a/docs/dyn/backupdr_v1.projects.locations.operations.html +++ b/docs/dyn/backupdr_v1.projects.locations.operations.html @@ -76,7 +76,7 @@cancel(name, body=None, x__xgafv=None)
-Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
Close httplib2 connections.
@@ -95,7 +95,7 @@cancel(name, body=None, x__xgafv=None)
- Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. +Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. Args: name: string, The name of the operation resource to be cancelled. (required) diff --git a/docs/dyn/backupdr_v1.projects.locations.serviceConfig.html b/docs/dyn/backupdr_v1.projects.locations.serviceConfig.html new file mode 100644 index 00000000000..ca339fc2413 --- /dev/null +++ b/docs/dyn/backupdr_v1.projects.locations.serviceConfig.html @@ -0,0 +1,132 @@ + + + +Backup and DR Service API . projects . locations . serviceConfig
+Instance Methods
++
+close()
Close httplib2 connections.
++
+initialize(name, body=None, x__xgafv=None)
Initializes the service related config for a project.
+Method Details
+++ +close()
+Close httplib2 connections.+++ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1.json b/googleapiclient/discovery_cache/documents/backupdr.v1.json index 29ebb785c8e..ad2dc54fe06 100644 --- a/googleapiclient/discovery_cache/documents/backupdr.v1.json +++ b/googleapiclient/discovery_cache/documents/backupdr.v1.json @@ -1538,7 +1538,7 @@ "operations": { "methods": { "cancel": { -"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "backupdr.projects.locations.operations.cancel", @@ -1657,13 +1657,45 @@ ] } } +}, +"serviceConfig": { +"methods": { +"initialize": { +"description": "Initializes the service related config for a project.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceConfig:initialize", +"httpMethod": "POST", +"id": "backupdr.projects.locations.serviceConfig.initialize", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the serviceConfig used to initialize the service. Format: `projects/{project_id}/locations/{location}/serviceConfig`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/serviceConfig$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:initialize", +"request": { +"$ref": "InitializeServiceRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} } } } } } }, -"revision": "20241106", +"revision": "20241204", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -2105,6 +2137,16 @@ "readOnly": true, "type": "string" }, +"satisfiesPzi": { +"description": "Optional. Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Optional. Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "serviceLocks": { "description": "Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup.", "items": { @@ -2353,7 +2395,7 @@ "type": "string" }, "resourceType": { -"description": "Required. The resource type to which the `BackupPlan` will be applied. Examples include, \"compute.googleapis.com/Instance\", \"sqladmin.googleapis.com/Instance\" and \"storage.googleapis.com/Bucket\".", +"description": "Required. The resource type to which the `BackupPlan` will be applied. Examples include, \"compute.googleapis.com/Instance\", \"sqladmin.googleapis.com/Instance\", or \"alloydb.googleapis.com/Cluster\".", "type": "string" }, "state": { @@ -2399,7 +2441,7 @@ "type": "string" }, "dataSource": { -"description": "Output only. 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}", +"description": "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}", "readOnly": true, "type": "string" }, @@ -2413,7 +2455,7 @@ "type": "string" }, "resourceType": { -"description": "Optional. Required. Resource type of workload on which backupplan is applied", +"description": "Required. Immutable. Resource type of workload on which backupplan is applied", "type": "string" }, "rulesConfigInfo": { @@ -2459,7 +2501,7 @@ "id": "BackupRule", "properties": { "backupRetentionDays": { -"description": "Required. Configures the duration for which backup data will be kept. It is defined in \u201cdays\u201d. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 90 for hourly backups. Minimum value is 1 and maximum value is 90 for daily backups. Minimum value is 7 and maximum value is 186 for weekly backups. Minimum value is 30 and maximum value is 732 for monthly backups. Minimum value is 30 and maximum value is 36159 for yearly backups.", +"description": "Required. Configures the duration for which backup data will be kept. It is defined in \u201cdays\u201d. The value should be greater than or equal to minimum enforced retention of the backup vault. Minimum value is 1 and maximum value is 90 for hourly backups. Minimum value is 1 and maximum value is 90 for daily backups. Minimum value is 7 and maximum value is 186 for weekly backups. Minimum value is 30 and maximum value is 732 for monthly backups. Minimum value is 365 and maximum value is 36159 for yearly backups.", "format": "int32", "type": "integer" }, @@ -2479,7 +2521,7 @@ "id": "BackupVault", "properties": { "accessRestriction": { -"description": "Optional. Note: This field is added for future use case and will not be supported in the current release. Optional. Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation.", +"description": "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.", "enum": [ "ACCESS_RESTRICTION_UNSPECIFIED", "WITHIN_PROJECT", @@ -2581,7 +2623,7 @@ "type": "string" }, "uid": { -"description": "Output only. Output only Immutable after resource creation until resource deletion.", +"description": "Output only. Immutable after resource creation until resource deletion.", "readOnly": true, "type": "string" }, @@ -3384,6 +3426,21 @@ }, "type": "object" }, +"InitializeServiceRequest": { +"description": "Request message for initializing the service.", +"id": "InitializeServiceRequest", +"properties": { +"requestId": { +"description": "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).", +"type": "string" +}, +"resourceType": { +"description": "Required. The resource type to which the default service config will be applied. Examples include, \"compute.googleapis.com/Instance\" and \"storage.googleapis.com/Bucket\".", +"type": "string" +} +}, +"type": "object" +}, "InitiateBackupRequest": { "description": "request message for InitiateBackup.", "id": "InitiateBackupRequest", @@ -4052,7 +4109,7 @@ "type": "string" }, "requestedCancellation": { -"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to 'Code.CANCELLED'.", +"description": "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'.", "readOnly": true, "type": "boolean" }, @@ -4152,7 +4209,7 @@ "properties": { "lastBackupError": { "$ref": "Status", -"description": "Output only. Output Only. google.rpc.Status object to store the last backup error.", +"description": "Output only. google.rpc.Status object to store the last backup error.", "readOnly": true }, "lastBackupState": { @@ -4181,7 +4238,7 @@ "type": "string" }, "ruleId": { -"description": "Output only. Output Only. Backup Rule id fetched from backup plan.", +"description": "Output only. Backup Rule id fetched from backup plan.", "readOnly": true, "type": "string" }initialize(name, body=None, x__xgafv=None)
+Initializes the service related config for a project. + +Args: + name: string, Required. The resource name of the serviceConfig used to initialize the service. Format: `projects/{project_id}/locations/{location}/serviceConfig`. (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for initializing the service. + "requestId": "A 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). + "resourceType": "A 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". +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # This resource represents a long-running operation that is the result of a network API call. + "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. + "code": 42, # The status code, which should be an enum value of google.rpc.Code. + "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. + { + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + ], + "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. + }, + "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, + "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. + "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + "a_key": "", # Properties of the object. Contains field @type with type URL. + }, +}+