Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 8f8081d

Browse files
committedMay 24, 2023
feat(composer): update the api
#### composer:v1 The following keys were added: - resources.projects.resources.locations.resources.environments.methods.databaseFailover (Total Keys: 12) - resources.projects.resources.locations.resources.environments.methods.executeAirflowCommand (Total Keys: 12) - resources.projects.resources.locations.resources.environments.methods.fetchDatabaseProperties (Total Keys: 11) - resources.projects.resources.locations.resources.environments.methods.pollAirflowCommand (Total Keys: 12) - resources.projects.resources.locations.resources.environments.methods.stopAirflowCommand (Total Keys: 12) - schemas.DatabaseFailoverRequest (Total Keys: 2) - schemas.DatabaseFailoverResponse (Total Keys: 2) - schemas.EnvironmentConfig.properties.resilienceMode.type (Total Keys: 1) - schemas.ExecuteAirflowCommandRequest (Total Keys: 6) - schemas.ExecuteAirflowCommandResponse (Total Keys: 6) - schemas.ExitInfo (Total Keys: 5) - schemas.FetchDatabasePropertiesResponse (Total Keys: 5) - schemas.Line (Total Keys: 3) - schemas.PollAirflowCommandRequest (Total Keys: 5) - schemas.PollAirflowCommandResponse (Total Keys: 6) - schemas.StopAirflowCommandRequest (Total Keys: 6) - schemas.StopAirflowCommandResponse (Total Keys: 5) #### composer:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.environments.methods.databaseFailover (Total Keys: 12) - resources.projects.resources.locations.resources.environments.methods.executeAirflowCommand (Total Keys: 12) - resources.projects.resources.locations.resources.environments.methods.fetchDatabaseProperties (Total Keys: 11) - resources.projects.resources.locations.resources.environments.methods.pollAirflowCommand (Total Keys: 12) - resources.projects.resources.locations.resources.environments.methods.stopAirflowCommand (Total Keys: 12) - schemas.DatabaseFailoverRequest (Total Keys: 2) - schemas.DatabaseFailoverResponse (Total Keys: 2) - schemas.EnvironmentConfig.properties.resilienceMode.type (Total Keys: 1) - schemas.ExecuteAirflowCommandRequest (Total Keys: 6) - schemas.FetchDatabasePropertiesResponse (Total Keys: 5) - schemas.PollAirflowCommandRequest (Total Keys: 5) - schemas.StopAirflowCommandRequest (Total Keys: 6) - schemas.StopAirflowCommandResponse (Total Keys: 5)
1 parent 9fa213d commit 8f8081d

File tree

4 files changed

+991
-6
lines changed

4 files changed

+991
-6
lines changed
 

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

+185
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,18 @@ <h2>Instance Methods</h2>
8080
<p class="toc_element">
8181
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
8282
<p class="firstline">Create a new environment.</p>
83+
<p class="toc_element">
84+
<code><a href="#databaseFailover">databaseFailover(environment, body=None, x__xgafv=None)</a></code></p>
85+
<p class="firstline">Triggers database failover (only for highly resilient environments).</p>
8386
<p class="toc_element">
8487
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
8588
<p class="firstline">Delete an environment.</p>
89+
<p class="toc_element">
90+
<code><a href="#executeAirflowCommand">executeAirflowCommand(environment, body=None, x__xgafv=None)</a></code></p>
91+
<p class="firstline">Executes Airflow CLI command.</p>
92+
<p class="toc_element">
93+
<code><a href="#fetchDatabaseProperties">fetchDatabaseProperties(environment, x__xgafv=None)</a></code></p>
94+
<p class="firstline">Fetches database properties.</p>
8695
<p class="toc_element">
8796
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
8897
<p class="firstline">Get an existing environment.</p>
@@ -98,9 +107,15 @@ <h2>Instance Methods</h2>
98107
<p class="toc_element">
99108
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
100109
<p class="firstline">Update an environment.</p>
110+
<p class="toc_element">
111+
<code><a href="#pollAirflowCommand">pollAirflowCommand(environment, body=None, x__xgafv=None)</a></code></p>
112+
<p class="firstline">Polls Airflow CLI command execution and fetches logs.</p>
101113
<p class="toc_element">
102114
<code><a href="#saveSnapshot">saveSnapshot(environment, body=None, x__xgafv=None)</a></code></p>
103115
<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>
116+
<p class="toc_element">
117+
<code><a href="#stopAirflowCommand">stopAirflowCommand(environment, body=None, x__xgafv=None)</a></code></p>
118+
<p class="firstline">Stops Airflow CLI command execution.</p>
104119
<h3>Method Details</h3>
105120
<div class="method">
106121
<code class="details" id="close">close()</code>
@@ -192,6 +207,7 @@ <h3>Method Details</h3>
192207
&quot;timeZone&quot;: &quot;A String&quot;, # Optional. Time zone that sets the context to interpret snapshot_creation_schedule.
193208
},
194209
},
210+
&quot;resilienceMode&quot;: &quot;A String&quot;, # Optional. Resilience mode of the Cloud Composer Environment. This field is supported for Cloud Composer environments in versions composer-2.2.0-airflow-*.*.* and newer.
195211
&quot;softwareConfig&quot;: { # Specifies the selection and configuration of software inside the environment. # The configuration settings for software inside the environment.
196212
&quot;airflowConfigOverrides&quot;: { # Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example &quot;core-dags_are_paused_at_creation&quot;. Section names must not contain hyphens (&quot;-&quot;), opening square brackets (&quot;[&quot;), or closing square brackets (&quot;]&quot;). The property name must not be empty and must not contain an equals sign (&quot;=&quot;) or semicolon (&quot;;&quot;). Section and property names must not contain a period (&quot;.&quot;). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden.
197213
&quot;a_key&quot;: &quot;A String&quot;,
@@ -277,6 +293,47 @@ <h3>Method Details</h3>
277293
}</pre>
278294
</div>
279295

296+
<div class="method">
297+
<code class="details" id="databaseFailover">databaseFailover(environment, body=None, x__xgafv=None)</code>
298+
<pre>Triggers database failover (only for highly resilient environments).
299+
300+
Args:
301+
environment: string, Target environment: &quot;projects/{projectId}/locations/{locationId}/environments/{environmentId}&quot; (required)
302+
body: object, The request body.
303+
The object takes the form of:
304+
305+
{ # Request to trigger database failover (only for highly resilient environments).
306+
}
307+
308+
x__xgafv: string, V1 error format.
309+
Allowed values
310+
1 - v1 error format
311+
2 - v2 error format
312+
313+
Returns:
314+
An object of the form:
315+
316+
{ # This resource represents a long-running operation that is the result of a network API call.
317+
&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.
318+
&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.
319+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
320+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
321+
{
322+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
323+
},
324+
],
325+
&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.
326+
},
327+
&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.
328+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
329+
},
330+
&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}`.
331+
&quot;response&quot;: { # The normal response of the operation in case of success. 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`.
332+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
333+
},
334+
}</pre>
335+
</div>
336+
280337
<div class="method">
281338
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
282339
<pre>Delete an environment.
@@ -312,6 +369,60 @@ <h3>Method Details</h3>
312369
}</pre>
313370
</div>
314371

