219 lines
8.5 KiB
HTML
219 lines
8.5 KiB
HTML
<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="clouddeploy_v1.html">Google Cloud Deploy API</a> . <a href="clouddeploy_v1.projects.html">projects</a> . <a href="clouddeploy_v1.projects.locations.html">locations</a></h1>
|
|
<h2>Instance Methods</h2>
|
|
<p class="toc_element">
|
|
<code><a href="clouddeploy_v1.projects.locations.deliveryPipelines.html">deliveryPipelines()</a></code>
|
|
</p>
|
|
<p class="firstline">Returns the deliveryPipelines Resource.</p>
|
|
|
|
<p class="toc_element">
|
|
<code><a href="clouddeploy_v1.projects.locations.operations.html">operations()</a></code>
|
|
</p>
|
|
<p class="firstline">Returns the operations Resource.</p>
|
|
|
|
<p class="toc_element">
|
|
<code><a href="clouddeploy_v1.projects.locations.targets.html">targets()</a></code>
|
|
</p>
|
|
<p class="firstline">Returns the targets Resource.</p>
|
|
|
|
<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="#get">get(name, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Gets information about a location.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#getConfig">getConfig(name, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Gets the configuration for a location.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
|
|
<p class="firstline">Lists information about the supported locations for this service.</p>
|
|
<p class="toc_element">
|
|
<code><a href="#list_next">list_next(previous_request, previous_response)</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="get">get(name, x__xgafv=None)</code>
|
|
<pre>Gets information about a location.
|
|
|
|
Args:
|
|
name: string, Resource name for the location. (required)
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # A resource that represents Google Cloud Platform location.
|
|
"displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
|
|
"labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
|
|
"a_key": "A String",
|
|
},
|
|
"locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
|
|
"metadata": { # Service-specific metadata. For example the available capacity at the given location.
|
|
"a_key": "", # Properties of the object. Contains field @type with type URL.
|
|
},
|
|
"name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="getConfig">getConfig(name, x__xgafv=None)</code>
|
|
<pre>Gets the configuration for a location.
|
|
|
|
Args:
|
|
name: string, Required. Name of requested configuration. (required)
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # Service-wide configuration.
|
|
"defaultSkaffoldVersion": "A String", # Output only. Default Skaffold version that is assigned when a Release is created without specifying a Skaffold version.
|
|
"name": "A String", # Name of the configuration.
|
|
"supportedVersions": [ # Output only. All supported versions of Skaffold.
|
|
{ # Details of a supported Skaffold version.
|
|
"supportEndDate": { # 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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. # Date when this version is expected to no longer be supported.
|
|
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
|
|
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
|
|
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
|
|
},
|
|
"version": "A String", # Release version number. For example, "1.20.3".
|
|
},
|
|
],
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
|
|
<pre>Lists information about the supported locations for this service.
|
|
|
|
Args:
|
|
name: string, The resource that owns the locations collection, if applicable. (required)
|
|
filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160).
|
|
pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
|
|
pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
|
|
x__xgafv: string, V1 error format.
|
|
Allowed values
|
|
1 - v1 error format
|
|
2 - v2 error format
|
|
|
|
Returns:
|
|
An object of the form:
|
|
|
|
{ # The response message for Locations.ListLocations.
|
|
"locations": [ # A list of locations that matches the specified filter in the request.
|
|
{ # A resource that represents Google Cloud Platform location.
|
|
"displayName": "A String", # The friendly name for this location, typically a nearby city name. For example, "Tokyo".
|
|
"labels": { # Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
|
|
"a_key": "A String",
|
|
},
|
|
"locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
|
|
"metadata": { # Service-specific metadata. For example the available capacity at the given location.
|
|
"a_key": "", # Properties of the object. Contains field @type with type URL.
|
|
},
|
|
"name": "A String", # Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"`
|
|
},
|
|
],
|
|
"nextPageToken": "A String", # The standard List next-page token.
|
|
}</pre>
|
|
</div>
|
|
|
|
<div class="method">
|
|
<code class="details" id="list_next">list_next(previous_request, previous_response)</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 'execute()' on to request the next
|
|
page. Returns None if there are no more items in the collection.
|
|
</pre>
|
|
</div>
|
|
|
|
</body></html> |