blob: 819d9003f852229e1e50f74034c37f8003c83d0b [file] [log] [blame]
<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="artifactregistry_v1beta1.html">Artifact Registry API</a> . <a href="artifactregistry_v1beta1.projects.html">projects</a> . <a href="artifactregistry_v1beta1.projects.locations.html">locations</a> . <a href="artifactregistry_v1beta1.projects.locations.repositories.html">repositories</a> . <a href="artifactregistry_v1beta1.projects.locations.repositories.packages.html">packages</a> . <a href="artifactregistry_v1beta1.projects.locations.repositories.packages.tags.html">tags</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, tagId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a tag.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a tag.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a tag.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists tags.</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>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a tag.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(parent, body=None, tagId=None, x__xgafv=None)</code>
<pre>Creates a tag.
Args:
parent: string, The name of the parent resource where the tag will be created. (required)
body: object, The request body.
The object takes the form of:
{ # Tags point to a version and represent an alternative name that can be used
# to access the version.
&quot;version&quot;: &quot;A String&quot;, # The name of the version the tag refers to, for example:
# &quot;projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811&quot;
&quot;name&quot;: &quot;A String&quot;, # The name of the tag, for example:
# &quot;projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1&quot;.
}
tagId: string, The tag id to use for this repository.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Tags point to a version and represent an alternative name that can be used
# to access the version.
&quot;version&quot;: &quot;A String&quot;, # The name of the version the tag refers to, for example:
# &quot;projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811&quot;
&quot;name&quot;: &quot;A String&quot;, # The name of the tag, for example:
# &quot;projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1&quot;.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a tag.
Args:
name: string, The name of the tag to delete. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated
# empty messages in your APIs. A typical example is to use it as the request
# or the response type of an API method. For instance:
#
# service Foo {
# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
# }
#
# The JSON representation for `Empty` is empty JSON object `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a tag.
Args:
name: string, The name of the tag to retrieve. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Tags point to a version and represent an alternative name that can be used
# to access the version.
&quot;version&quot;: &quot;A String&quot;, # The name of the version the tag refers to, for example:
# &quot;projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811&quot;
&quot;name&quot;: &quot;A String&quot;, # The name of the tag, for example:
# &quot;projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1&quot;.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</code>
<pre>Lists tags.
Args:
parent: string, The name of the parent resource whose tags will be listed. (required)
pageToken: string, The next_page_token value returned from a previous list request, if any.
filter: string, An expression for filtering the results of the request. Filter rules are
case insensitive. The fields eligible for filtering are:
* `version`
An example of using a filter:
* `version=&quot;projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0&quot;`
--&gt; Tags that are applied to the version `1.0` in package `pkg1`.
pageSize: integer, The maximum number of tags to return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response from listing tags.
&quot;tags&quot;: [ # The tags returned.
{ # Tags point to a version and represent an alternative name that can be used
# to access the version.
&quot;version&quot;: &quot;A String&quot;, # The name of the version the tag refers to, for example:
# &quot;projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811&quot;
&quot;name&quot;: &quot;A String&quot;, # The name of the tag, for example:
# &quot;projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1&quot;.
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # The token to retrieve the next page of tags, or empty if there are no
# more tags to return.
}</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 &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a tag.
Args:
name: string, The name of the tag, for example:
&quot;projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1&quot;. (required)
body: object, The request body.
The object takes the form of:
{ # Tags point to a version and represent an alternative name that can be used
# to access the version.
&quot;version&quot;: &quot;A String&quot;, # The name of the version the tag refers to, for example:
# &quot;projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811&quot;
&quot;name&quot;: &quot;A String&quot;, # The name of the tag, for example:
# &quot;projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1&quot;.
}
updateMask: string, The update mask applies to the resource. For the `FieldMask` definition,
see
https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Tags point to a version and represent an alternative name that can be used
# to access the version.
&quot;version&quot;: &quot;A String&quot;, # The name of the version the tag refers to, for example:
# &quot;projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811&quot;
&quot;name&quot;: &quot;A String&quot;, # The name of the tag, for example:
# &quot;projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1&quot;.
}</pre>
</div>
</body></html>