Artifact Registry API . projects . locations . repositories . packages . versions

Instance Methods

close()

Close httplib2 connections.

delete(name, force=None, x__xgafv=None)

Deletes a version and all of its content. The returned operation will complete once the version has been deleted.

get(name, view=None, x__xgafv=None)

Gets a version

list(parent, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)

Lists versions.

list_next()

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
delete(name, force=None, x__xgafv=None)
Deletes a version and all of its content. The returned operation will complete once the version has been deleted.

Args:
  name: string, The name of the version to delete. (required)
  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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": 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.
  "error": { # 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.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # 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.
  },
  "metadata": { # 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.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # 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}`.
  "response": { # The normal, successful response of the operation. 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`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}
get(name, view=None, x__xgafv=None)
Gets a version

Args:
  name: string, The name of the version to retrieve. (required)
  view: string, The view that should be returned in the response.
    Allowed values
      VERSION_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
      BASIC - Includes basic information about the version, but not any related tags.
      FULL - Include everything.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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.
  "createTime": "A String", # The time when the version was created.
  "description": "A String", # Optional. Description of the version, as specified in its metadata.
  "metadata": { # Output only. Repository-specific Metadata stored against this version. The fields returned are defined by the underlying repository-specific resource. Currently, the resources could be: DockerImage MavenArtifact
    "a_key": "", # Properties of the object.
  },
  "name": "A String", # The name of the version, for example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1`. If the package or version ID parts contain slashes, the slashes are escaped.
  "relatedTags": [ # Output only. A list of related tags. Will contain up to 100 tags that reference this version.
    { # Tags point to a version and represent an alternative name that can be used to access the version.
      "name": "A String", # The name of the tag, for example: "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1". 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.
      "version": "A String", # The name of the version the tag refers to, for example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811` If the package or version ID parts contain slashes, the slashes are escaped.
    },
  ],
  "updateTime": "A String", # The time when the version was last updated.
}
list(parent, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists versions.

Args:
  parent: string, The name of the parent resource whose versions will be listed. (required)
  orderBy: string, Optional. The field to order the results by.
  pageSize: integer, The maximum number of versions to return. Maximum page size is 1,000.
  pageToken: string, The next_page_token value returned from a previous list request, if any.
  view: string, The view that should be returned in the response.
    Allowed values
      VERSION_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
      BASIC - Includes basic information about the version, but not any related tags.
      FULL - Include everything.
  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 versions.
  "nextPageToken": "A String", # The token to retrieve the next page of versions, or empty if there are no more versions to return.
  "versions": [ # The versions returned.
    { # 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.
      "createTime": "A String", # The time when the version was created.
      "description": "A String", # Optional. Description of the version, as specified in its metadata.
      "metadata": { # Output only. Repository-specific Metadata stored against this version. The fields returned are defined by the underlying repository-specific resource. Currently, the resources could be: DockerImage MavenArtifact
        "a_key": "", # Properties of the object.
      },
      "name": "A String", # The name of the version, for example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1`. If the package or version ID parts contain slashes, the slashes are escaped.
      "relatedTags": [ # Output only. A list of related tags. Will contain up to 100 tags that reference this version.
        { # Tags point to a version and represent an alternative name that can be used to access the version.
          "name": "A String", # The name of the tag, for example: "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1". 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.
          "version": "A String", # The name of the version the tag refers to, for example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/sha256:5243811` If the package or version ID parts contain slashes, the slashes are escaped.
        },
      ],
      "updateTime": "A String", # The time when the version was last updated.
    },
  ],
}
list_next()
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.