As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Artifactregistry v1beta2 API

class google.cloud.artifactregistry_v1beta2.types.CreateRepositoryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request to create a new repository.

parent

The name of the parent resource where the repository will be created.

Type

str

repository_id

The repository id to use for this repository.

Type

str

repository

The repository to be created.

Type

google.cloud.artifactregistry_v1beta2.types.Repository

class google.cloud.artifactregistry_v1beta2.types.CreateTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request to create a new tag.

parent

The name of the parent resource where the tag will be created.

Type

str

tag_id

The tag id to use for this repository.

Type

str

tag

The tag to be created.

Type

google.cloud.artifactregistry_v1beta2.types.Tag

class google.cloud.artifactregistry_v1beta2.types.DeletePackageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request to delete a package.

name

The name of the package to delete.

Type

str

class google.cloud.artifactregistry_v1beta2.types.DeleteRepositoryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request to delete a repository.

name

The name of the repository to delete.

Type

str

class google.cloud.artifactregistry_v1beta2.types.DeleteTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request to delete a tag.

name

The name of the tag to delete.

Type

str

class google.cloud.artifactregistry_v1beta2.types.DeleteVersionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request to delete a version.

name

The name of the version to delete.

Type

str

force

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.

Type

bool

class google.cloud.artifactregistry_v1beta2.types.File(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Files store content that is potentially associated with Packages or Versions.

name

The name of the file, for example: “projects/p1/locations/us- central1/repositories/repo1/files/a/b/c.txt”.

Type

str

size_bytes

The size of the File in bytes.

Type

int

hashes

The hashes of the file content.

Type

Sequence[google.cloud.artifactregistry_v1beta2.types.Hash]

create_time

The time when the File was created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

The time when the File was last updated.

Type

google.protobuf.timestamp_pb2.Timestamp

owner

The name of the Package or Version that owns this file, if any.

Type

str

class google.cloud.artifactregistry_v1beta2.types.GetFileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request to retrieve a file.

name

The name of the file to retrieve.

Type

str

class google.cloud.artifactregistry_v1beta2.types.GetPackageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request to retrieve a package.

name

The name of the package to retrieve.

Type

str

class google.cloud.artifactregistry_v1beta2.types.GetRepositoryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request to retrieve a repository.

name

The name of the repository to retrieve.

Type

str

class google.cloud.artifactregistry_v1beta2.types.GetTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request to retrieve a tag.

name

The name of the tag to retrieve.

Type

str

class google.cloud.artifactregistry_v1beta2.types.GetVersionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request to retrieve a version.

name

The name of the version to retrieve.

Type

str

view

The view that should be returned in the response.

Type

google.cloud.artifactregistry_v1beta2.types.VersionView

class google.cloud.artifactregistry_v1beta2.types.Hash(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A hash of file content.

type_

The algorithm used to compute the hash value.

Type

google.cloud.artifactregistry_v1beta2.types.Hash.HashType

value

The hash value.

Type

bytes

class HashType(value)[source]

Bases: proto.enums.Enum

The algorithm used to compute the hash.

HASH_TYPE_UNSPECIFIED = 0
SHA256 = 1
class google.cloud.artifactregistry_v1beta2.types.ListFilesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request to list files.

parent

The name of the parent resource whose files will be listed.

Type

str

filter

An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

  • name

  • owner

An example of using a filter:

  • name="projects/p1/locations/us-central1/repositories/repo1/files/a/b/*" –> Files with an ID starting with “a/b/”.

  • owner="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0" –> Files owned by the version 1.0 in package pkg1.

Type

str

page_size

The maximum number of files to return.

Type

int

page_token

The next_page_token value returned from a previous list request, if any.

Type

str

class google.cloud.artifactregistry_v1beta2.types.ListFilesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response from listing files.

files

The files returned.

Type

Sequence[google.cloud.artifactregistry_v1beta2.types.File]

next_page_token

The token to retrieve the next page of files, or empty if there are no more files to return.

Type

str

property raw_page
class google.cloud.artifactregistry_v1beta2.types.ListPackagesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request to list packages.

parent

The name of the parent resource whose packages will be listed.

Type

str

page_size

The maximum number of packages to return. Maximum page size is 10,000.

Type

int

page_token

The next_page_token value returned from a previous list request, if any.

Type

str

class google.cloud.artifactregistry_v1beta2.types.ListPackagesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response from listing packages.

packages

The packages returned.

Type

Sequence[google.cloud.artifactregistry_v1beta2.types.Package]

next_page_token

The token to retrieve the next page of packages, or empty if there are no more packages to return.

Type

str

property raw_page
class google.cloud.artifactregistry_v1beta2.types.ListRepositoriesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request to list repositories.

parent

The name of the parent resource whose repositories will be listed.

Type

str

page_size

The maximum number of repositories to return. Maximum page size is 10,000.

Type

int

page_token

The next_page_token value returned from a previous list request, if any.

Type

str

class google.cloud.artifactregistry_v1beta2.types.ListRepositoriesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response from listing repositories.

repositories

The repositories returned.

Type

Sequence[google.cloud.artifactregistry_v1beta2.types.Repository]

next_page_token

The token to retrieve the next page of repositories, or empty if there are no more repositories to return.

Type

str

property raw_page
class google.cloud.artifactregistry_v1beta2.types.ListTagsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request to list tags.

parent

The name of the parent resource whose tags will be listed.

Type

str

filter

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="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0" –> Tags that are applied to the version 1.0 in package pkg1.

Type

str

page_size

The maximum number of tags to return. Maximum page size is 10,000.

Type

int

page_token

The next_page_token value returned from a previous list request, if any.

Type

str

class google.cloud.artifactregistry_v1beta2.types.ListTagsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response from listing tags.

tags

The tags returned.

Type

Sequence[google.cloud.artifactregistry_v1beta2.types.Tag]

next_page_token

The token to retrieve the next page of tags, or empty if there are no more tags to return.

Type

str

property raw_page
class google.cloud.artifactregistry_v1beta2.types.ListVersionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request to list versions.

parent

The name of the parent resource whose versions will be listed.

Type

str

page_size

The maximum number of versions to return. Maximum page size is 10,000.

Type

int

page_token

The next_page_token value returned from a previous list request, if any.

Type

str

view

The view that should be returned in the response.

Type

google.cloud.artifactregistry_v1beta2.types.VersionView

class google.cloud.artifactregistry_v1beta2.types.ListVersionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The response from listing versions.

versions

The versions returned.

Type

Sequence[google.cloud.artifactregistry_v1beta2.types.Version]

next_page_token

The token to retrieve the next page of versions, or empty if there are no more versions to return.

Type

str

property raw_page
class google.cloud.artifactregistry_v1beta2.types.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Metadata type for longrunning-operations, currently empty.

class google.cloud.artifactregistry_v1beta2.types.Package(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Packages are named collections of versions.

name

The name of the package, for example: “projects/p1/locations/us- central1/repositories/repo1/packages/pkg1”.

Type

str

display_name

The display name of the package.

Type

str

create_time

The time when the package was created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

The time when the package was last updated. This includes publishing a new version of the package.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.artifactregistry_v1beta2.types.Repository(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A Repository for storing artifacts with a specific format.

name

The name of the repository, for example: “projects/p1/locations/us- central1/repositories/repo1”.

Type

str

format_

The format of packages that are stored in the repository.

Type

google.cloud.artifactregistry_v1beta2.types.Repository.Format

description

The user-provided description of the repository.

Type

str

labels

Labels with user-defined metadata. This field may contain up to 64 entries. Label keys and values may be no longer than 63 characters. Label keys must begin with a lowercase letter and may only contain lowercase letters, numeric characters, underscores, and dashes.

Type

Sequence[google.cloud.artifactregistry_v1beta2.types.Repository.LabelsEntry]

create_time

The time when the repository was created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

The time when the repository was last updated.

Type

google.protobuf.timestamp_pb2.Timestamp

kms_key_name

The Cloud KMS resource name of the customer managed encryption key that’s used to encrypt the contents of the Repository. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. This value may not be changed after the Repository has been created.

Type

str

class Format(value)[source]

Bases: proto.enums.Enum

A package format.

DOCKER = 1
FORMAT_UNSPECIFIED = 0
class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.artifactregistry_v1beta2.types.Tag(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Tags point to a version and represent an alternative name that can be used to access the version.

name

The name of the tag, for example: “projects/p1/locations/us- central1/repositories/repo1/packages/pkg1/tags/tag1”.

Type

str

version

The name of the version the tag refers to, for example: “projects/p1/locations/us- central1/repositories/repo1/packages/pkg1/versions/sha256:5243811”.

Type

str

class google.cloud.artifactregistry_v1beta2.types.UpdateRepositoryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request to update a repository.

repository

The repository that replaces the resource on the server.

Type

google.cloud.artifactregistry_v1beta2.types.Repository

update_mask

The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.artifactregistry_v1beta2.types.UpdateTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The request to create or update a tag.

tag

The tag that replaces the resource on the server.

Type

google.cloud.artifactregistry_v1beta2.types.Tag

update_mask

The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.artifactregistry_v1beta2.types.Version(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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.

name

The name of the version, for example: “projects/p1/locations/us- central1/repositories/repo1/packages/pkg1/versions/art1”.

Type

str

description

Optional. Description of the version, as specified in its metadata.

Type

str

create_time

The time when the version was created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

The time when the version was last updated.

Type

google.protobuf.timestamp_pb2.Timestamp

related_tags

Output only. A list of related tags. Will contain up to 100 tags that reference this version.

Type

Sequence[google.cloud.artifactregistry_v1beta2.types.Tag]

class google.cloud.artifactregistry_v1beta2.types.VersionView(value)[source]

Bases: proto.enums.Enum

The view, which determines what version information is returned in a response.

BASIC = 1
FULL = 2
VERSION_VIEW_UNSPECIFIED = 0