You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<pclass="firstline">Check if an upgrade operation on the environment will succeed. In case of problems detailed info can be found in the returned Operation.</p>
<pre>Check if an upgrade operation on the environment will succeed. In case of problems detailed info can be found in the returned Operation.
141
+
142
+
Args:
143
+
environment: string, Required. The resource name of the environment to check upgrade for, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" (required)
144
+
body: object, The request body.
145
+
The object takes the form of:
146
+
147
+
{ # Request to check whether image upgrade will succeed.
148
+
"imageVersion": "A String", # Optional. The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression `composer-([0-9]+(\.[0-9]+\.[0-9]+(-preview\.[0-9]+)?)?|latest)-airflow-([0-9]+(\.[0-9]+(\.[0-9]+)?)?)`. When used as input, the server also checks if the provided version is supported and denies the request for an unsupported version. The Cloud Composer portion of the image version is a full [semantic version](https://semver.org), or an alias in the form of major version number or `latest`. When an alias is provided, the server replaces it with the current Cloud Composer version that satisfies the alias. The Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. When an alias is provided, the server replaces it with the latest Apache Airflow version that satisfies the alias and is supported in the given Cloud Composer version. In all cases, the resolved image version is stored in the same field. See also [version list](/composer/docs/concepts/versioning/composer-versions) and [versioning overview](/composer/docs/concepts/versioning/composer-versioning-overview).
149
+
}
150
+
151
+
x__xgafv: string, V1 error format.
152
+
Allowed values
153
+
1 - v1 error format
154
+
2 - v2 error format
155
+
156
+
Returns:
157
+
An object of the form:
158
+
159
+
{ # This resource represents a long-running operation that is the result of a network API call.
160
+
"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.
161
+
"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.
162
+
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
163
+
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
164
+
{
165
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
166
+
},
167
+
],
168
+
"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.
169
+
},
170
+
"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.
171
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
172
+
},
173
+
"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}`.
174
+
"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`.
175
+
"a_key": "", # Properties of the object. Contains field @type with type URL.
Copy file name to clipboardExpand all lines: googleapiclient/discovery_cache/documents/composer.v1.json
+40-1Lines changed: 40 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -111,6 +111,34 @@
111
111
"resources": {
112
112
"environments": {
113
113
"methods": {
114
+
"checkUpgrade": {
115
+
"description": "Check if an upgrade operation on the environment will succeed. In case of problems detailed info can be found in the returned Operation.",
"description": "Required. The resource name of the environment to check upgrade for, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
"description": "Request to check whether image upgrade will succeed.",
1015
+
"id": "CheckUpgradeRequest",
1016
+
"properties": {
1017
+
"imageVersion": {
1018
+
"description": "Optional. The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression `composer-([0-9]+(\\.[0-9]+\\.[0-9]+(-preview\\.[0-9]+)?)?|latest)-airflow-([0-9]+(\\.[0-9]+(\\.[0-9]+)?)?)`. When used as input, the server also checks if the provided version is supported and denies the request for an unsupported version. The Cloud Composer portion of the image version is a full [semantic version](https://semver.org), or an alias in the form of major version number or `latest`. When an alias is provided, the server replaces it with the current Cloud Composer version that satisfies the alias. The Apache Airflow portion of the image version is a full semantic version that points to one of the supported Apache Airflow versions, or an alias in the form of only major or major.minor versions specified. When an alias is provided, the server replaces it with the latest Apache Airflow version that satisfies the alias and is supported in the given Cloud Composer version. In all cases, the resolved image version is stored in the same field. See also [version list](/composer/docs/concepts/versioning/composer-versions) and [versioning overview](/composer/docs/concepts/versioning/composer-versioning-overview).",
1019
+
"type": "string"
1020
+
}
1021
+
},
1022
+
"type": "object"
1023
+
},
985
1024
"CheckUpgradeResponse": {
986
1025
"description": "Message containing information about the result of an upgrade check operation.",
0 commit comments