Skip to content

Commit

Permalink
feat(composer): update the api
Browse files Browse the repository at this point in the history
#### composer:v1

The following keys were added:
- resources.projects.resources.locations.resources.environments.resources.workloads.methods.list (Total Keys: 18)
- schemas.ComposerWorkload (Total Keys: 14)
- schemas.DagProcessorResource (Total Keys: 10)
- schemas.ListWorkloadsResponse (Total Keys: 5)
- schemas.NodeConfig.properties.composerInternalIpv4CidrBlock.type (Total Keys: 1)
- schemas.NodeConfig.properties.composerNetworkAttachment.type (Total Keys: 1)
- schemas.PrivateEnvironmentConfig.properties.enablePrivateBuildsOnly.type (Total Keys: 1)
- schemas.SoftwareConfig.properties.webServerPluginsMode.type (Total Keys: 1)
- schemas.WorkloadsConfig.properties.dagProcessor.$ref (Total Keys: 1)

#### composer:v1beta1

The following keys were added:
- resources.projects.resources.locations.resources.environments.resources.userWorkloadsConfigMaps.methods.create (Total Keys: 12)
- resources.projects.resources.locations.resources.environments.resources.userWorkloadsConfigMaps.methods.delete (Total Keys: 11)
- resources.projects.resources.locations.resources.environments.resources.userWorkloadsConfigMaps.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.environments.resources.userWorkloadsConfigMaps.methods.list (Total Keys: 16)
- resources.projects.resources.locations.resources.environments.resources.userWorkloadsConfigMaps.methods.update (Total Keys: 12)
- resources.projects.resources.locations.resources.environments.resources.userWorkloadsSecrets.methods.create (Total Keys: 12)
- resources.projects.resources.locations.resources.environments.resources.userWorkloadsSecrets.methods.delete (Total Keys: 11)
- resources.projects.resources.locations.resources.environments.resources.userWorkloadsSecrets.methods.get (Total Keys: 11)
- resources.projects.resources.locations.resources.environments.resources.userWorkloadsSecrets.methods.list (Total Keys: 16)
- resources.projects.resources.locations.resources.environments.resources.userWorkloadsSecrets.methods.update (Total Keys: 12)
- resources.projects.resources.locations.resources.environments.resources.workloads.methods.list (Total Keys: 18)
- schemas.ComposerWorkload (Total Keys: 14)
- schemas.ListUserWorkloadsConfigMapsResponse (Total Keys: 5)
- schemas.ListUserWorkloadsSecretsResponse (Total Keys: 5)
- schemas.ListWorkloadsResponse (Total Keys: 5)
- schemas.UserWorkloadsConfigMap (Total Keys: 5)
- schemas.UserWorkloadsSecret (Total Keys: 5)
  • Loading branch information
yoshi-automation committed Feb 6, 2024
1 parent 42e8cae commit 5a252ca
Show file tree
Hide file tree
Showing 8 changed files with 1,557 additions and 2 deletions.
45 changes: 45 additions & 0 deletions docs/dyn/composer_v1.projects.locations.environments.html

Large diffs are not rendered by default.

139 changes: 139 additions & 0 deletions docs/dyn/composer_v1.projects.locations.environments.workloads.html
@@ -0,0 +1,139 @@
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}

body {
font-size: 13px;
padding: 1em;
}

h1 {
font-size: 26px;
margin-bottom: 1em;
}

h2 {
font-size: 24px;
margin-bottom: 1em;
}

h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}

pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
margin-top: 0.5em;
}

h1, h2, h3, p {
font-family: Arial, sans serif;
}

h1, h2, h3 {
border-bottom: solid #CCC 1px;
}

.toc_element {
margin-top: 0.5em;
}

.firstline {
margin-left: 2 em;
}

.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}

.details {
font-weight: bold;
font-size: 14px;
}

</style>

<h1><a href="composer_v1.html">Cloud Composer API</a> . <a href="composer_v1.projects.html">projects</a> . <a href="composer_v1.projects.locations.html">locations</a> . <a href="composer_v1.projects.locations.environments.html">environments</a> . <a href="composer_v1.projects.locations.environments.workloads.html">workloads</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists workloads in a Cloud Composer environment. Workload is a unit that runs a single Composer component. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>

<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists workloads in a Cloud Composer environment. Workload is a unit that runs a single Composer component. This method is supported for Cloud Composer environments in versions composer-3.*.*-airflow-*.*.* and newer.

Args:
parent: string, Required. The environment name to get workloads for, in the form: &quot;projects/{projectId}/locations/{locationId}/environments/{environmentId}&quot; (required)
filter: string, Optional. The list filter. Currently only supports equality on the type field. The value of a field specified in the filter expression must be one ComposerWorkloadType enum option. It&#x27;s possible to get multiple types using &quot;OR&quot; operator, e.g.: &quot;type=SCHEDULER OR type=CELERY_WORKER&quot;. If not specified, all items are returned.
pageSize: integer, Optional. The maximum number of environments to return.
pageToken: string, Optional. The next_page_token value returned from a previous List request, if any.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response to ListWorkloadsRequest.
&quot;nextPageToken&quot;: &quot;A String&quot;, # The page token used to query for the next page if one exists.
&quot;workloads&quot;: [ # The list of environment workloads.
{ # Information about a single workload.
&quot;name&quot;: &quot;A String&quot;, # Name of a workload.
&quot;status&quot;: { # Workload status. # Output only. Status of a workload.
&quot;detailedStatusMessage&quot;: &quot;A String&quot;, # Output only. Detailed message of the status.
&quot;state&quot;: &quot;A String&quot;, # Output only. Workload state.
&quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Text to provide more descriptive status.
},
&quot;type&quot;: &quot;A String&quot;, # Type of a workload.
},
],
}</pre>
</div>

<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.

Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)

Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>

</body></html>
15 changes: 15 additions & 0 deletions docs/dyn/composer_v1beta1.projects.locations.environments.html
Expand Up @@ -74,6 +74,21 @@

<h1><a href="composer_v1beta1.html">Cloud Composer API</a> . <a href="composer_v1beta1.projects.html">projects</a> . <a href="composer_v1beta1.projects.locations.html">locations</a> . <a href="composer_v1beta1.projects.locations.environments.html">environments</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="composer_v1beta1.projects.locations.environments.userWorkloadsConfigMaps.html">userWorkloadsConfigMaps()</a></code>
</p>
<p class="firstline">Returns the userWorkloadsConfigMaps Resource.</p>

<p class="toc_element">
<code><a href="composer_v1beta1.projects.locations.environments.userWorkloadsSecrets.html">userWorkloadsSecrets()</a></code>
</p>
<p class="firstline">Returns the userWorkloadsSecrets Resource.</p>

<p class="toc_element">
<code><a href="composer_v1beta1.projects.locations.environments.workloads.html">workloads()</a></code>
</p>
<p class="firstline">Returns the workloads Resource.</p>

<p class="toc_element">
<code><a href="#checkUpgrade">checkUpgrade(environment, body=None, x__xgafv=None)</a></code></p>
<p class="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>
Expand Down

0 comments on commit 5a252ca

Please sign in to comment.