• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<h1><a href="artifactregistry_v1beta2.html">Artifact Registry API</a> . <a href="artifactregistry_v1beta2.projects.html">projects</a> . <a href="artifactregistry_v1beta2.projects.locations.html">locations</a> . <a href="artifactregistry_v1beta2.projects.locations.repositories.html">repositories</a> . <a href="artifactregistry_v1beta2.projects.locations.repositories.packages.html">packages</a> . <a href="artifactregistry_v1beta2.projects.locations.repositories.packages.versions.html">versions</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81  <code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a version and all of its content. The returned operation will complete once the version has been deleted.</p>
83<p class="toc_element">
84  <code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets a version</p>
86<p class="toc_element">
87  <code><a href="#list">list(parent, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Lists versions.</p>
89<p class="toc_element">
90  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
94    <code class="details" id="close">close()</code>
95  <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
99    <code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code>
100  <pre>Deletes a version and all of its content. The returned operation will complete once the version has been deleted.
101
102Args:
103  name: string, The name of the version to delete. (required)
104  force: boolean, By default, a version that is tagged may not be deleted. If force=true, the version and any tags pointing to the version are deleted.
105  x__xgafv: string, V1 error format.
106    Allowed values
107      1 - v1 error format
108      2 - v2 error format
109
110Returns:
111  An object of the form:
112
113    { # This resource represents a long-running operation that is the result of a network API call.
114  &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.
115  &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.
116    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
117    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
118      {
119        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
120      },
121    ],
122    &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.
123  },
124  &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.
125    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
126  },
127  &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}`.
128  &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`.
129    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
130  },
131}</pre>
132</div>
133
134<div class="method">
135    <code class="details" id="get">get(name, view=None, x__xgafv=None)</code>
136  <pre>Gets a version
137
138Args:
139  name: string, The name of the version to retrieve. (required)
140  view: string, The view that should be returned in the response.
141    Allowed values
142      VERSION_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
143      BASIC - Includes basic information about the version, but not any related tags.
144      FULL - Include everything.
145  x__xgafv: string, V1 error format.
146    Allowed values
147      1 - v1 error format
148      2 - v2 error format
149
150Returns:
151  An object of the form:
152
153    { # The body of a version resource. A version resource represents a collection of components, such as files and other data. This may correspond to a version in many package management schemes.
154  &quot;createTime&quot;: &quot;A String&quot;, # The time when the version was created.
155  &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the version, as specified in its metadata.
156  &quot;metadata&quot;: { # Output only. Repository-specific Metadata stored against this version. The fields returned are defined by the underlying repository-specific resource. Currently, the only resource in use is DockerImage
157    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
158  },
159  &quot;name&quot;: &quot;A String&quot;, # The name of the version, for example: &quot;projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1&quot;. If the package or version ID parts contain slashes, the slashes are escaped.
160  &quot;relatedTags&quot;: [ # Output only. A list of related tags. Will contain up to 100 tags that reference this version.
161    { # Tags point to a version and represent an alternative name that can be used to access the version.
162      &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;. If the package part contains slashes, the slashes are escaped. The tag part can only have characters in [a-zA-Z0-9\-._~:@], anything else must be URL encoded.
163      &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; If the package or version ID parts contain slashes, the slashes are escaped.
164    },
165  ],
166  &quot;updateTime&quot;: &quot;A String&quot;, # The time when the version was last updated.
167}</pre>
168</div>
169
170<div class="method">
171    <code class="details" id="list">list(parent, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
172  <pre>Lists versions.
173
174Args:
175  parent: string, The name of the parent resource whose versions will be listed. (required)
176  orderBy: string, Optional. Sorting field and order
177  pageSize: integer, The maximum number of versions to return. Maximum page size is 1,000.
178  pageToken: string, The next_page_token value returned from a previous list request, if any.
179  view: string, The view that should be returned in the response.
180    Allowed values
181      VERSION_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
182      BASIC - Includes basic information about the version, but not any related tags.
183      FULL - Include everything.
184  x__xgafv: string, V1 error format.
185    Allowed values
186      1 - v1 error format
187      2 - v2 error format
188
189Returns:
190  An object of the form:
191
192    { # The response from listing versions.
193  &quot;nextPageToken&quot;: &quot;A String&quot;, # The token to retrieve the next page of versions, or empty if there are no more versions to return.
194  &quot;versions&quot;: [ # The versions returned.
195    { # The body of a version resource. A version resource represents a collection of components, such as files and other data. This may correspond to a version in many package management schemes.
196      &quot;createTime&quot;: &quot;A String&quot;, # The time when the version was created.
197      &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the version, as specified in its metadata.
198      &quot;metadata&quot;: { # Output only. Repository-specific Metadata stored against this version. The fields returned are defined by the underlying repository-specific resource. Currently, the only resource in use is DockerImage
199        &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
200      },
201      &quot;name&quot;: &quot;A String&quot;, # The name of the version, for example: &quot;projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1&quot;. If the package or version ID parts contain slashes, the slashes are escaped.
202      &quot;relatedTags&quot;: [ # Output only. A list of related tags. Will contain up to 100 tags that reference this version.
203        { # Tags point to a version and represent an alternative name that can be used to access the version.
204          &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;. If the package part contains slashes, the slashes are escaped. The tag part can only have characters in [a-zA-Z0-9\-._~:@], anything else must be URL encoded.
205          &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; If the package or version ID parts contain slashes, the slashes are escaped.
206        },
207      ],
208      &quot;updateTime&quot;: &quot;A String&quot;, # The time when the version was last updated.
209    },
210  ],
211}</pre>
212</div>
213
214<div class="method">
215    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
216  <pre>Retrieves the next page of results.
217
218Args:
219  previous_request: The request for the previous page. (required)
220  previous_response: The response from the request for the previous page. (required)
221
222Returns:
223  A request object that you can call &#x27;execute()&#x27; on to request the next
224  page. Returns None if there are no more items in the collection.
225    </pre>
226</div>
227
228</body></html>