372+
<div class="method">
373+
<code class="details" id="executeAirflowCommand">executeAirflowCommand(environment, body=None, x__xgafv=None)</code>
374+
<pre>Executes Airflow CLI command.
375+
376+
Args:
377+
environment: string, The resource name of the environment in the form: &quot;projects/{projectId}/locations/{locationId}/environments/{environmentId}&quot;. (required)
378+
body: object, The request body.
379+
The object takes the form of:
380+
381+
{ # Execute Airflow Command request.
382+
&quot;command&quot;: &quot;A String&quot;, # Airflow command.
383+
&quot;parameters&quot;: [ # Parameters for the Airflow command/subcommand as an array of arguments. It may contain positional arguments like `[&quot;my-dag-id&quot;]`, key-value parameters like `[&quot;--foo=bar&quot;]` or `[&quot;--foo&quot;,&quot;bar&quot;]`, or other flags like `[&quot;-f&quot;]`.
384+
&quot;A String&quot;,
385+
],
386+
&quot;subcommand&quot;: &quot;A String&quot;, # Airflow subcommand.
387+
}
388+
389+
x__xgafv: string, V1 error format.
390+
Allowed values
391+
1 - v1 error format
392+
2 - v2 error format
393+
394+
Returns:
395+
An object of the form:
396+
397+
{ # Response to ExecuteAirflowCommandRequest.
398+
&quot;error&quot;: &quot;A String&quot;, # Error message. Empty if there was no error.
399+
&quot;executionId&quot;: &quot;A String&quot;, # The unique ID of the command execution for polling.
400+
&quot;pod&quot;: &quot;A String&quot;, # The name of the pod where the command is executed.
401+
&quot;podNamespace&quot;: &quot;A String&quot;, # The namespace of the pod where the command is executed.
402+
}</pre>
403+
</div>
404+
405+
<div class="method">
406+
<code class="details" id="fetchDatabaseProperties">fetchDatabaseProperties(environment, x__xgafv=None)</code>
407+
<pre>Fetches database properties.
408+
409+
Args:
410+
environment: string, Required. The resource name of the environment, in the form: &quot;projects/{projectId}/locations/{locationId}/environments/{environmentId}&quot; (required)
411+
x__xgafv: string, V1 error format.
412+
Allowed values
413+
1 - v1 error format
414+
2 - v2 error format
415+
416+
Returns:
417+
An object of the form:
418+
419+
{ # Response for FetchDatabasePropertiesRequest.
420+
&quot;isFailoverReplicaAvailable&quot;: True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only fail over to the failover replica when the status is true.
421+
&quot;primaryGceZone&quot;: &quot;A String&quot;, # The Compute Engine zone that the instance is currently serving from.
422+
&quot;secondaryGceZone&quot;: &quot;A String&quot;, # The Compute Engine zone that the failover instance is currently serving from for a regional Cloud SQL instance.
423+
}</pre>
424+
</div>
425+
315426
<div class="method">
316427
<code class="details" id="get">get(name, x__xgafv=None)</code>
317428
<pre>Get an existing environment.
@@ -402,6 +513,7 @@ <h3>Method Details</h3>
402513
&quot;timeZone&quot;: &quot;A String&quot;, # Optional. Time zone that sets the context to interpret snapshot_creation_schedule.
403514
},
404515
},
516+
&quot;resilienceMode&quot;: &quot;A String&quot;, # Optional. Resilience mode of the Cloud Composer Environment. This field is supported for Cloud Composer environments in versions composer-2.2.0-airflow-*.*.* and newer.
405517
&quot;softwareConfig&quot;: { # Specifies the selection and configuration of software inside the environment. # The configuration settings for software inside the environment.
406518
&quot;airflowConfigOverrides&quot;: { # Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example &quot;core-dags_are_paused_at_creation&quot;. Section names must not contain hyphens (&quot;-&quot;), opening square brackets (&quot;[&quot;), or closing square brackets (&quot;]&quot;). The property name must not be empty and must not contain an equals sign (&quot;=&quot;) or semicolon (&quot;;&quot;). Section and property names must not contain a period (&quot;.&quot;). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden.
407519
&quot;a_key&quot;: &quot;A String&quot;,
@@ -553,6 +665,7 @@ <h3>Method Details</h3>
553665
&quot;timeZone&quot;: &quot;A String&quot;, # Optional. Time zone that sets the context to interpret snapshot_creation_schedule.
554666
},
555667
},
668+
&quot;resilienceMode&quot;: &quot;A String&quot;, # Optional. Resilience mode of the Cloud Composer Environment. This field is supported for Cloud Composer environments in versions composer-2.2.0-airflow-*.*.* and newer.
556669
&quot;softwareConfig&quot;: { # Specifies the selection and configuration of software inside the environment. # The configuration settings for software inside the environment.
557670
&quot;airflowConfigOverrides&quot;: { # Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example &quot;core-dags_are_paused_at_creation&quot;. Section names must not contain hyphens (&quot;-&quot;), opening square brackets (&quot;[&quot;), or closing square brackets (&quot;]&quot;). The property name must not be empty and must not contain an equals sign (&quot;=&quot;) or semicolon (&quot;;&quot;). Section and property names must not contain a period (&quot;.&quot;). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden.
558671
&quot;a_key&quot;: &quot;A String&quot;,
@@ -758,6 +871,7 @@ <h3>Method Details</h3>
758871
&quot;timeZone&quot;: &quot;A String&quot;, # Optional. Time zone that sets the context to interpret snapshot_creation_schedule.
759872
},
760873
},
874+
&quot;resilienceMode&quot;: &quot;A String&quot;, # Optional. Resilience mode of the Cloud Composer Environment. This field is supported for Cloud Composer environments in versions composer-2.2.0-airflow-*.*.* and newer.
761875
&quot;softwareConfig&quot;: { # Specifies the selection and configuration of software inside the environment. # The configuration settings for software inside the environment.
762876
&quot;airflowConfigOverrides&quot;: { # Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example &quot;core-dags_are_paused_at_creation&quot;. Section names must not contain hyphens (&quot;-&quot;), opening square brackets (&quot;[&quot;), or closing square brackets (&quot;]&quot;). The property name must not be empty and must not contain an equals sign (&quot;=&quot;) or semicolon (&quot;;&quot;). Section and property names must not contain a period (&quot;.&quot;). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden.
763877
&quot;a_key&quot;: &quot;A String&quot;,
@@ -844,6 +958,45 @@ <h3>Method Details</h3>
844958
}</pre>
845959
</div>
846960

961+
<div class="method">
962+
<code class="details" id="pollAirflowCommand">pollAirflowCommand(environment, body=None, x__xgafv=None)</code>
963+
<pre>Polls Airflow CLI command execution and fetches logs.
964+
965+
Args:
966+
environment: string, The resource name of the environment in the form: &quot;projects/{projectId}/locations/{locationId}/environments/{environmentId}&quot; (required)
967+
body: object, The request body.
968+
The object takes the form of:
969+
970+
{ # Poll Airflow Command request.
971+
&quot;executionId&quot;: &quot;A String&quot;, # The unique ID of the command execution.
972+
&quot;nextLineNumber&quot;: 42, # Line number from which new logs should be fetched.
973+
&quot;pod&quot;: &quot;A String&quot;, # The name of the pod where the command is executed.
974+
&quot;podNamespace&quot;: &quot;A String&quot;, # The namespace of the pod where the command is executed.
975+
}
976+
977+
x__xgafv: string, V1 error format.
978+
Allowed values
979+
1 - v1 error format
980+
2 - v2 error format
981+
982+
Returns:
983+
An object of the form:
984+
985+
{ # Response to PollAirflowCommandRequest.
986+
&quot;exitInfo&quot;: { # Information about how a command ended. # The result exit status of the command.
987+
&quot;error&quot;: &quot;A String&quot;, # Error message. Empty if there was no error.
988+
&quot;exitCode&quot;: 42, # The exit code from the command execution.
989+
},
990+
&quot;output&quot;: [ # Output from the command execution. It may not contain the full output and the caller may need to poll for more lines.
991+
{ # Contains information about a single line from logs.
992+
&quot;content&quot;: &quot;A String&quot;, # Text content of the log line.
993+
&quot;lineNumber&quot;: 42, # Number of the line.
994+
},
995+
],
996+
&quot;outputEnd&quot;: True or False, # Whether the command execution has finished and there is no more output.
997+
}</pre>
998+
</div>
999+
8471000
<div class="method">
8481001
<code class="details" id="saveSnapshot">saveSnapshot(environment, body=None, x__xgafv=None)</code>
8491002
<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.
@@ -886,4 +1039,36 @@ <h3>Method Details</h3>
8861039
}</pre>
8871040
</div>
8881041

