Close httplib2 connections.
get(project, type, header_bypassBillingFilter=None, x__xgafv=None)
Gets information about a specific type.
list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, x__xgafv=None)
Lists all resource types for Deployment Manager.
Retrieves the next page of results.
close()
Close httplib2 connections.
get(project, type, header_bypassBillingFilter=None, x__xgafv=None)
Gets information about a specific type.
Args:
project: string, The project ID for this request. (required)
type: string, The name of the type for this request. (required)
header_bypassBillingFilter: boolean, A parameter
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A resource type supported by Deployment Manager.
"base": { # BaseType that describes a service-backed Type. # Base Type (configurable service) that backs this Type.
"collectionOverrides": [ # Allows resource handling overrides for specific collections
{ # CollectionOverride allows resource handling overrides for specific resources within a BaseType
"collection": "A String", # The collection that identifies this resource within its service.
"methodMap": { # Deployment Manager will call these methods during the events of creation/deletion/update/get/setIamPolicy # Custom verb method mappings to support unordered list API mappings.
"create": "A String", # The action identifier for the create method to be used for this collection
"delete": "A String", # The action identifier for the delete method to be used for this collection
"get": "A String", # The action identifier for the get method to be used for this collection
"setIamPolicy": "A String", # The action identifier for the setIamPolicy method to be used for this collection
"update": "A String", # The action identifier for the update method to be used for this collection
},
"options": { # Options allows customized resource handling by Deployment Manager. # The options to apply to this resource-level override
"asyncOptions": [ # Options regarding how to thread async requests.
{ # Async options that determine when a resource should finish.
"methodMatch": "A String", # Method regex where this policy will apply.
"pollingOptions": { # Deployment manager will poll instances for this API resource setting a RUNNING state, and blocking until polling conditions tell whether the resource is completed or failed.
"diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user.
{
"field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic.
"level": "A String", # Level to record this diagnostic.
},
],
"failCondition": "A String", # JsonPath expression that determines if the request failed.
"finishCondition": "A String", # JsonPath expression that determines if the request is completed.
"pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll.
"targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource.
},
},
],
"inputMappings": [ # The mappings that apply for requests.
{ # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API.
"fieldName": "A String", # The name of the field that is going to be injected.
"location": "A String", # The location where this mapping applies.
"methodMatch": "A String", # Regex to evaluate on method to decide if input applies.
"value": "A String", # A jsonPath expression to select an element.
},
],
"nameProperty": "A String", # The json path to the field in the resource JSON body into which the resource name should be mapped. Leaving this empty indicates that there should be no mapping performed.
"validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource.
"schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors.
"undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request.
},
},
},
],
"credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Credential used when interacting with this type.
"basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.
"password": "A String",
"user": "A String",
},
"serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.
"email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com
},
"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.
},
"descriptorUrl": "A String", # Descriptor Url for the this type.
"options": { # Options allows customized resource handling by Deployment Manager. # Options to apply when handling any resources in this service.
"asyncOptions": [ # Options regarding how to thread async requests.
{ # Async options that determine when a resource should finish.
"methodMatch": "A String", # Method regex where this policy will apply.
"pollingOptions": { # Deployment manager will poll instances for this API resource setting a RUNNING state, and blocking until polling conditions tell whether the resource is completed or failed.
"diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user.
{
"field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic.
"level": "A String", # Level to record this diagnostic.
},
],
"failCondition": "A String", # JsonPath expression that determines if the request failed.
"finishCondition": "A String", # JsonPath expression that determines if the request is completed.
"pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll.
"targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource.
},
},
],
"inputMappings": [ # The mappings that apply for requests.
{ # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API.
"fieldName": "A String", # The name of the field that is going to be injected.
"location": "A String", # The location where this mapping applies.
"methodMatch": "A String", # Regex to evaluate on method to decide if input applies.
"value": "A String", # A jsonPath expression to select an element.
},
],
"nameProperty": "A String", # The json path to the field in the resource JSON body into which the resource name should be mapped. Leaving this empty indicates that there should be no mapping performed.
"validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource.
"schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors.
"undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request.
},
},
},
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"id": "A String",
"insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.
"labels": [ # Map of One Platform labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
{ # Label object for Types
"key": "A String", # Key of the label
"value": "A String", # Value of the label
},
],
"name": "A String", # Name of the type.
"operation": { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period. # Output only. The Operation that most recently ran, or is currently running, on this type.
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"arguments": [ # [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field.
"A String",
],
"code": "A String", # [Output Only] The error type identifier for this error.
"debugInfo": { # Describes additional debugging info.
"detail": "A String", # Additional debugging information provided by the server.
"stackEntries": [ # The stack trace entries indicating where the error occurred.
"A String",
],
},
"errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
{
"errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
"domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
"metadata": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
"a_key": "A String",
},
"reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
},
"help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
"links": [ # URL(s) pointing to additional information on handling the current error.
{ # Describes a URL link.
"description": "A String", # Describes what the link offers.
"url": "A String", # The URL of the link.
},
],
},
"localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
"locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
"message": "A String", # The localized error message in the above locale.
},
"quotaInfo": { # Additional details for quota exceeded error for resource quota.
"dimensions": { # The map holding related quota dimensions.
"a_key": "A String",
},
"futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
"limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
"limitName": "A String", # The name of the quota limit.
"metricName": "A String", # The Compute Engine quota metric name.
"rolloutStatus": "A String", # Rollout status of the future quota limit.
},
},
],
"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
"message": "A String", # [Output Only] An optional, human-readable error message.
},
],
},
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
"instancesBulkInsertOperationMetadata": {
"perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
"a_key": {
"createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
"deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
"failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
"status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
"targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
},
},
},
"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
"name": "A String", # [Output Only] Name of the operation.
"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
"clientOperationId": "A String", # [Output Only] The client operation id.
"perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
"a_key": {
"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). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
"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.
},
"state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
},
},
},
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
"value": "A String", # [Output Only] A warning data value corresponding to the key.
},
],
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
},
"selfLink": "A String", # Output only. Server defined URL for the resource.
}
list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, x__xgafv=None)
Lists all resource types for Deployment Manager.
Args:
project: string, The project ID for this request. (required)
filter: string, A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A response that returns all Types supported by Deployment Manager
"nextPageToken": "A String", # A token used to continue a truncated list request.
"types": [ # Output only. A list of resource types supported by Deployment Manager.
{ # A resource type supported by Deployment Manager.
"base": { # BaseType that describes a service-backed Type. # Base Type (configurable service) that backs this Type.
"collectionOverrides": [ # Allows resource handling overrides for specific collections
{ # CollectionOverride allows resource handling overrides for specific resources within a BaseType
"collection": "A String", # The collection that identifies this resource within its service.
"methodMap": { # Deployment Manager will call these methods during the events of creation/deletion/update/get/setIamPolicy # Custom verb method mappings to support unordered list API mappings.
"create": "A String", # The action identifier for the create method to be used for this collection
"delete": "A String", # The action identifier for the delete method to be used for this collection
"get": "A String", # The action identifier for the get method to be used for this collection
"setIamPolicy": "A String", # The action identifier for the setIamPolicy method to be used for this collection
"update": "A String", # The action identifier for the update method to be used for this collection
},
"options": { # Options allows customized resource handling by Deployment Manager. # The options to apply to this resource-level override
"asyncOptions": [ # Options regarding how to thread async requests.
{ # Async options that determine when a resource should finish.
"methodMatch": "A String", # Method regex where this policy will apply.
"pollingOptions": { # Deployment manager will poll instances for this API resource setting a RUNNING state, and blocking until polling conditions tell whether the resource is completed or failed.
"diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user.
{
"field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic.
"level": "A String", # Level to record this diagnostic.
},
],
"failCondition": "A String", # JsonPath expression that determines if the request failed.
"finishCondition": "A String", # JsonPath expression that determines if the request is completed.
"pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll.
"targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource.
},
},
],
"inputMappings": [ # The mappings that apply for requests.
{ # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API.
"fieldName": "A String", # The name of the field that is going to be injected.
"location": "A String", # The location where this mapping applies.
"methodMatch": "A String", # Regex to evaluate on method to decide if input applies.
"value": "A String", # A jsonPath expression to select an element.
},
],
"nameProperty": "A String", # The json path to the field in the resource JSON body into which the resource name should be mapped. Leaving this empty indicates that there should be no mapping performed.
"validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource.
"schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors.
"undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request.
},
},
},
],
"credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Credential used when interacting with this type.
"basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.
"password": "A String",
"user": "A String",
},
"serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.
"email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com
},
"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.
},
"descriptorUrl": "A String", # Descriptor Url for the this type.
"options": { # Options allows customized resource handling by Deployment Manager. # Options to apply when handling any resources in this service.
"asyncOptions": [ # Options regarding how to thread async requests.
{ # Async options that determine when a resource should finish.
"methodMatch": "A String", # Method regex where this policy will apply.
"pollingOptions": { # Deployment manager will poll instances for this API resource setting a RUNNING state, and blocking until polling conditions tell whether the resource is completed or failed.
"diagnostics": [ # An array of diagnostics to be collected by Deployment Manager, these diagnostics will be displayed to the user.
{
"field": "A String", # JsonPath expression on the resource that if non empty, indicates that this field needs to be extracted as a diagnostic.
"level": "A String", # Level to record this diagnostic.
},
],
"failCondition": "A String", # JsonPath expression that determines if the request failed.
"finishCondition": "A String", # JsonPath expression that determines if the request is completed.
"pollingLink": "A String", # JsonPath expression that evaluates to string, it indicates where to poll.
"targetLink": "A String", # JsonPath expression, after polling is completed, indicates where to fetch the resource.
},
},
],
"inputMappings": [ # The mappings that apply for requests.
{ # InputMapping creates a 'virtual' property that will be injected into the properties before sending the request to the underlying API.
"fieldName": "A String", # The name of the field that is going to be injected.
"location": "A String", # The location where this mapping applies.
"methodMatch": "A String", # Regex to evaluate on method to decide if input applies.
"value": "A String", # A jsonPath expression to select an element.
},
],
"nameProperty": "A String", # The json path to the field in the resource JSON body into which the resource name should be mapped. Leaving this empty indicates that there should be no mapping performed.
"validationOptions": { # Options for how to validate and process properties on a resource. # Options for how to validate and process properties on a resource.
"schemaValidation": "A String", # Customize how deployment manager will validate the resource against schema errors.
"undeclaredProperties": "A String", # Specify what to do with extra properties when executing a request.
},
},
},
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
"id": "A String",
"insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.
"labels": [ # Map of One Platform labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.
{ # Label object for Types
"key": "A String", # Key of the label
"value": "A String", # Value of the label
},
],
"name": "A String", # Name of the type.
"operation": { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period. # Output only. The Operation that most recently ran, or is currently running, on this type.
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"arguments": [ # [Output Only] Optional error details WARNING: DO NOT MAKE VISIBLE This is for internal use-only (like componentization) (thus the visibility "none") and in case of public exposure it is strongly recommended to follow pattern of: https://aip.dev/193 and expose as details field.
"A String",
],
"code": "A String", # [Output Only] The error type identifier for this error.
"debugInfo": { # Describes additional debugging info.
"detail": "A String", # Additional debugging information provided by the server.
"stackEntries": [ # The stack trace entries indicating where the error occurred.
"A String",
],
},
"errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
{
"errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
"domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
"metadata": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
"a_key": "A String",
},
"reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
},
"help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
"links": [ # URL(s) pointing to additional information on handling the current error.
{ # Describes a URL link.
"description": "A String", # Describes what the link offers.
"url": "A String", # The URL of the link.
},
],
},
"localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
"locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
"message": "A String", # The localized error message in the above locale.
},
"quotaInfo": { # Additional details for quota exceeded error for resource quota.
"dimensions": { # The map holding related quota dimensions.
"a_key": "A String",
},
"futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
"limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
"limitName": "A String", # The name of the quota limit.
"metricName": "A String", # The Compute Engine quota metric name.
"rolloutStatus": "A String", # Rollout status of the future quota limit.
},
},
],
"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
"message": "A String", # [Output Only] An optional, human-readable error message.
},
],
},
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
"instancesBulkInsertOperationMetadata": {
"perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
"a_key": {
"createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
"deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
"failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
"status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
"targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
},
},
},
"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
"name": "A String", # [Output Only] Name of the operation.
"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
"clientOperationId": "A String", # [Output Only] The client operation id.
"perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
"a_key": {
"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). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
"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.
},
"state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
},
},
},
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
"value": "A String", # [Output Only] A warning data value corresponding to the key.
},
],
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
},
"selfLink": "A String", # Output only. Server defined URL for the resource.
},
],
}
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.