cancel(name, body=None, x__xgafv=None)
-Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
+Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
Close httplib2 connections.
@@ -95,7 +95,7 @@cancel(name, body=None, x__xgafv=None)
- Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. +Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. Args: name: string, The name of the operation resource to be cancelled. (required) diff --git a/docs/dyn/config_v1.projects.locations.previews.html b/docs/dyn/config_v1.projects.locations.previews.html index f1636173d3..f4fc7dcf2c 100644 --- a/docs/dyn/config_v1.projects.locations.previews.html +++ b/docs/dyn/config_v1.projects.locations.previews.html @@ -148,15 +148,15 @@Method Details
"ref": "A String", # Optional. Git reference (e.g. branch or tag). "repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git' }, - "inputValues": { # Input variable values for the Terraform blueprint. + "inputValues": { # Optional. Input variable values for the Terraform blueprint. "a_key": { # A Terraform input variable. - "inputValue": "", # Input variable value. + "inputValue": "", # Optional. Input variable value. }, }, }, "tfErrors": [ # Output only. Summary of errors encountered during Terraform preview. It has a size limit of 10, i.e. only top 10 errors will be summarized here. { # Errors encountered during actuation using Terraform - "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). # Original error response from underlying Google API, if 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). # Output only. Original error response from underlying Google API, if available. "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. { @@ -322,15 +322,15 @@Method Details
"ref": "A String", # Optional. Git reference (e.g. branch or tag). "repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git' }, - "inputValues": { # Input variable values for the Terraform blueprint. + "inputValues": { # Optional. Input variable values for the Terraform blueprint. "a_key": { # A Terraform input variable. - "inputValue": "", # Input variable value. + "inputValue": "", # Optional. Input variable value. }, }, }, "tfErrors": [ # Output only. Summary of errors encountered during Terraform preview. It has a size limit of 10, i.e. only top 10 errors will be summarized here. { # Errors encountered during actuation using Terraform - "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). # Original error response from underlying Google API, if 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). # Output only. Original error response from underlying Google API, if available. "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. { @@ -370,7 +370,7 @@Method Details
{ # A response to a `ListPreviews` call. Contains a list of Previews. "nextPageToken": "A String", # Token to be supplied to the next ListPreviews request via `page_token` to obtain the next set of results. - "previews": [ # List of Previewss. + "previews": [ # List of Previews. { # A preview represents a set of actions Infra Manager would perform to move the resources towards the desired state as specified in the configuration. "annotations": { # Optional. Arbitrary key-value metadata storage e.g. to help client tools identifiy preview during automation. See https://google.aip.dev/148#annotations for details on format and size limitations. "a_key": "A String", @@ -409,15 +409,15 @@Method Details
"ref": "A String", # Optional. Git reference (e.g. branch or tag). "repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git' }, - "inputValues": { # Input variable values for the Terraform blueprint. + "inputValues": { # Optional. Input variable values for the Terraform blueprint. "a_key": { # A Terraform input variable. - "inputValue": "", # Input variable value. + "inputValue": "", # Optional. Input variable value. }, }, }, "tfErrors": [ # Output only. Summary of errors encountered during Terraform preview. It has a size limit of 10, i.e. only top 10 errors will be summarized here. { # Errors encountered during actuation using Terraform - "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). # Original error response from underlying Google API, if 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). # Output only. Original error response from underlying Google API, if available. "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. { diff --git a/googleapiclient/discovery_cache/documents/config.v1.json b/googleapiclient/discovery_cache/documents/config.v1.json index c5969f1736..ca1014c791 100644 --- a/googleapiclient/discovery_cache/documents/config.v1.json +++ b/googleapiclient/discovery_cache/documents/config.v1.json @@ -816,7 +816,7 @@ "operations": { "methods": { "cancel": { -"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "config.projects.locations.operations.cancel", @@ -1187,7 +1187,7 @@ } } }, -"revision": "20241106", +"revision": "20241211", "rootUrl": "https://config.googleapis.com/", "schemas": { "ApplyResults": { @@ -1708,7 +1708,7 @@ "type": "string" }, "previews": { -"description": "List of Previewss.", +"description": "List of Previews.", "items": { "$ref": "Preview" }, @@ -1733,7 +1733,7 @@ "type": "string" }, "resources": { -"description": "List of Resourcess.", +"description": "List of Resources.", "items": { "$ref": "Resource" }, @@ -1939,7 +1939,7 @@ "readOnly": true }, "requestedCancellation": { -"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", +"description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "readOnly": true, "type": "boolean" }, @@ -2556,7 +2556,7 @@ "additionalProperties": { "$ref": "TerraformVariable" }, -"description": "Input variable values for the Terraform blueprint.", +"description": "Optional. Input variable values for the Terraform blueprint.", "type": "object" } }, @@ -2568,7 +2568,8 @@ "properties": { "error": { "$ref": "Status", -"description": "Original error response from underlying Google API, if available." +"description": "Output only. Original error response from underlying Google API, if available.", +"readOnly": true }, "errorDescription": { "description": "A human-readable error description.", @@ -2606,7 +2607,7 @@ "id": "TerraformVariable", "properties": { "inputValue": { -"description": "Input variable value.", +"description": "Optional. Input variable value.", "type": "any" } },