1042+
<div class="method">
1043+
<code class="details" id="stopAirflowCommand">stopAirflowCommand(environment, body=None, x__xgafv=None)</code>
1044+
<pre>Stops Airflow CLI command execution.
1045+
1046+
Args:
1047+
environment: string, The resource name of the environment in the form: &quot;projects/{projectId}/locations/{locationId}/environments/{environmentId}&quot;. (required)
1048+
body: object, The request body.
1049+
The object takes the form of:
1050+
1051+
{ # Stop Airflow Command request.
1052+
&quot;executionId&quot;: &quot;A String&quot;, # The unique ID of the command execution.
1053+
&quot;force&quot;: True or False, # If true, the execution is terminated forcefully (SIGKILL). If false, the execution is stopped gracefully, giving it time for cleanup.
1054+
&quot;pod&quot;: &quot;A String&quot;, # The name of the pod where the command is executed.
1055+
&quot;podNamespace&quot;: &quot;A String&quot;, # The namespace of the pod where the command is executed.
1056+
}
1057+
1058+
x__xgafv: string, V1 error format.
1059+
Allowed values
1060+
1 - v1 error format
1061+
2 - v2 error format
1062+
1063+
Returns:
1064+
An object of the form:
1065+
1066+
{ # Response to StopAirflowCommandRequest.
1067+
&quot;isDone&quot;: True or False, # Whether the execution is still running.
1068+
&quot;output&quot;: [ # Output message from stopping execution request.
1069+
&quot;A String&quot;,
1070+
],
1071+
}</pre>
1072+
</div>
1073+
8891074
</body></html>

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

+185
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,18 @@ <h2>Instance Methods</h2>
8383
<p class="toc_element">
8484
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
8585
<p class="firstline">Create a new environment.</p>
86+
<p class="toc_element">
87+
<code><a href="#databaseFailover">databaseFailover(environment, body=None, x__xgafv=None)</a></code></p>
88+
<p class="firstline">Triggers database failover (only for highly resilient environments).</p>
8689
<p class="toc_element">
8790
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
8891
<p class="firstline">Delete an environment.</p>
92+
<p class="toc_element">
93+
<code><a href="#executeAirflowCommand">executeAirflowCommand(environment, body=None, x__xgafv=None)</a></code></p>
94+
<p class="firstline">Executes Airflow CLI command.</p>
95+
<p class="toc_element">
96+
<code><a href="#fetchDatabaseProperties">fetchDatabaseProperties(environment, x__xgafv=None)</a></code></p>
97+
<p class="firstline">Fetches database properties.</p>
8998
<p class="toc_element">
9099
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
91100
<p class="firstline">Get an existing environment.</p>
@@ -101,12 +110,18 @@ <h2>Instance Methods</h2>
101110
<p class="toc_element">
102111
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
103112
<p class="firstline">Update an environment.</p>
113+
<p class="toc_element">
114+
<code><a href="#pollAirflowCommand">pollAirflowCommand(environment, body=None, x__xgafv=None)</a></code></p>
115+
<p class="firstline">Polls Airflow CLI command execution and fetches logs.</p>
104116
<p class="toc_element">
105117
<code><a href="#restartWebServer">restartWebServer(name, body=None, x__xgafv=None)</a></code></p>
106118
<p class="firstline">Restart Airflow web server.</p>
107119
<p class="toc_element">
108120
<code><a href="#saveSnapshot">saveSnapshot(environment, body=None, x__xgafv=None)</a></code></p>
109121
<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>
122+
<p class="toc_element">
123+
<code><a href="#stopAirflowCommand">stopAirflowCommand(environment, body=None, x__xgafv=None)</a></code></p>
124+
<p class="firstline">Stops Airflow CLI command execution.</p>
110125
<h3>Method Details</h3>
111126
<div class="method">
112127
<code class="details" id="checkUpgrade">checkUpgrade(environment, body=None, x__xgafv=None)</code>
@@ -241,6 +256,7 @@ <h3>Method Details</h3>
241256
&quot;timeZone&quot;: &quot;A String&quot;, # Optional. Time zone that sets the context to interpret snapshot_creation_schedule.
242257
},
243258
},
259+
&quot;resilienceMode&quot;: &quot;A String&quot;, # Optional. Resilience mode of the Cloud Composer Environment. This field is supported for Cloud Composer environments in versions composer-2.2.0-airflow-*.*.* and newer.
244260
&quot;softwareConfig&quot;: { # Specifies the selection and configuration of software inside the environment. # The configuration settings for software inside the environment.
245261
&quot;airflowConfigOverrides&quot;: { # Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example &quot;core-dags_are_paused_at_creation&quot;. Section names must not contain hyphens (&quot;-&quot;), opening square brackets (&quot;[&quot;), or closing square brackets (&quot;]&quot;). The property name must not be empty and must not contain an equals sign (&quot;=&quot;) or semicolon (&quot;;&quot;). Section and property names must not contain a period (&quot;.&quot;). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden.
246262
&quot;a_key&quot;: &quot;A String&quot;,
@@ -334,6 +350,47 @@ <h3>Method Details</h3>
334350
}</pre>
335351
</div>
336352

353+
<div class="method">
354+
<code class="details" id="databaseFailover">databaseFailover(environment, body=None, x__xgafv=None)</code>
355+
<pre>Triggers database failover (only for highly resilient environments).
356+
357+
Args:
358+
environment: string, Target environment: &quot;projects/{projectId}/locations/{locationId}/environments/{environmentId}&quot; (required)
359+
body: object, The request body.
360+
The object takes the form of:
361+
362+
{ # Request to trigger database failover (only for highly resilient environments).
363+
}
364+
365+
x__xgafv: string, V1 error format.
366+
Allowed values
367+
1 - v1 error format
368+
2 - v2 error format
369+
370+
Returns:
371+
An object of the form:
372+
373+
{ # This resource represents a long-running operation that is the result of a network API call.
374+
&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.
375+
&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.
376+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
377+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
378+
{
379+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
380+
},
381+
],
382+
&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.
383+
},
384+
&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.
385+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
386+
},
387+
&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}`.
388+
&quot;response&quot;: { # The normal response of the operation in case of success. 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`.
389+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
390+
},
391+
}</pre>
392+
</div>
393+
337394
<div class="method">
338395
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
339396
<pre>Delete an environment.
@@ -369,6 +426,60 @@ <h3>Method Details</h3>
369426
}</pre>
370427
</div>
371428

