Deletes a base plan. Can only be done for draft base plans. This action is irreversible.
migratePrices(packageName, productId, basePlanId, body=None, x__xgafv=None)
Migrates subscribers who are receiving an historical subscription price to the currently-offered price for the specified region. Requests will cause price change notifications to be sent to users who are currently receiving an historical price older than the supplied timestamp. Subscribers who do not agree to the new price will have their subscription ended at the next renewal.
+Migrates subscribers from one or more legacy price cohorts to the current price. Requests result in Google Play notifying affected subscribers. Only up to 250 simultaneous legacy price cohorts are supported.
activate(packageName, productId, basePlanId, body=None, x__xgafv=None)
@@ -235,9 +235,9 @@ migratePrices(packageName, productId, basePlanId, body=None, x__xgafv=None)
- Migrates subscribers who are receiving an historical subscription price to the currently-offered price for the specified region. Requests will cause price change notifications to be sent to users who are currently receiving an historical price older than the supplied timestamp. Subscribers who do not agree to the new price will have their subscription ended at the next renewal. +Migrates subscribers from one or more legacy price cohorts to the current price. Requests result in Google Play notifying affected subscribers. Only up to 250 simultaneous legacy price cohorts are supported. Args: packageName: string, Required. Package name of the parent app. Must be equal to the package_name field on the Subscription resource. (required) @@ -548,9 +548,9 @@Method Details
"packageName": "A String", # Required. Package name of the parent app. Must be equal to the package_name field on the Subscription resource. "productId": "A String", # Required. The ID of the subscription to update. Must be equal to the product_id field on the Subscription resource. "regionalPriceMigrations": [ # Required. The regional prices to update. - { # Configuration for a price migration. - "oldestAllowedPriceVersionTime": "A String", # Required. The cutoff time for historical prices that subscribers can remain paying. Subscribers on prices which were available at this cutoff time or later will stay on their existing price. Subscribers on older prices will be migrated to the currently-offered price. The migrated subscribers will receive a notification that they will be paying a different price. Subscribers who do not agree to the new price will have their subscription ended at the next renewal. - "priceIncreaseType": "A String", # Optional. The behavior the caller wants users to see when there is a price increase during migration. If left unset, the behavior defaults to PRICE_INCREASE_TYPE_OPT_IN. Note that the first opt-out price increase migration for each app must be initiated in Play Console. + { # Configuration for migration of a legacy price cohort. + "oldestAllowedPriceVersionTime": "A String", # Required. Subscribers in all legacy price cohorts before this time will be migrated to the current price. Subscribers in any newer price cohorts are unaffected. Affected subscribers will receive one or more notifications from Google Play about the price change. Price decreases occur at the subscriber's next billing date. Price increases occur at the subscriber's next billing date following a notification period that varies by region and price increase type. + "priceIncreaseType": "A String", # Optional. The requested type of price increase "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". }, ], diff --git a/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html b/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html index bffd9c5009b..9ab4cdb48c4 100644 --- a/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html +++ b/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html @@ -231,6 +231,7 @@Method Details
"name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. "partner": "A String", # Optional. Partner regime associated with this workload. "partnerPermissions": { # Permissions granted to the AW Partner SA account for the customer workload # Optional. Permissions granted to the AW Partner SA account for the customer workload + "accessTransparencyLogsSupportCaseViewer": True or False, # Optional. Allow partner to view support case details for an AXT log "assuredWorkloadsMonitoring": True or False, # Optional. Allow partner to view violation alerts. "dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. @@ -372,6 +373,7 @@Method Details
"name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. "partner": "A String", # Optional. Partner regime associated with this workload. "partnerPermissions": { # Permissions granted to the AW Partner SA account for the customer workload # Optional. Permissions granted to the AW Partner SA account for the customer workload + "accessTransparencyLogsSupportCaseViewer": True or False, # Optional. Allow partner to view support case details for an AXT log "assuredWorkloadsMonitoring": True or False, # Optional. Allow partner to view violation alerts. "dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. @@ -453,6 +455,7 @@Method Details
"name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. "partner": "A String", # Optional. Partner regime associated with this workload. "partnerPermissions": { # Permissions granted to the AW Partner SA account for the customer workload # Optional. Permissions granted to the AW Partner SA account for the customer workload + "accessTransparencyLogsSupportCaseViewer": True or False, # Optional. Allow partner to view support case details for an AXT log "assuredWorkloadsMonitoring": True or False, # Optional. Allow partner to view violation alerts. "dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. @@ -510,6 +513,7 @@Method Details
{ # Request for updating permission settings for a partner workload. "etag": "A String", # Optional. The etag of the workload. If this is provided, it must match the server's etag. "partnerPermissions": { # Permissions granted to the AW Partner SA account for the customer workload # Required. The partner permissions to be updated. + "accessTransparencyLogsSupportCaseViewer": True or False, # Optional. Allow partner to view support case details for an AXT log "assuredWorkloadsMonitoring": True or False, # Optional. Allow partner to view violation alerts. "dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. @@ -557,6 +561,7 @@Method Details
"name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. "partner": "A String", # Optional. Partner regime associated with this workload. "partnerPermissions": { # Permissions granted to the AW Partner SA account for the customer workload # Optional. Permissions granted to the AW Partner SA account for the customer workload + "accessTransparencyLogsSupportCaseViewer": True or False, # Optional. Allow partner to view support case details for an AXT log "assuredWorkloadsMonitoring": True or False, # Optional. Allow partner to view violation alerts. "dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. @@ -627,6 +632,7 @@Method Details
"name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. "partner": "A String", # Optional. Partner regime associated with this workload. "partnerPermissions": { # Permissions granted to the AW Partner SA account for the customer workload # Optional. Permissions granted to the AW Partner SA account for the customer workload + "accessTransparencyLogsSupportCaseViewer": True or False, # Optional. Allow partner to view support case details for an AXT log "assuredWorkloadsMonitoring": True or False, # Optional. Allow partner to view violation alerts. "dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. @@ -696,6 +702,7 @@Method Details
"name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. "partner": "A String", # Optional. Partner regime associated with this workload. "partnerPermissions": { # Permissions granted to the AW Partner SA account for the customer workload # Optional. Permissions granted to the AW Partner SA account for the customer workload + "accessTransparencyLogsSupportCaseViewer": True or False, # Optional. Allow partner to view support case details for an AXT log "assuredWorkloadsMonitoring": True or False, # Optional. Allow partner to view violation alerts. "dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. diff --git a/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.html b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.html index 89ff05e1048..69cba1d8679 100644 --- a/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.html +++ b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.html @@ -256,6 +256,7 @@Method Details
"name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. "partner": "A String", # Optional. Partner regime associated with this workload. "partnerPermissions": { # Permissions granted to the AW Partner SA account for the customer workload # Optional. Permissions granted to the AW Partner SA account for the customer workload + "accessTransparencyLogsSupportCaseViewer": True or False, # Optional. Allow partner to view support case details for an AXT log "assuredWorkloadsMonitoring": True or False, # Optional. Allow partner to view violation alerts. "dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. @@ -440,6 +441,7 @@Method Details
"name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. "partner": "A String", # Optional. Partner regime associated with this workload. "partnerPermissions": { # Permissions granted to the AW Partner SA account for the customer workload # Optional. Permissions granted to the AW Partner SA account for the customer workload + "accessTransparencyLogsSupportCaseViewer": True or False, # Optional. Allow partner to view support case details for an AXT log "assuredWorkloadsMonitoring": True or False, # Optional. Allow partner to view violation alerts. "dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. @@ -546,6 +548,7 @@Method Details
"name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. "partner": "A String", # Optional. Partner regime associated with this workload. "partnerPermissions": { # Permissions granted to the AW Partner SA account for the customer workload # Optional. Permissions granted to the AW Partner SA account for the customer workload + "accessTransparencyLogsSupportCaseViewer": True or False, # Optional. Allow partner to view support case details for an AXT log "assuredWorkloadsMonitoring": True or False, # Optional. Allow partner to view violation alerts. "dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. @@ -657,6 +660,7 @@Method Details
"name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. "partner": "A String", # Optional. Partner regime associated with this workload. "partnerPermissions": { # Permissions granted to the AW Partner SA account for the customer workload # Optional. Permissions granted to the AW Partner SA account for the customer workload + "accessTransparencyLogsSupportCaseViewer": True or False, # Optional. Allow partner to view support case details for an AXT log "assuredWorkloadsMonitoring": True or False, # Optional. Allow partner to view violation alerts. "dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. @@ -751,6 +755,7 @@Method Details
"name": "A String", # Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. "partner": "A String", # Optional. Partner regime associated with this workload. "partnerPermissions": { # Permissions granted to the AW Partner SA account for the customer workload # Optional. Permissions granted to the AW Partner SA account for the customer workload + "accessTransparencyLogsSupportCaseViewer": True or False, # Optional. Allow partner to view support case details for an AXT log "assuredWorkloadsMonitoring": True or False, # Optional. Allow partner to view violation alerts. "dataLogsViewer": True or False, # Allow the partner to view inspectability logs and monitoring violations. "serviceAccessApprover": True or False, # Optional. Allow partner to view access approval logs. diff --git a/docs/dyn/backupdr_v1.projects.locations.backupPlanAssociations.html b/docs/dyn/backupdr_v1.projects.locations.backupPlanAssociations.html new file mode 100644 index 00000000000..dfe085373fb --- /dev/null +++ b/docs/dyn/backupdr_v1.projects.locations.backupPlanAssociations.html @@ -0,0 +1,362 @@ + + + +Backup and DR Service API . projects . locations . backupPlanAssociations
+Instance Methods
++
+close()Close httplib2 connections.
++
+create(parent, backupPlanAssociationId=None, body=None, requestId=None, x__xgafv=None)Create a BackupPlanAssociation
++
+delete(name, requestId=None, x__xgafv=None)Deletes a single BackupPlanAssociation.
+ +Gets details of a single BackupPlanAssociation.
++
+list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)Lists BackupPlanAssociations in a given project and location.
+ +Retrieves the next page of results.
++
+triggerBackup(name, body=None, x__xgafv=None)Triggers a new Backup.
+Method Details
+++ +close()+Close httplib2 connections.+++ +create(parent, backupPlanAssociationId=None, body=None, requestId=None, x__xgafv=None)+Create a BackupPlanAssociation + +Args: + 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**. (required) + body: object, The request body. + The object takes the form of: + +{ # 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} + "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", # Output only. Output Only. Resource type of workload on which backupplan is applied + "rulesConfigInfo": [ # Output only. The config info related to backup rules. + { # Message for rules config info. + "dataSource": "A String", # Output only. TODO b/341576760: Remove deprecated BV and Datasource field form BP and BPA once UI removed all dependencies on them Output Only. Resource name of data source which will be used as storage location for backups taken by specified rule. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource} + "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. + "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. + }, + "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. + }, + ], + "state": "A String", # Output only. The BackupPlanAssociation resource state. + "updateTime": "A String", # Output only. The time when the instance was updated. +} + + backupPlanAssociationId: string, Required. The name of the backup plan association to create. The name must be unique for the specified project and location. + requestId: 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). + 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. + }, +}+++ +delete(name, requestId=None, x__xgafv=None)+Deletes a single BackupPlanAssociation. + +Args: + name: string, Required. Name of the backup plan association resource, in the format `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}` (required) + requestId: 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). + 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. + }, +}+++ +get(name, x__xgafv=None)+Gets details of a single BackupPlanAssociation. + +Args: + name: string, Required. Name of the backup plan association resource, in the format `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}` (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # 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} + "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", # Output only. Output Only. Resource type of workload on which backupplan is applied + "rulesConfigInfo": [ # Output only. The config info related to backup rules. + { # Message for rules config info. + "dataSource": "A String", # Output only. TODO b/341576760: Remove deprecated BV and Datasource field form BP and BPA once UI removed all dependencies on them Output Only. Resource name of data source which will be used as storage location for backups taken by specified rule. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource} + "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. + "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. + }, + "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. + }, + ], + "state": "A String", # Output only. The BackupPlanAssociation resource state. + "updateTime": "A String", # Output only. The time when the instance was updated. +}+++ +list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)+Lists BackupPlanAssociations in a given project and location. + +Args: + 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. (required) + filter: string, Optional. Filtering results + pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + pageToken: string, Optional. A token identifying a page of results the server should return. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Response message for List BackupPlanAssociation + "backupPlanAssociations": [ # 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. + { # 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} + "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", # Output only. Output Only. Resource type of workload on which backupplan is applied + "rulesConfigInfo": [ # Output only. The config info related to backup rules. + { # Message for rules config info. + "dataSource": "A String", # Output only. TODO b/341576760: Remove deprecated BV and Datasource field form BP and BPA once UI removed all dependencies on them Output Only. Resource name of data source which will be used as storage location for backups taken by specified rule. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource} + "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. + "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. + }, + "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. + }, + ], + "state": "A String", # Output only. The BackupPlanAssociation resource state. + "updateTime": "A String", # Output only. The time when the instance was updated. + }, + ], + "nextPageToken": "A String", # A token identifying a page of results the server should return. + "unreachable": [ # Locations that could not be reached. + "A String", + ], +}+++ +list_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++++ + \ No newline at end of file diff --git a/docs/dyn/backupdr_v1.projects.locations.backupPlans.html b/docs/dyn/backupdr_v1.projects.locations.backupPlans.html new file mode 100644 index 00000000000..cedc006a9e4 --- /dev/null +++ b/docs/dyn/backupdr_v1.projects.locations.backupPlans.html @@ -0,0 +1,368 @@ + + + +triggerBackup(name, body=None, x__xgafv=None)+Triggers a new Backup. + +Args: + name: string, Required. Name of the backup plan association resource, in the format `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}` (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for triggering a backup. + "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 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). + "ruleId": "A String", # Required. backup rule_id for which a backup needs to be triggered. +} + + 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. + }, +}+Backup and DR Service API . projects . locations . backupPlans
+Instance Methods
++
+close()Close httplib2 connections.
++
+create(parent, backupPlanId=None, body=None, requestId=None, x__xgafv=None)Create a BackupPlan
++
+delete(name, requestId=None, x__xgafv=None)Deletes a single BackupPlan.
+ +Gets details of a single BackupPlan.
++
+list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)Lists BackupPlans in a given project and location.
+ +Retrieves the next page of results.
+Method Details
+++ +close()+Close httplib2 connections.+++ +create(parent, backupPlanId=None, body=None, requestId=None, x__xgafv=None)+Create a BackupPlan + +Args: + 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**. (required) + body: object, The request body. + The object takes the form of: + +{ # A `BackupPlan` specifies some common fields, such as `display_name` 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. + "backupVault": "A String", # Optional. TODO b/341576760: Remove deprecated BV and Datasource field form BP and BPA once UI removed all dependencies on them Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault} + "backupVaultServiceAccount": "A String", # Output only. TODO b/341576760: Remove deprecated BV and Datasource field form BP and BPA once UI removed all dependencies on them 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. + "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. + "endHourOfDay": 42, # 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. + "startHourOfDay": 42, # 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. + }, + "daysOfMonth": [ # 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. + 42, + ], + "daysOfWeek": [ # 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`. + "A String", + ], + "hourlyFrequency": 42, # 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 6 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). + "months": [ # 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. + "A String", + ], + "recurrenceType": "A String", # Required. Specifies the `RecurrenceType` for the schedule. + "timeZone": "A 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. + "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`. # 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. + "dayOfWeek": "A String", # Required. Specifies the day of the week. + "weekOfMonth": "A String", # Required. Specifies the week of the month. + }, + }, + }, + ], + "backupVault": "A String", # Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault} + "backupVaultServiceAccount": "A 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. + "createTime": "A String", # Output only. When the `BackupPlan` was created. + "description": "A 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. + "etag": "A 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. + "labels": { # Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}. + "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" and "storage.googleapis.com/Bucket". + "state": "A String", # Output only. The `State` for the `BackupPlan`. + "updateTime": "A String", # Output only. When the `BackupPlan` was last updated. +} + + backupPlanId: 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{,62}/. + requestId: 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). + 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. + }, +}+++ +delete(name, requestId=None, x__xgafv=None)+Deletes a single BackupPlan. + +Args: + name: string, Required. The resource name of the `BackupPlan` to delete. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` (required) + requestId: 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). + 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. + }, +}+++ +get(name, x__xgafv=None)+Gets details of a single BackupPlan. + +Args: + name: string, Required. The resource name of the `BackupPlan` to retrieve. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}` (required) + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A `BackupPlan` specifies some common fields, such as `display_name` 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. + "backupVault": "A String", # Optional. TODO b/341576760: Remove deprecated BV and Datasource field form BP and BPA once UI removed all dependencies on them Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault} + "backupVaultServiceAccount": "A String", # Output only. TODO b/341576760: Remove deprecated BV and Datasource field form BP and BPA once UI removed all dependencies on them 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. + "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. + "endHourOfDay": 42, # 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. + "startHourOfDay": 42, # 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. + }, + "daysOfMonth": [ # 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. + 42, + ], + "daysOfWeek": [ # 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`. + "A String", + ], + "hourlyFrequency": 42, # 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 6 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). + "months": [ # 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. + "A String", + ], + "recurrenceType": "A String", # Required. Specifies the `RecurrenceType` for the schedule. + "timeZone": "A 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. + "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`. # 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. + "dayOfWeek": "A String", # Required. Specifies the day of the week. + "weekOfMonth": "A String", # Required. Specifies the week of the month. + }, + }, + }, + ], + "backupVault": "A String", # Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault} + "backupVaultServiceAccount": "A 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. + "createTime": "A String", # Output only. When the `BackupPlan` was created. + "description": "A 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. + "etag": "A 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. + "labels": { # Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}. + "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" and "storage.googleapis.com/Bucket". + "state": "A String", # Output only. The `State` for the `BackupPlan`. + "updateTime": "A String", # Output only. When the `BackupPlan` was last updated. +}+++ +list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)+Lists BackupPlans in a given project and location. + +Args: + 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. (required) + filter: string, Optional. Field match expression used to filter the results. + orderBy: string, Optional. Field by which to sort the results. + pageSize: integer, 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. + pageToken: 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. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # The response message for getting a list of `BackupPlan`. + "backupPlans": [ # The list of `BackupPlans` 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. BackupPlan + { # A `BackupPlan` specifies some common fields, such as `display_name` 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. + "backupVault": "A String", # Optional. TODO b/341576760: Remove deprecated BV and Datasource field form BP and BPA once UI removed all dependencies on them Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault} + "backupVaultServiceAccount": "A String", # Output only. TODO b/341576760: Remove deprecated BV and Datasource field form BP and BPA once UI removed all dependencies on them 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. + "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. + "endHourOfDay": 42, # 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. + "startHourOfDay": 42, # 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. + }, + "daysOfMonth": [ # 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. + 42, + ], + "daysOfWeek": [ # 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`. + "A String", + ], + "hourlyFrequency": 42, # 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 6 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). + "months": [ # 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. + "A String", + ], + "recurrenceType": "A String", # Required. Specifies the `RecurrenceType` for the schedule. + "timeZone": "A 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. + "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`. # 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. + "dayOfWeek": "A String", # Required. Specifies the day of the week. + "weekOfMonth": "A String", # Required. Specifies the week of the month. + }, + }, + }, + ], + "backupVault": "A String", # Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault} + "backupVaultServiceAccount": "A 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. + "createTime": "A String", # Output only. When the `BackupPlan` was created. + "description": "A 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. + "etag": "A 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. + "labels": { # Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"}. + "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" and "storage.googleapis.com/Bucket". + "state": "A String", # Output only. The `State` for the `BackupPlan`. + "updateTime": "A String", # Output only. When the `BackupPlan` was last updated. + }, + ], + "nextPageToken": "A 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": [ # Locations that could not be reached. + "A String", + ], +}+++ + \ No newline at end of file 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 9eb2465f3d8..c50f87e4fd6 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html @@ -92,6 +92,9 @@list_next()+Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++Instance Methods
patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)Updates the settings of a Backup.
++
+restore(name, body=None, x__xgafv=None)Restore from a Backup
Method Details
+close()@@ -149,7 +152,7 @@Method Details
An object of the form: { # Message describing a Backup object. - "backupApplianceBackupProperties": { # BackupApplianceBackupProperties represents BackupDR backup appliance's properties. + "backupApplianceBackupProperties": { # BackupApplianceBackupProperties represents BackupDR backup appliance's properties. # Output only. Backup Appliance specific backup properties. "finalizeTime": "A String", # Output only. The time when this backup object was finalized (if none, backup is not finalized). "generationId": 42, # Output only. The numeric generation ID of the backup (monotonically increasing). "recoveryRangeEndTime": "A String", # Optional. The latest timestamp of data available in this Backup. @@ -171,8 +174,8 @@Method Details
}, }, ], - "backupType": "A String", - "computeInstanceBackupProperties": { # ComputeInstanceBackupProperties represents Compute Engine instance backup properties. + "backupType": "A String", # Output only. Type of the backup, unspecified, scheduled or ondemand. + "computeInstanceBackupProperties": { # ComputeInstanceBackupProperties represents Compute Engine instance backup properties. # Output only. Compute Engine specific backup properties. "canIpForward": True or False, # 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. "description": "A String", # An optional text description for the instances that are created from these properties. "disk": [ # An array of disks that are associated with the instances that are created from these properties. @@ -188,8 +191,8 @@Method Details
}, "diskInterface": "A String", # Optional. Specifies the disk interface to use for attaching this disk. "diskSizeGb": "A String", # Optional. The size of the disk in GB. - "diskType": "A String", # Optional. Specifies the type of the disk. - "diskTypeUri": "A String", # Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd + "diskType": "A String", # Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd + "diskTypeDeprecated": "A String", # Specifies the type of the disk. "guestOsFeature": [ # Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. { # Feature type of the Guest OS. "type": "A String", # The ID of a supported feature. @@ -209,6 +212,7 @@Method Details
"mode": "A String", # Optional. The mode in which to attach this disk. "savedState": "A String", # Optional. Output only. The state of the disk. "source": "A String", # Optional. Specifies a valid partial or full URL to an existing Persistent Disk resource. + "type": "A String", # Optional. Specifies the type of the disk. }, ], "guestAccelerator": [ # A list of guest accelerator cards' type and count to use for instances created from these properties. @@ -322,7 +326,7 @@Method Details
"labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined. "a_key": "A String", }, - "name": "A String", # Output only. Name of the resource. + "name": "A String", # Output only. Identifier. Name of the resource. "resourceSizeBytes": "A String", # Output only. source resource size in bytes at the time of the backup. "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. @@ -366,7 +370,7 @@Method Details
{ # Response message for listing Backups. "backups": [ # 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. { # Message describing a Backup object. - "backupApplianceBackupProperties": { # BackupApplianceBackupProperties represents BackupDR backup appliance's properties. + "backupApplianceBackupProperties": { # BackupApplianceBackupProperties represents BackupDR backup appliance's properties. # Output only. Backup Appliance specific backup properties. "finalizeTime": "A String", # Output only. The time when this backup object was finalized (if none, backup is not finalized). "generationId": 42, # Output only. The numeric generation ID of the backup (monotonically increasing). "recoveryRangeEndTime": "A String", # Optional. The latest timestamp of data available in this Backup. @@ -388,8 +392,8 @@Method Details
}, }, ], - "backupType": "A String", - "computeInstanceBackupProperties": { # ComputeInstanceBackupProperties represents Compute Engine instance backup properties. + "backupType": "A String", # Output only. Type of the backup, unspecified, scheduled or ondemand. + "computeInstanceBackupProperties": { # ComputeInstanceBackupProperties represents Compute Engine instance backup properties. # Output only. Compute Engine specific backup properties. "canIpForward": True or False, # 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. "description": "A String", # An optional text description for the instances that are created from these properties. "disk": [ # An array of disks that are associated with the instances that are created from these properties. @@ -405,8 +409,8 @@Method Details
}, "diskInterface": "A String", # Optional. Specifies the disk interface to use for attaching this disk. "diskSizeGb": "A String", # Optional. The size of the disk in GB. - "diskType": "A String", # Optional. Specifies the type of the disk. - "diskTypeUri": "A String", # Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd + "diskType": "A String", # Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd + "diskTypeDeprecated": "A String", # Specifies the type of the disk. "guestOsFeature": [ # Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. { # Feature type of the Guest OS. "type": "A String", # The ID of a supported feature. @@ -426,6 +430,7 @@Method Details
"mode": "A String", # Optional. The mode in which to attach this disk. "savedState": "A String", # Optional. Output only. The state of the disk. "source": "A String", # Optional. Specifies a valid partial or full URL to an existing Persistent Disk resource. + "type": "A String", # Optional. Specifies the type of the disk. }, ], "guestAccelerator": [ # A list of guest accelerator cards' type and count to use for instances created from these properties. @@ -539,7 +544,7 @@Method Details
"labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined. "a_key": "A String", }, - "name": "A String", # Output only. Name of the resource. + "name": "A String", # Output only. Identifier. Name of the resource. "resourceSizeBytes": "A String", # Output only. source resource size in bytes at the time of the backup. "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. @@ -587,12 +592,12 @@Method Details
Updates the settings of a Backup. Args: - name: string, Output only. Name of the resource. (required) + name: string, Output only. Identifier. Name of the resource. (required) body: object, The request body. The object takes the form of: { # Message describing a Backup object. - "backupApplianceBackupProperties": { # BackupApplianceBackupProperties represents BackupDR backup appliance's properties. + "backupApplianceBackupProperties": { # BackupApplianceBackupProperties represents BackupDR backup appliance's properties. # Output only. Backup Appliance specific backup properties. "finalizeTime": "A String", # Output only. The time when this backup object was finalized (if none, backup is not finalized). "generationId": 42, # Output only. The numeric generation ID of the backup (monotonically increasing). "recoveryRangeEndTime": "A String", # Optional. The latest timestamp of data available in this Backup. @@ -614,8 +619,8 @@Method Details
}, }, ], - "backupType": "A String", - "computeInstanceBackupProperties": { # ComputeInstanceBackupProperties represents Compute Engine instance backup properties. + "backupType": "A String", # Output only. Type of the backup, unspecified, scheduled or ondemand. + "computeInstanceBackupProperties": { # ComputeInstanceBackupProperties represents Compute Engine instance backup properties. # Output only. Compute Engine specific backup properties. "canIpForward": True or False, # 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. "description": "A String", # An optional text description for the instances that are created from these properties. "disk": [ # An array of disks that are associated with the instances that are created from these properties. @@ -631,8 +636,8 @@Method Details
}, "diskInterface": "A String", # Optional. Specifies the disk interface to use for attaching this disk. "diskSizeGb": "A String", # Optional. The size of the disk in GB. - "diskType": "A String", # Optional. Specifies the type of the disk. - "diskTypeUri": "A String", # Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd + "diskType": "A String", # Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd + "diskTypeDeprecated": "A String", # Specifies the type of the disk. "guestOsFeature": [ # Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. { # Feature type of the Guest OS. "type": "A String", # The ID of a supported feature. @@ -652,6 +657,7 @@Method Details
"mode": "A String", # Optional. The mode in which to attach this disk. "savedState": "A String", # Optional. Output only. The state of the disk. "source": "A String", # Optional. Specifies a valid partial or full URL to an existing Persistent Disk resource. + "type": "A String", # Optional. Specifies the type of the disk. }, ], "guestAccelerator": [ # A list of guest accelerator cards' type and count to use for instances created from these properties. @@ -765,7 +771,7 @@Method Details
"labels": { # Optional. Resource labels to represent user provided metadata. No labels currently defined. "a_key": "A String", }, - "name": "A String", # Output only. Name of the resource. + "name": "A String", # Output only. Identifier. Name of the resource. "resourceSizeBytes": "A String", # Output only. source resource size in bytes at the time of the backup. "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. @@ -818,4 +824,230 @@Method Details
}++restore(name, body=None, x__xgafv=None)+Restore from a Backup + +Args: + name: string, Required. The resource name of the Backup instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/*/backups/'. (required) + body: object, The request body. + The object takes the form of: + +{ # Request message for restoring from a Backup. + "computeInstanceRestoreProperties": { # ComputeInstanceRestoreProperties represents Compute Engine instance properties to be overridden during restore. # Compute Engine instance properties to be overridden during restore. + "advancedMachineFeatures": { # Specifies options for controlling advanced machine features. # Optional. Controls for advanced machine-related behavior features. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization or not (default is false). + "enableUefiNetworking": True or False, # Optional. Whether to enable UEFI networking for instance creation. + "threadsPerCore": 42, # 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. + "visibleCoreCount": 42, # 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. + }, + "canIpForward": True or False, # Optional. Allows this instance to send and receive packets with non-matching destination or source IPs. + "confidentialInstanceConfig": { # A set of Confidential Instance options. # Optional. Controls Confidential compute options on the instance + "enableConfidentialCompute": True or False, # Optional. Defines whether the instance should have confidential compute enabled. + }, + "deletionProtection": True or False, # Optional. Whether the resource should be protected against deletion. + "description": "A String", # Optional. An optional description of this resource. Provide this property when you create the resource. + "disks": [ # Optional. Array of disks associated with this instance. Persistent disks must be created before you can assign them. + { # An instance-attached disk resource. + "autoDelete": True or False, # Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). + "boot": True or False, # Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. + "deviceName": "A 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) + "diskEncryptionKey": { # A customer-supplied encryption key. # Optional. Encrypts or decrypts a disk using a customer-supplied encryption key. + "kmsKeyName": "A String", # Optional. The name of the encryption key that is stored in Google Cloud KMS. + "kmsKeyServiceAccount": "A 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. + "rawKey": "A String", # Optional. Specifies a 256-bit customer-supplied encryption key. + "rsaEncryptedKey": "A String", # Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. + }, + "diskInterface": "A String", # Optional. Specifies the disk interface to use for attaching this disk. + "diskSizeGb": "A String", # Optional. The size of the disk in GB. + "diskType": "A String", # Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd + "diskTypeDeprecated": "A String", # Specifies the type of the disk. + "guestOsFeature": [ # Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. + { # Feature type of the Guest OS. + "type": "A String", # The ID of a supported feature. + }, + ], + "index": "A String", # Optional. A zero-based index to this disk, where 0 is reserved for the boot disk. + "initializeParams": { # Specifies the parameters to initialize this disk. # Optional. Specifies the parameters to initialize this disk. + "diskName": "A String", # Optional. Specifies the disk name. If not specified, the default is to use the name of the instance. + "replicaZones": [ # Optional. URL of the zone where the disk should be created. Required for each regional disk associated with the instance. + "A String", + ], + }, + "kind": "A String", # Optional. Type of the resource. + "license": [ # Optional. Any valid publicly visible licenses. + "A String", + ], + "mode": "A String", # Optional. The mode in which to attach this disk. + "savedState": "A String", # Optional. Output only. The state of the disk. + "source": "A String", # Optional. Specifies a valid partial or full URL to an existing Persistent Disk resource. + "type": "A String", # Optional. Specifies the type of the disk. + }, + ], + "displayDevice": { # A set of Display Device options # Optional. Enables display device for the instance. + "enableDisplay": True or False, # Optional. Enables display for the Compute Engine VM + }, + "guestAccelerators": [ # Optional. A list of the type and count of accelerator cards attached to the instance. + { # A specification of the type and number of accelerator cards attached to the instance. + "acceleratorCount": 42, # Optional. The number of the guest accelerator cards exposed to this instance. + "acceleratorType": "A String", # Optional. Full or partial URL of the accelerator type resource to attach to this instance. + }, + ], + "hostname": "A 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. + "instanceEncryptionKey": { # A customer-supplied encryption key. # Optional. Encrypts suspended data for an instance with a customer-managed encryption key. + "kmsKeyName": "A String", # Optional. The name of the encryption key that is stored in Google Cloud KMS. + "kmsKeyServiceAccount": "A 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. + "rawKey": "A String", # Optional. Specifies a 256-bit customer-supplied encryption key. + "rsaEncryptedKey": "A String", # Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. + }, + "keyRevocationActionType": "A String", # Optional. KeyRevocationActionType of the instance. + "labels": { # Optional. Labels to apply to this instance. + "a_key": "A String", + }, + "machineType": "A String", # Optional. Full or partial URL of the machine type resource to use for this instance. + "metadata": { # A metadata key/value entry. # Optional. This includes custom metadata and predefined keys. + "items": [ # Optional. Array of key/value pairs. The total size of all keys and values must be less than 512 KB. + { # A key/value pair to be used for storing metadata. + "key": "A String", # Optional. Key for the metadata entry. + "value": "A 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). + }, + ], + }, + "minCpuPlatform": "A String", # Optional. Minimum CPU platform to use for this instance. + "name": "A String", # Required. Name of the compute instance. + "networkInterfaces": [ # 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. + { # A network interface resource attached to an instance. s + "accessConfigs": [ # 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. + { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. + "externalIpv6": "A String", # Optional. The external IPv6 address of this access configuration. + "externalIpv6PrefixLength": 42, # Optional. The prefix length of the external IPv6 range. + "name": "A String", # Optional. The name of this access configuration. + "natIP": "A String", # Optional. The external IP address of this access configuration. + "networkTier": "A String", # Optional. This signifies the networking tier used for configuring this access + "publicPtrDomainName": "A String", # Optional. The DNS domain name for the public PTR record. + "setPublicPtr": True or False, # 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. + "type": "A String", # Optional. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6. + }, + ], + "aliasIpRanges": [ # Optional. An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. + { # An alias IP range attached to an instance's network interface. + "ipCidrRange": "A String", # Optional. The IP alias ranges to allocate for this interface. + "subnetworkRangeName": "A 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. + }, + ], + "internalIpv6PrefixLength": 42, # Optional. The prefix length of the primary internal IPv6 range. + "ipv6AccessConfigs": [ # 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. + { # An access configuration attached to an instance's network interface. Only one access config per instance is supported. + "externalIpv6": "A String", # Optional. The external IPv6 address of this access configuration. + "externalIpv6PrefixLength": 42, # Optional. The prefix length of the external IPv6 range. + "name": "A String", # Optional. The name of this access configuration. + "natIP": "A String", # Optional. The external IP address of this access configuration. + "networkTier": "A String", # Optional. This signifies the networking tier used for configuring this access + "publicPtrDomainName": "A String", # Optional. The DNS domain name for the public PTR record. + "setPublicPtr": True or False, # 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. + "type": "A String", # Optional. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6. + }, + ], + "ipv6AccessType": "A String", # 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. + "ipv6Address": "A 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. + "name": "A String", # Output only. [Output Only] The name of the network interface, which is generated by the server. + "network": "A String", # Optional. URL of the VPC network resource for this instance. + "networkAttachment": "A 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}. + "networkIP": "A 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. + "nicType": "A String", # Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. + "queueCount": 42, # 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. + "stackType": "A String", # The stack type for this network interface. + "subnetwork": "A String", # Optional. The URL of the Subnetwork resource for this instance. + }, + ], + "networkPerformanceConfig": { # Network performance configuration. # Optional. Configure network performance such as egress bandwidth tier. + "totalEgressBandwidthTier": "A String", # Optional. The tier of the total egress bandwidth. + }, + "params": { # Additional instance params. # Input only. Additional params passed with the request, but not persisted as part of resource payload. + "resourceManagerTags": { # Optional. Resource manager tags to be bound to the instance. + "a_key": "A String", + }, + }, + "privateIpv6GoogleAccess": "A String", # Optional. The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. + "reservationAffinity": { # Specifies the reservations that this instance can consume from. # Optional. Specifies the reservations that this instance can consume from. + "consumeReservationType": "A String", # Optional. Specifies the type of reservation from which this instance can consume + "key": "A String", # Optional. Corresponds to the label key of a reservation resource. + "values": [ # Optional. Corresponds to the label values of a reservation resource. + "A String", + ], + }, + "resourcePolicies": [ # Optional. Resource policies applied to this instance. + "A String", + ], + "scheduling": { # Sets the scheduling options for an Instance. # Optional. Sets the scheduling options for this instance. + "automaticRestart": True or False, # Optional. Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). + "instanceTerminationAction": "A String", # Optional. Specifies the termination action for the instance. + "localSsdRecoveryTimeout": { # 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. # 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. + "nanos": 42, # Optional. Span of time that's a fraction of a second at nanosecond resolution. + "seconds": "A String", # Optional. Span of time at a resolution of a second. + }, + "minNodeCpus": 42, # Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. + "nodeAffinities": [ # Optional. A set of node affinity and anti-affinity configurations. Overrides reservationAffinity. + { # Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. + "key": "A String", # Optional. Corresponds to the label key of Node resource. + "operator": "A String", # Optional. Defines the operation of node selection. + "values": [ # Optional. Corresponds to the label values of Node resource. + "A String", + ], + }, + ], + "onHostMaintenance": "A String", # Optional. Defines the maintenance behavior for this instance. + "preemptible": True or False, # Optional. Defines whether the instance is preemptible. + "provisioningModel": "A String", # Optional. Specifies the provisioning model of the instance. + }, + "serviceAccounts": [ # Optional. A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. + { # A service account. + "email": "A String", # Optional. Email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + ], + "tags": { # A set of instance 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. + "items": [ # Optional. An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. + "A String", + ], + }, + }, + "computeInstanceTargetEnvironment": { # ComputeInstanceTargetEnvironment represents Compute Engine target environment to be used during restore. # Compute Engine target environment to be used during restore. + "project": "A String", # Required. Target project for the Compute Engine instance. + "zone": "A String", # Required. The zone of the Compute Engine instance. + }, + "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 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). +} + + 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. + }, +}+