Skip to content

Commit 5665787

Browse files
feat(composer): update the api
#### composer:v1 The following keys were added: - resources.projects.resources.locations.resources.environments.methods.restartWebServer (Total Keys: 12) - schemas.RestartWebServerRequest (Total Keys: 2)
1 parent 28bbc7a commit 5665787

File tree

4 files changed

+82
-4
lines changed

4 files changed

+82
-4
lines changed

docs/dyn/composer_v1.projects.locations.environments.html

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,9 @@ <h2>Instance Methods</h2>
128128
<p class="toc_element">
129129
<code><a href="#pollAirflowCommand">pollAirflowCommand(environment, body=None, x__xgafv=None)</a></code></p>
130130
<p class="firstline">Polls Airflow CLI command execution and fetches logs.</p>
131+
<p class="toc_element">
132+
<code><a href="#restartWebServer">restartWebServer(name, body=None, x__xgafv=None)</a></code></p>
133+
<p class="firstline">Restart Airflow web server.</p>
131134
<p class="toc_element">
132135
<code><a href="#saveSnapshot">saveSnapshot(environment, body=None, x__xgafv=None)</a></code></p>
133136
<p class="firstline">Creates a snapshots of a Cloud Composer environment. As a result of this operation, snapshot of environment's state is stored in a location specified in the SaveSnapshotRequest.</p>
@@ -1189,6 +1192,47 @@ <h3>Method Details</h3>
11891192
}</pre>
11901193
</div>
11911194

1195+
<div class="method">
1196+
<code class="details" id="restartWebServer">restartWebServer(name, body=None, x__xgafv=None)</code>
1197+
<pre>Restart Airflow web server.
1198+
1199+
Args:
1200+
name: string, Required. The resource name of the environment to restart the web server for, in the form: &quot;projects/{projectId}/locations/{locationId}/environments/{environmentId}&quot; (required)
1201+
body: object, The request body.
1202+
The object takes the form of:
1203+
1204+
{ # Restart Airflow web server.
1205+
}
1206+
1207+
x__xgafv: string, V1 error format.
1208+
Allowed values
1209+
1 - v1 error format
1210+
2 - v2 error format
1211+
1212+
Returns:
1213+
An object of the form:
1214+
1215+
{ # This resource represents a long-running operation that is the result of a network API call.
1216+
&quot;done&quot;: 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.
1217+
&quot;error&quot;: { # 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.
1218+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1219+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
1220+
{
1221+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1222+
},
1223+
],
1224+
&quot;message&quot;: &quot;A String&quot;, # 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.
1225+
},
1226+
&quot;metadata&quot;: { # 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.
1227+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1228+
},
1229+
&quot;name&quot;: &quot;A String&quot;, # 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}`.
1230+
&quot;response&quot;: { # 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`.
1231+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
1232+
},
1233+
}</pre>
1234+
</div>
1235+
11921236
<div class="method">
11931237
<code class="details" id="saveSnapshot">saveSnapshot(environment, body=None, x__xgafv=None)</code>
11941238
<pre>Creates a snapshots of a Cloud Composer environment. As a result of this operation, snapshot of environment&#x27;s state is stored in a location specified in the SaveSnapshotRequest.

docs/dyn/composer_v1beta1.projects.locations.environments.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1205,7 +1205,7 @@ <h3>Method Details</h3>
12051205
<pre>Restart Airflow web server.
12061206

12071207
Args:
1208-
name: string, The resource name of the environment to restart the web server for, in the form: &quot;projects/{projectId}/locations/{locationId}/environments/{environmentId}&quot; (required)
1208+
name: string, Required. The resource name of the environment to restart the web server for, in the form: &quot;projects/{projectId}/locations/{locationId}/environments/{environmentId}&quot; (required)
12091209
body: object, The request body.
12101210
The object takes the form of:
12111211

googleapiclient/discovery_cache/documents/composer.v1.json

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -646,6 +646,34 @@
646646
"https://www.googleapis.com/auth/cloud-platform"
647647
]
648648
},
649+
"restartWebServer": {
650+
"description": "Restart Airflow web server.",
651+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:restartWebServer",
652+
"httpMethod": "POST",
653+
"id": "composer.projects.locations.environments.restartWebServer",
654+
"parameterOrder": [
655+
"name"
656+
],
657+
"parameters": {
658+
"name": {
659+
"description": "Required. The resource name of the environment to restart the web server for, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
660+
"location": "path",
661+
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
662+
"required": true,
663+
"type": "string"
664+
}
665+
},
666+
"path": "v1/{+name}:restartWebServer",
667+
"request": {
668+
"$ref": "RestartWebServerRequest"
669+
},
670+
"response": {
671+
"$ref": "Operation"
672+
},
673+
"scopes": [
674+
"https://www.googleapis.com/auth/cloud-platform"
675+
]
676+
},
649677
"saveSnapshot": {
650678
"description": "Creates a snapshots of a Cloud Composer environment. As a result of this operation, snapshot of environment's state is stored in a location specified in the SaveSnapshotRequest.",
651679
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:saveSnapshot",
@@ -1188,7 +1216,7 @@
11881216
}
11891217
}
11901218
},
1191-
"revision": "20250303",
1219+
"revision": "20250513",
11921220
"rootUrl": "https://composer.googleapis.com/",
11931221
"schemas": {
11941222
"AirflowMetadataRetentionPolicyConfig": {
@@ -2331,6 +2359,12 @@
23312359
},
23322360
"type": "object"
23332361
},
2362+
"RestartWebServerRequest": {
2363+
"description": "Restart Airflow web server.",
2364+
"id": "RestartWebServerRequest",
2365+
"properties": {},
2366+
"type": "object"
2367+
},
23342368
"SaveSnapshotRequest": {
23352369
"description": "Request to create a snapshot of a Cloud Composer environment.",
23362370
"id": "SaveSnapshotRequest",

googleapiclient/discovery_cache/documents/composer.v1beta1.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -656,7 +656,7 @@
656656
],
657657
"parameters": {
658658
"name": {
659-
"description": "The resource name of the environment to restart the web server for, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
659+
"description": "Required. The resource name of the environment to restart the web server for, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
660660
"location": "path",
661661
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
662662
"required": true,
@@ -1216,7 +1216,7 @@
12161216
}
12171217
}
12181218
},
1219-
"revision": "20250303",
1219+
"revision": "20250513",
12201220
"rootUrl": "https://composer.googleapis.com/",
12211221
"schemas": {
12221222
"AirflowMetadataRetentionPolicyConfig": {

0 commit comments

Comments
 (0)