429+
<div class="method">
430+
<code class="details" id="executeAirflowCommand">executeAirflowCommand(environment, body=None, x__xgafv=None)</code>
431+
<pre>Executes Airflow CLI command.
432+
433+
Args:
434+
environment: string, The resource name of the environment in the form: &quot;projects/{projectId}/locations/{locationId}/environments/{environmentId}&quot;. (required)
435+
body: object, The request body.
436+
The object takes the form of:
437+
438+
{ # Execute Airflow Command request.
439+
&quot;command&quot;: &quot;A String&quot;, # Airflow command.
440+
&quot;parameters&quot;: [ # Parameters for the Airflow command/subcommand as an array of arguments. It may contain positional arguments like `[&quot;my-dag-id&quot;]`, key-value parameters like `[&quot;--foo=bar&quot;]` or `[&quot;--foo&quot;,&quot;bar&quot;]`, or other flags like `[&quot;-f&quot;]`.
441+
&quot;A String&quot;,
442+
],
443+
&quot;subcommand&quot;: &quot;A String&quot;, # Airflow subcommand.
444+
}
445+
446+
x__xgafv: string, V1 error format.
447+
Allowed values
448+
1 - v1 error format
449+
2 - v2 error format
450+
451+
Returns:
452+
An object of the form:
453+
454+
{ # Response to ExecuteAirflowCommandRequest.
455+
&quot;error&quot;: &quot;A String&quot;, # Error message. Empty if there was no error.
456+
&quot;executionId&quot;: &quot;A String&quot;, # The unique ID of the command execution for polling.
457+
&quot;pod&quot;: &quot;A String&quot;, # The name of the pod where the command is executed.
458+
&quot;podNamespace&quot;: &quot;A String&quot;, # The namespace of the pod where the command is executed.
459+
}</pre>
460+
</div>
461+
462+
<div class="method">
463+
<code class="details" id="fetchDatabaseProperties">fetchDatabaseProperties(environment, x__xgafv=None)</code>
464+
<pre>Fetches database properties.
465+
466+
Args:
467+
environment: string, Required. The resource name of the environment, in the form: &quot;projects/{projectId}/locations/{locationId}/environments/{environmentId}&quot; (required)
468+
x__xgafv: string, V1 error format.
469+
Allowed values
470+
1 - v1 error format
471+
2 - v2 error format
472+
473+
Returns:
474+
An object of the form:
475+
476+
{ # Response for FetchDatabasePropertiesRequest.
477+
&quot;isFailoverReplicaAvailable&quot;: True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only fail over to the failover replica when the status is true.
478+
&quot;primaryGceZone&quot;: &quot;A String&quot;, # The Compute Engine zone that the instance is currently serving from.
479+
&quot;secondaryGceZone&quot;: &quot;A String&quot;, # The Compute Engine zone that the failover instance is currently serving from for a regional Cloud SQL instance.
480+
}</pre>
481+
</div>
482+
372483
<div class="method">
373484
<code class="details" id="get">get(name, x__xgafv=None)</code>
374485
<pre>Get an existing environment.
@@ -460,6 +571,7 @@ <h3>Method Details</h3>
460571
&quot;timeZone&quot;: &quot;A String&quot;, # Optional. Time zone that sets the context to interpret snapshot_creation_schedule.
461572
},
462573
},
574+
&quot;resilienceMode&quot;: &quot;A String&quot;, # Optional. Resilience mode of the Cloud Composer Environment. This field is supported for Cloud Composer environments in versions composer-2.2.0-airflow-*.*.* and newer.
463575
&quot;softwareConfig&quot;: { # Specifies the selection and configuration of software inside the environment. # The configuration settings for software inside the environment.
464576
&quot;airflowConfigOverrides&quot;: { # Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example &quot;core-dags_are_paused_at_creation&quot;. Section names must not contain hyphens (&quot;-&quot;), opening square brackets (&quot;[&quot;), or closing square brackets (&quot;]&quot;). The property name must not be empty and must not contain an equals sign (&quot;=&quot;) or semicolon (&quot;;&quot;). Section and property names must not contain a period (&quot;.&quot;). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden.
465577
&quot;a_key&quot;: &quot;A String&quot;,
@@ -620,6 +732,7 @@ <h3>Method Details</h3>
620732
&quot;timeZone&quot;: &quot;A String&quot;, # Optional. Time zone that sets the context to interpret snapshot_creation_schedule.
621733
},
622734
},
735+
&quot;resilienceMode&quot;: &quot;A String&quot;, # Optional. Resilience mode of the Cloud Composer Environment. This field is supported for Cloud Composer environments in versions composer-2.2.0-airflow-*.*.* and newer.
623736
&quot;softwareConfig&quot;: { # Specifies the selection and configuration of software inside the environment. # The configuration settings for software inside the environment.
624737
&quot;airflowConfigOverrides&quot;: { # Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example &quot;core-dags_are_paused_at_creation&quot;. Section names must not contain hyphens (&quot;-&quot;), opening square brackets (&quot;[&quot;), or closing square brackets (&quot;]&quot;). The property name must not be empty and must not contain an equals sign (&quot;=&quot;) or semicolon (&quot;;&quot;). Section and property names must not contain a period (&quot;.&quot;). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden.
625738
&quot;a_key&quot;: &quot;A String&quot;,
@@ -834,6 +947,7 @@ <h3>Method Details</h3>
834947
&quot;timeZone&quot;: &quot;A String&quot;, # Optional. Time zone that sets the context to interpret snapshot_creation_schedule.
835948
},
836949
},
950+
&quot;resilienceMode&quot;: &quot;A String&quot;, # Optional. Resilience mode of the Cloud Composer Environment. This field is supported for Cloud Composer environments in versions composer-2.2.0-airflow-*.*.* and newer.
837951
&quot;softwareConfig&quot;: { # Specifies the selection and configuration of software inside the environment. # The configuration settings for software inside the environment.
838952
&quot;airflowConfigOverrides&quot;: { # Optional. Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example &quot;core-dags_are_paused_at_creation&quot;. Section names must not contain hyphens (&quot;-&quot;), opening square brackets (&quot;[&quot;), or closing square brackets (&quot;]&quot;). The property name must not be empty and must not contain an equals sign (&quot;=&quot;) or semicolon (&quot;;&quot;). Section and property names must not contain a period (&quot;.&quot;). Apache Airflow configuration property names must be written in [snake_case](https://en.wikipedia.org/wiki/Snake_case). Property values can contain any character, and can be written in any lower/upper case format. Certain Apache Airflow configuration property values are [blocked](/composer/docs/concepts/airflow-configurations), and cannot be overridden.
839953
&quot;a_key&quot;: &quot;A String&quot;,
@@ -928,6 +1042,45 @@ <h3>Method Details</h3>
9281042
}</pre>
9291043
</div>
9301044

1045+
<div class="method">
1046+
<code class="details" id="pollAirflowCommand">pollAirflowCommand(environment, body=None, x__xgafv=None)</code>
1047+
<pre>Polls Airflow CLI command execution and fetches logs.
1048+
1049+
Args:
1050+
environment: string, The resource name of the environment in the form: &quot;projects/{projectId}/locations/{locationId}/environments/{environmentId}&quot; (required)
1051+
body: object, The request body.
1052+
The object takes the form of:
1053+
1054+
{ # Poll Airflow Command request.
1055+
&quot;executionId&quot;: &quot;A String&quot;, # The unique ID of the command execution.
1056+
&quot;nextLineNumber&quot;: 42, # Line number from which new logs should be fetched.
1057+
&quot;pod&quot;: &quot;A String&quot;, # The name of the pod where the command is executed.
1058+
&quot;podNamespace&quot;: &quot;A String&quot;, # The namespace of the pod where the command is executed.
1059+
}
1060+
1061+
x__xgafv: string, V1 error format.
1062+
Allowed values
1063+
1 - v1 error format
1064+
2 - v2 error format
1065+
1066+
Returns:
1067+
An object of the form:
1068+
1069+
{ # Response to PollAirflowCommandRequest.
1070+
&quot;exitInfo&quot;: { # Information about how a command ended. # The result exit status of the command.
1071+
&quot;error&quot;: &quot;A String&quot;, # Error message. Empty if there was no error.
1072+
&quot;exitCode&quot;: 42, # The exit code from the command execution.
1073+
},
1074+
&quot;output&quot;: [ # Output from the command execution. It may not contain the full output and the caller may need to poll for more lines.
1075+
{ # Contains information about a single line from logs.
1076+
&quot;content&quot;: &quot;A String&quot;, # Text content of the log line.
1077+
&quot;lineNumber&quot;: 42, # Number of the line.
1078+
},
1079+
],
1080+
&quot;outputEnd&quot;: True or False, # Whether the command execution has finished and there is no more output.
1081+
}</pre>
1082+
</div>
1083+
9311084
<div class="method">
9321085
<code class="details" id="restartWebServer">restartWebServer(name, body=None, x__xgafv=None)</code>
9331086
<pre>Restart Airflow web server.
@@ -1011,4 +1164,36 @@ <h3>Method Details</h3>
10111164
}</pre>
10121165
</div>
10131166

1167+
<div class="method">
1168+
<code class="details" id="stopAirflowCommand">stopAirflowCommand(environment, body=None, x__xgafv=None)</code>
1169+
<pre>Stops Airflow CLI command execution.
1170+
1171+
Args:
1172+
environment: string, The resource name of the environment in the form: &quot;projects/{projectId}/locations/{locationId}/environments/{environmentId}&quot;. (required)
1173+
body: object, The request body.
1174+
The object takes the form of:
1175+
1176+
{ # Stop Airflow Command request.
1177+
&quot;executionId&quot;: &quot;A String&quot;, # The unique ID of the command execution.
1178+
&quot;force&quot;: True or False, # If true, the execution is terminated forcefully (SIGKILL). If false, the execution is stopped gracefully, giving it time for cleanup.
1179+
&quot;pod&quot;: &quot;A String&quot;, # The name of the pod where the command is executed.
1180+
&quot;podNamespace&quot;: &quot;A String&quot;, # The namespace of the pod where the command is executed.
1181+
}
1182+
1183+
x__xgafv: string, V1 error format.
1184+
Allowed values
1185+
1 - v1 error format
1186+
2 - v2 error format
1187+
1188+
Returns:
1189+
An object of the form:
1190+
1191+
{ # Response to StopAirflowCommandRequest.
1192+
&quot;isDone&quot;: True or False, # Whether the execution is still running.
1193+
&quot;output&quot;: [ # Output message from stopping execution request.
1194+
&quot;A String&quot;,
1195+
],
1196+
}</pre>
1197+
</div>
1198+
10141199
</body></html>

‎googleapiclient/discovery_cache/documents/composer.v1.json

+349-3
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,34 @@
139139
"https://www.googleapis.com/auth/cloud-platform"
140140
]
141141
},
142+
"databaseFailover": {
143+
"description": "Triggers database failover (only for highly resilient environments).",
144+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:databaseFailover",
145+
"httpMethod": "POST",
146+
"id": "composer.projects.locations.environments.databaseFailover",
147+
"parameterOrder": [
148+
"environment"
149+
],
150+
"parameters": {
151+
"environment": {
152+
"description": "Target environment: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
153+
"location": "path",
154+
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
155+
"required": true,
156+
"type": "string"
157+
}
158+
},
159+
"path": "v1/{+environment}:databaseFailover",
160+
"request": {
161+
"$ref": "DatabaseFailoverRequest"
162+
},
163+
"response": {
164+
"$ref": "Operation"
165+
},
166+
"scopes": [
167+
"https://www.googleapis.com/auth/cloud-platform"
168+
]
169+
},
142170
"delete": {
143171
"description": "Delete an environment.",
144172
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}",
@@ -164,6 +192,59 @@
164192
"https://www.googleapis.com/auth/cloud-platform"
165193
]
166194
},
195+
"executeAirflowCommand": {
196+
"description": "Executes Airflow CLI command.",
197+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:executeAirflowCommand",
198+
"httpMethod": "POST",
199+
"id": "composer.projects.locations.environments.executeAirflowCommand",
200+
"parameterOrder": [
201+
"environment"
202+
],
203+
"parameters": {
204+
"environment": {
205+
"description": "The resource name of the environment in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\".",
206+
"location": "path",
207+
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
208+
"required": true,
209+
"type": "string"
210+
}
211+
},
212+
"path": "v1/{+environment}:executeAirflowCommand",
213+
"request": {
214+
"$ref": "ExecuteAirflowCommandRequest"
215+
},
216+
"response": {
217+
"$ref": "ExecuteAirflowCommandResponse"
218+
},
219+
"scopes": [
220+
"https://www.googleapis.com/auth/cloud-platform"
221+
]
222+
},
223+
"fetchDatabaseProperties": {
224+
"description": "Fetches database properties.",
225+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:fetchDatabaseProperties",
226+
"httpMethod": "GET",
227+
"id": "composer.projects.locations.environments.fetchDatabaseProperties",
228+
"parameterOrder": [
229+
"environment"
230+
],
231+
"parameters": {
232+
"environment": {
233+
"description": "Required. The resource name of the environment, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
234+
"location": "path",
235+
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
236+
"required": true,
237+
"type": "string"
238+
}
239+
},
240+
"path": "v1/{+environment}:fetchDatabaseProperties",
241+
"response": {
242+
"$ref": "FetchDatabasePropertiesResponse"
243+
},
244+
"scopes": [
245+
"https://www.googleapis.com/auth/cloud-platform"
246+
]
247+
},
167248
"get": {
168249
"description": "Get an existing environment.",
169250
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}",
@@ -287,6 +368,34 @@
287368
"https://www.googleapis.com/auth/cloud-platform"
288369
]
289370
},
371+
"pollAirflowCommand": {
372+
"description": "Polls Airflow CLI command execution and fetches logs.",
373+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:pollAirflowCommand",
374+
"httpMethod": "POST",
375+
"id": "composer.projects.locations.environments.pollAirflowCommand",
376+
"parameterOrder": [
377+
"environment"
378+
],
379+
"parameters": {
380+
"environment": {
381+
"description": "The resource name of the environment in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
382+
"location": "path",
383+
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
384+
"required": true,
385+
"type": "string"
386+
}
387+
},
388+
"path": "v1/{+environment}:pollAirflowCommand",
389+
"request": {
390+
"$ref": "PollAirflowCommandRequest"
391+
},
392+
"response": {
393+
"$ref": "PollAirflowCommandResponse"
394+
},
395+
"scopes": [
396+
"https://www.googleapis.com/auth/cloud-platform"
397+
]
398+
},
290399
"saveSnapshot": {
291400
"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.",
292401
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:saveSnapshot",
@@ -314,6 +423,34 @@
314423
"scopes": [
315424
"https://www.googleapis.com/auth/cloud-platform"
316425
]
426+
},
427+
"stopAirflowCommand": {
428+
"description": "Stops Airflow CLI command execution.",
429+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:stopAirflowCommand",
430+
"httpMethod": "POST",
431+
"id": "composer.projects.locations.environments.stopAirflowCommand",
432+
"parameterOrder": [
433+
"environment"
434+
],
435+
"parameters": {
436+
"environment": {
437+
"description": "The resource name of the environment in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\".",
438+
"location": "path",
439+
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
440+
"required": true,
441+
"type": "string"
442+
}
443+
},
444+
"path": "v1/{+environment}:stopAirflowCommand",
445+
"request": {
446+
"$ref": "StopAirflowCommandRequest"
447+
},
448+
"response": {
449+
"$ref": "StopAirflowCommandResponse"
450+
},
451+
"scopes": [
452+
"https://www.googleapis.com/auth/cloud-platform"
453+
]
317454
}
318455
}
319456
},
@@ -462,7 +599,7 @@
462599
}
463600
}
464601
},
465-
"revision": "20230407",
602+
"revision": "20230516",
466603
"rootUrl": "https://composer.googleapis.com/",
467604
"schemas": {
468605
"AllowedIpRange": {
@@ -549,6 +686,18 @@
549686
},
550687
"type": "object"
551688
},
689+
"DatabaseFailoverRequest": {
690+
"description": "Request to trigger database failover (only for highly resilient environments).",
691+
"id": "DatabaseFailoverRequest",
692+
"properties": {},
693+
"type": "object"
694+
},
695+
"DatabaseFailoverResponse": {
696+
"description": "Response for DatabaseFailoverRequest.",
697+
"id": "DatabaseFailoverResponse",
698+
"properties": {},
699+
"type": "object"
700+
},
552701
"Date": {
553702
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
554703
"id": "Date",
@@ -714,6 +863,18 @@
714863
"$ref": "RecoveryConfig",
715864
"description": "Optional. The Recovery settings configuration of an environment. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer."
716865
},
866+
"resilienceMode": {
867+
"description": "Optional. Resilience mode of the Cloud Composer Environment. This field is supported for Cloud Composer environments in versions composer-2.2.0-airflow-*.*.* and newer.",
868+
"enum": [
869+
"RESILIENCE_MODE_UNSPECIFIED",
870+
"HIGH_RESILIENCE"
871+
],
872+
"enumDescriptions": [
873+
"Default mode doesn't change environment parameters.",
874+
"Enabled High Resilience mode, including Cloud SQL HA."
875+
],
876+
"type": "string"
877+
},
717878
"softwareConfig": {
718879
"$ref": "SoftwareConfig",
719880
"description": "The configuration settings for software inside the environment."
@@ -733,6 +894,86 @@
733894
},
734895
"type": "object"
735896
},
897+
"ExecuteAirflowCommandRequest": {
898+
"description": "Execute Airflow Command request.",
899+
"id": "ExecuteAirflowCommandRequest",
900+
"properties": {
901+
"command": {
902+
"description": "Airflow command.",
903+
"type": "string"
904+
},
905+
"parameters": {
906+
"description": "Parameters for the Airflow command/subcommand as an array of arguments. It may contain positional arguments like `[\"my-dag-id\"]`, key-value parameters like `[\"--foo=bar\"]` or `[\"--foo\",\"bar\"]`, or other flags like `[\"-f\"]`.",
907+
"items": {
908+
"type": "string"
909+
},
910+
"type": "array"
911+
},
912+
"subcommand": {
913+
"description": "Airflow subcommand.",
914+
"type": "string"
915+
}
916+
},
917+
"type": "object"
918+
},
919+
"ExecuteAirflowCommandResponse": {
920+
"description": "Response to ExecuteAirflowCommandRequest.",
921+
"id": "ExecuteAirflowCommandResponse",
922+
"properties": {
923+
"error": {
924+
"description": "Error message. Empty if there was no error.",
925+
"type": "string"
926+
},
927+
"executionId": {
928+
"description": "The unique ID of the command execution for polling.",
929+
"type": "string"
930+
},
931+
"pod": {
932+
"description": "The name of the pod where the command is executed.",
933+
"type": "string"
934+
},
935+
"podNamespace": {
936+
"description": "The namespace of the pod where the command is executed.",
937+
"type": "string"
938+
}
939+
},
940+
"type": "object"
941+
},
942+
"ExitInfo": {
943+
"description": "Information about how a command ended.",
944+
"id": "ExitInfo",
945+
"properties": {
946+
"error": {
947+
"description": "Error message. Empty if there was no error.",
948+
"type": "string"
949+
},
950+
"exitCode": {
951+
"description": "The exit code from the command execution.",
952+
"format": "int32",
953+
"type": "integer"
954+
}
955+
},
956+
"type": "object"
957+
},
958+
"FetchDatabasePropertiesResponse": {
959+
"description": "Response for FetchDatabasePropertiesRequest.",
960+
"id": "FetchDatabasePropertiesResponse",
961+
"properties": {
962+
"isFailoverReplicaAvailable": {
963+
"description": "The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only fail over to the failover replica when the status is true.",
964+
"type": "boolean"
965+
},
966+
"primaryGceZone": {
967+
"description": "The Compute Engine zone that the instance is currently serving from.",
968+
"type": "string"
969+
},
970+
"secondaryGceZone": {
971+
"description": "The Compute Engine zone that the failover instance is currently serving from for a regional Cloud SQL instance.",
972+
"type": "string"
973+
}
974+
},
975+
"type": "object"
976+
},
736977
"IPAllocationPolicy": {
737978
"description": "Configuration for controlling how IPs are allocated in the GKE cluster running the Apache Airflow software.",
738979
"id": "IPAllocationPolicy",
@@ -794,6 +1035,22 @@
7941035
},
7951036
"type": "object"
7961037
},
1038+
"Line": {
1039+
"description": "Contains information about a single line from logs.",
1040+
"id": "Line",
1041+
"properties": {
1042+
"content": {
1043+
"description": "Text content of the log line.",
1044+
"type": "string"
1045+
},
1046+
"lineNumber": {
1047+
"description": "Number of the line.",
1048+
"format": "int32",
1049+
"type": "integer"
1050+
}
1051+
},
1052+
"type": "object"
1053+
},
7971054
"ListEnvironmentsResponse": {
7981055
"description": "The environments in a project and location.",
7991056
"id": "ListEnvironmentsResponse",
@@ -1053,7 +1310,8 @@
10531310
"UPDATE",
10541311
"CHECK",
10551312
"SAVE_SNAPSHOT",
1056-
"LOAD_SNAPSHOT"
1313+
"LOAD_SNAPSHOT",
1314+
"DATABASE_FAILOVER"
10571315
],
10581316
"enumDescriptions": [
10591317
"Unused.",
@@ -1062,7 +1320,8 @@
10621320
"A resource update operation.",
10631321
"A resource check operation.",
10641322
"Saves snapshot of the resource operation.",
1065-
"Loads snapshot of the resource operation."
1323+
"Loads snapshot of the resource operation.",
1324+
"Triggers failover of environment's Cloud SQL instance (only for highly resilient environments)."
10661325
],
10671326
"type": "string"
10681327
},
@@ -1097,6 +1356,52 @@
10971356
},
10981357
"type": "object"
10991358
},
1359+
"PollAirflowCommandRequest": {
1360+
"description": "Poll Airflow Command request.",
1361+
"id": "PollAirflowCommandRequest",
1362+
"properties": {
1363+
"executionId": {
1364+
"description": "The unique ID of the command execution.",
1365+
"type": "string"
1366+
},
1367+
"nextLineNumber": {
1368+
"description": "Line number from which new logs should be fetched.",
1369+
"format": "int32",
1370+
"type": "integer"
1371+
},
1372+
"pod": {
1373+
"description": "The name of the pod where the command is executed.",
1374+
"type": "string"
1375+
},
1376+
"podNamespace": {
1377+
"description": "The namespace of the pod where the command is executed.",
1378+
"type": "string"
1379+
}
1380+
},
1381+
"type": "object"
1382+
},
1383+
"PollAirflowCommandResponse": {
1384+
"description": "Response to PollAirflowCommandRequest.",
1385+
"id": "PollAirflowCommandResponse",
1386+
"properties": {
1387+
"exitInfo": {
1388+
"$ref": "ExitInfo",
1389+
"description": "The result exit status of the command."
1390+
},
1391+
"output": {
1392+
"description": "Output from the command execution. It may not contain the full output and the caller may need to poll for more lines.",
1393+
"items": {
1394+
"$ref": "Line"
1395+
},
1396+
"type": "array"
1397+
},
1398+
"outputEnd": {
1399+
"description": "Whether the command execution has finished and there is no more output.",
1400+
"type": "boolean"
1401+
}
1402+
},
1403+
"type": "object"
1404+
},
11001405
"PrivateClusterConfig": {
11011406
"description": "Configuration options for the private GKE cluster in a Cloud Composer environment.",
11021407
"id": "PrivateClusterConfig",
@@ -1317,6 +1622,47 @@
13171622
},
13181623
"type": "object"
13191624
},
1625+
"StopAirflowCommandRequest": {
1626+
"description": "Stop Airflow Command request.",
1627+
"id": "StopAirflowCommandRequest",
1628+
"properties": {
1629+
"executionId": {
1630+
"description": "The unique ID of the command execution.",
1631+
"type": "string"
1632+
},
1633+
"force": {
1634+
"description": "If true, the execution is terminated forcefully (SIGKILL). If false, the execution is stopped gracefully, giving it time for cleanup.",
1635+
"type": "boolean"
1636+
},
1637+
"pod": {
1638+
"description": "The name of the pod where the command is executed.",
1639+
"type": "string"
1640+
},
1641+
"podNamespace": {
1642+
"description": "The namespace of the pod where the command is executed.",
1643+
"type": "string"
1644+
}
1645+
},
1646+
"type": "object"
1647+
},
1648+
"StopAirflowCommandResponse": {
1649+
"description": "Response to StopAirflowCommandRequest.",
1650+
"id": "StopAirflowCommandResponse",
1651+
"properties": {
1652+
"isDone": {
1653+
"description": "Whether the execution is still running.",
1654+
"type": "boolean"
1655+
},
1656+
"output": {
1657+
"description": "Output message from stopping execution request.",
1658+
"items": {
1659+
"type": "string"
1660+
},
1661+
"type": "array"
1662+
}
1663+
},
1664+
"type": "object"
1665+
},
13201666
"WebServerConfig": {
13211667
"description": "The configuration settings for the Airflow web server App Engine instance. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*",
13221668
"id": "WebServerConfig",

‎googleapiclient/discovery_cache/documents/composer.v1beta1.json

+272-3
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,34 @@
167167
"https://www.googleapis.com/auth/cloud-platform"
168168
]
169169
},
170+
"databaseFailover": {
171+
"description": "Triggers database failover (only for highly resilient environments).",
172+
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:databaseFailover",
173+
"httpMethod": "POST",
174+
"id": "composer.projects.locations.environments.databaseFailover",
175+
"parameterOrder": [
176+
"environment"
177+
],
178+
"parameters": {
179+
"environment": {
180+
"description": "Target environment: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
181+
"location": "path",
182+
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
183+
"required": true,
184+
"type": "string"
185+
}
186+
},
187+
"path": "v1beta1/{+environment}:databaseFailover",
188+
"request": {
189+
"$ref": "DatabaseFailoverRequest"
190+
},
191+
"response": {
192+
"$ref": "Operation"
193+
},
194+
"scopes": [
195+
"https://www.googleapis.com/auth/cloud-platform"
196+
]
197+
},
170198
"delete": {
171199
"description": "Delete an environment.",
172200
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}",
@@ -192,6 +220,59 @@
192220
"https://www.googleapis.com/auth/cloud-platform"
193221
]
194222
},
223+
"executeAirflowCommand": {
224+
"description": "Executes Airflow CLI command.",
225+
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:executeAirflowCommand",
226+
"httpMethod": "POST",
227+
"id": "composer.projects.locations.environments.executeAirflowCommand",
228+
"parameterOrder": [
229+
"environment"
230+
],
231+
"parameters": {
232+
"environment": {
233+
"description": "The resource name of the environment in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\".",
234+
"location": "path",
235+
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
236+
"required": true,
237+
"type": "string"
238+
}
239+
},
240+
"path": "v1beta1/{+environment}:executeAirflowCommand",
241+
"request": {
242+
"$ref": "ExecuteAirflowCommandRequest"
243+
},
244+
"response": {
245+
"$ref": "ExecuteAirflowCommandResponse"
246+
},
247+
"scopes": [
248+
"https://www.googleapis.com/auth/cloud-platform"
249+
]
250+
},
251+
"fetchDatabaseProperties": {
252+
"description": "Fetches database properties.",
253+
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:fetchDatabaseProperties",
254+
"httpMethod": "GET",
255+
"id": "composer.projects.locations.environments.fetchDatabaseProperties",
256+
"parameterOrder": [
257+
"environment"
258+
],
259+
"parameters": {
260+
"environment": {
261+
"description": "Required. The resource name of the environment, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
262+
"location": "path",
263+
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
264+
"required": true,
265+
"type": "string"
266+
}
267+
},
268+
"path": "v1beta1/{+environment}:fetchDatabaseProperties",
269+
"response": {
270+
"$ref": "FetchDatabasePropertiesResponse"
271+
},
272+
"scopes": [
273+
"https://www.googleapis.com/auth/cloud-platform"
274+
]
275+
},
195276
"get": {
196277
"description": "Get an existing environment.",
197278
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}",
@@ -315,6 +396,34 @@
315396
"https://www.googleapis.com/auth/cloud-platform"
316397
]
317398
},
399+
"pollAirflowCommand": {
400+
"description": "Polls Airflow CLI command execution and fetches logs.",
401+
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:pollAirflowCommand",
402+
"httpMethod": "POST",
403+
"id": "composer.projects.locations.environments.pollAirflowCommand",
404+
"parameterOrder": [
405+
"environment"
406+
],
407+
"parameters": {
408+
"environment": {
409+
"description": "The resource name of the environment in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\"",
410+
"location": "path",
411+
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
412+
"required": true,
413+
"type": "string"
414+
}
415+
},
416+
"path": "v1beta1/{+environment}:pollAirflowCommand",
417+
"request": {
418+
"$ref": "PollAirflowCommandRequest"
419+
},
420+
"response": {
421+
"$ref": "PollAirflowCommandResponse"
422+
},
423+
"scopes": [
424+
"https://www.googleapis.com/auth/cloud-platform"
425+
]
426+
},
318427
"restartWebServer": {
319428
"description": "Restart Airflow web server.",
320429
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:restartWebServer",
@@ -370,6 +479,34 @@
370479
"scopes": [
371480
"https://www.googleapis.com/auth/cloud-platform"
372481
]
482+
},
483+
"stopAirflowCommand": {
484+
"description": "Stops Airflow CLI command execution.",
485+
"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}:stopAirflowCommand",
486+
"httpMethod": "POST",
487+
"id": "composer.projects.locations.environments.stopAirflowCommand",
488+
"parameterOrder": [
489+
"environment"
490+
],
491+
"parameters": {
492+
"environment": {
493+
"description": "The resource name of the environment in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\".",
494+
"location": "path",
495+
"pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+$",
496+
"required": true,
497+
"type": "string"
498+
}
499+
},
500+
"path": "v1beta1/{+environment}:stopAirflowCommand",
501+
"request": {
502+
"$ref": "StopAirflowCommandRequest"
503+
},
504+
"response": {
505+
"$ref": "StopAirflowCommandResponse"
506+
},
507+
"scopes": [
508+
"https://www.googleapis.com/auth/cloud-platform"
509+
]
373510
}
374511
}
375512
},
@@ -518,7 +655,7 @@
518655
}
519656
}
520657
},
521-
"revision": "20230407",
658+
"revision": "20230516",
522659
"rootUrl": "https://composer.googleapis.com/",
523660
"schemas": {
524661
"AllowedIpRange": {
@@ -627,6 +764,18 @@
627764
},
628765
"type": "object"
629766
},
767+
"DatabaseFailoverRequest": {
768+
"description": "Request to trigger database failover (only for highly resilient environments).",
769+
"id": "DatabaseFailoverRequest",
770+
"properties": {},
771+
"type": "object"
772+
},
773+
"DatabaseFailoverResponse": {
774+
"description": "Response for DatabaseFailoverRequest.",
775+
"id": "DatabaseFailoverResponse",
776+
"properties": {},
777+
"type": "object"
778+
},
630779
"Date": {
631780
"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp",
632781
"id": "Date",
@@ -798,6 +947,18 @@
798947
"$ref": "RecoveryConfig",
799948
"description": "Optional. The Recovery settings configuration of an environment. This field is supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.* and newer."
800949
},
950+
"resilienceMode": {
951+
"description": "Optional. Resilience mode of the Cloud Composer Environment. This field is supported for Cloud Composer environments in versions composer-2.2.0-airflow-*.*.* and newer.",
952+
"enum": [
953+
"RESILIENCE_MODE_UNSPECIFIED",
954+
"HIGH_RESILIENCE"
955+
],
956+
"enumDescriptions": [
957+
"Default mode doesn't change environment parameters.",
958+
"Enabled High Resilience mode, including Cloud SQL HA."
959+
],
960+
"type": "string"
961+
},
801962
"softwareConfig": {
802963
"$ref": "SoftwareConfig",
803964
"description": "The configuration settings for software inside the environment."
@@ -817,6 +978,28 @@
817978
},
818979
"type": "object"
819980
},
981+
"ExecuteAirflowCommandRequest": {
982+
"description": "Execute Airflow Command request.",
983+
"id": "ExecuteAirflowCommandRequest",
984+
"properties": {
985+
"command": {
986+
"description": "Airflow command.",
987+
"type": "string"
988+
},
989+
"parameters": {
990+
"description": "Parameters for the Airflow command/subcommand as an array of arguments. It may contain positional arguments like `[\"my-dag-id\"]`, key-value parameters like `[\"--foo=bar\"]` or `[\"--foo\",\"bar\"]`, or other flags like `[\"-f\"]`.",
991+
"items": {
992+
"type": "string"
993+
},
994+
"type": "array"
995+
},
996+
"subcommand": {
997+
"description": "Airflow subcommand.",
998+
"type": "string"
999+
}
1000+
},
1001+
"type": "object"
1002+
},
8201003
"ExecuteAirflowCommandResponse": {
8211004
"description": "Response to ExecuteAirflowCommandRequest.",
8221005
"id": "ExecuteAirflowCommandResponse",
@@ -856,6 +1039,25 @@
8561039
},
8571040
"type": "object"
8581041
},
1042+
"FetchDatabasePropertiesResponse": {
1043+
"description": "Response for FetchDatabasePropertiesRequest.",
1044+
"id": "FetchDatabasePropertiesResponse",
1045+
"properties": {
1046+
"isFailoverReplicaAvailable": {
1047+
"description": "The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only fail over to the failover replica when the status is true.",
1048+
"type": "boolean"
1049+
},
1050+
"primaryGceZone": {
1051+
"description": "The Compute Engine zone that the instance is currently serving from.",
1052+
"type": "string"
1053+
},
1054+
"secondaryGceZone": {
1055+
"description": "The Compute Engine zone that the failover instance is currently serving from for a regional Cloud SQL instance.",
1056+
"type": "string"
1057+
}
1058+
},
1059+
"type": "object"
1060+
},
8591061
"IPAllocationPolicy": {
8601062
"description": "Configuration for controlling how IPs are allocated in the GKE cluster.",
8611063
"id": "IPAllocationPolicy",
@@ -1197,7 +1399,8 @@
11971399
"UPDATE",
11981400
"CHECK",
11991401
"SAVE_SNAPSHOT",
1200-
"LOAD_SNAPSHOT"
1402+
"LOAD_SNAPSHOT",
1403+
"DATABASE_FAILOVER"
12011404
],
12021405
"enumDescriptions": [
12031406
"Unused.",
@@ -1206,7 +1409,8 @@
12061409
"A resource update operation.",
12071410
"A resource check operation.",
12081411
"Saves snapshot of the resource operation.",
1209-
"Loads snapshot of the resource operation."
1412+
"Loads snapshot of the resource operation.",
1413+
"Triggers failover of environment's Cloud SQL instance (only for highly resilient environments)."
12101414
],
12111415
"type": "string"
12121416
},
@@ -1239,6 +1443,30 @@
12391443
},
12401444
"type": "object"
12411445
},
1446+
"PollAirflowCommandRequest": {
1447+
"description": "Poll Airflow Command request.",
1448+
"id": "PollAirflowCommandRequest",
1449+
"properties": {
1450+
"executionId": {
1451+
"description": "The unique ID of the command execution.",
1452+
"type": "string"
1453+
},
1454+
"nextLineNumber": {
1455+
"description": "Line number from which new logs should be fetched.",
1456+
"format": "int32",
1457+
"type": "integer"
1458+
},
1459+
"pod": {
1460+
"description": "The name of the pod where the command is executed.",
1461+
"type": "string"
1462+
},
1463+
"podNamespace": {
1464+
"description": "The namespace of the pod where the command is executed.",
1465+
"type": "string"
1466+
}
1467+
},
1468+
"type": "object"
1469+
},
12421470
"PollAirflowCommandResponse": {
12431471
"description": "Response to PollAirflowCommandRequest.",
12441472
"id": "PollAirflowCommandResponse",
@@ -1491,6 +1719,47 @@
14911719
},
14921720
"type": "object"
14931721
},
1722+
"StopAirflowCommandRequest": {
1723+
"description": "Stop Airflow Command request.",
1724+
"id": "StopAirflowCommandRequest",
1725+
"properties": {
1726+
"executionId": {
1727+
"description": "The unique ID of the command execution.",
1728+
"type": "string"
1729+
},
1730+
"force": {
1731+
"description": "If true, the execution is terminated forcefully (SIGKILL). If false, the execution is stopped gracefully, giving it time for cleanup.",
1732+
"type": "boolean"
1733+
},
1734+
"pod": {
1735+
"description": "The name of the pod where the command is executed.",
1736+
"type": "string"
1737+
},
1738+
"podNamespace": {
1739+
"description": "The namespace of the pod where the command is executed.",
1740+
"type": "string"
1741+
}
1742+
},
1743+
"type": "object"
1744+
},
1745+
"StopAirflowCommandResponse": {
1746+
"description": "Response to StopAirflowCommandRequest.",
1747+
"id": "StopAirflowCommandResponse",
1748+
"properties": {
1749+
"isDone": {
1750+
"description": "Whether the execution is still running.",
1751+
"type": "boolean"
1752+
},
1753+
"output": {
1754+
"description": "Output message from stopping execution request.",
1755+
"items": {
1756+
"type": "string"
1757+
},
1758+
"type": "array"
1759+
}
1760+
},
1761+
"type": "object"
1762+
},
14941763
"TriggererResource": {
14951764
"description": "Configuration for resources used by Airflow triggerers.",
14961765
"id": "TriggererResource",

0 commit comments

Comments
 (0)
Please sign in to comment.