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 v1 API

class google.cloud.artifactregistry_v1.types.AptArtifact(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A detailed representation of an Apt artifact. Information in the record is derived from the archive’s control file. See https://www.debian.org/doc/debian-policy/ch-controlfields.html

name

Output only. The Artifact Registry resource name of the artifact.

Type

str

package_name

Output only. The Apt package name of the artifact.

Type

str

package_type

Output only. An artifact is a binary or source package.

Type

google.cloud.artifactregistry_v1.types.AptArtifact.PackageType

architecture

Output only. Operating system architecture of the artifact.

Type

str

component

Output only. Repository component of the artifact.

Type

str

control_file

Output only. Contents of the artifact’s control metadata file.

Type

bytes

class PackageType(value)

Bases: proto.enums.Enum

Package type is either binary or source.

Values:

PACKAGE_TYPE_UNSPECIFIED (0):

Package type is not specified.

BINARY (1):

Binary package.

SOURCE (2):

Source package.

class google.cloud.artifactregistry_v1.types.Attachment(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

An Attachment refers to additional metadata that can be attached to artifacts in Artifact Registry. An attachment consists of one or more files.

name

The name of the attachment. E.g. projects/p1/locations/us/repositories/repo/attachments/sbom.

Type

str

target

Required. The target the attachment is for, can be a Version, Package or Repository. E.g. projects/p1/locations/us-central1/repositories/repo1/packages/p1/versions/v1.

Type

str

type_

Type of attachment. E.g. application/vnd.spdx+json

Type

str

attachment_namespace

The namespace this attachment belongs to. E.g. If an attachment is created by artifact analysis, namespace is set to artifactanalysis.googleapis.com.

Type

str

annotations

Optional. User annotations. These attributes can only be set and used by the user, and not by Artifact Registry. See https://google.aip.dev/128#annotations for more details such as format and size limitations.

Type

MutableMapping[str, str]

create_time

Output only. The time when the attachment was created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. The time when the attachment was last updated.

Type

google.protobuf.timestamp_pb2.Timestamp

files

Required. The files that belong to this attachment. If the file ID part contains slashes, they are escaped. E.g. projects/p1/locations/us-central1/repositories/repo1/files/sha:<sha-of-file>.

Type

MutableSequence[str]

oci_version_name

Output only. The name of the OCI version that this attachment created. Only populated for Docker attachments. E.g. projects/p1/locations/us-central1/repositories/repo1/packages/p1/versions/v1.

Type

str

class AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.artifactregistry_v1.types.BatchDeleteVersionsMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The metadata of an LRO from deleting multiple versions.

failed_versions

The versions the operation failed to delete.

Type

MutableSequence[str]

class google.cloud.artifactregistry_v1.types.BatchDeleteVersionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to delete multiple versions across a repository.

parent

The name of the repository holding all requested versions.

Type

str

names

Required. The names of the versions to delete. A maximum of 10000 versions can be deleted in a batch.

Type

MutableSequence[str]

validate_only

If true, the request is performed without deleting data, following AIP-163.

Type

bool

class google.cloud.artifactregistry_v1.types.CleanupPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Artifact policy configuration for repository cleanup policies.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

condition

Policy condition for matching versions.

This field is a member of oneof condition_type.

Type

google.cloud.artifactregistry_v1.types.CleanupPolicyCondition

most_recent_versions

Policy condition for retaining a minimum number of versions. May only be specified with a Keep action.

This field is a member of oneof condition_type.

Type

google.cloud.artifactregistry_v1.types.CleanupPolicyMostRecentVersions

id

The user-provided ID of the cleanup policy.

Type

str

action

Policy action.

Type

google.cloud.artifactregistry_v1.types.CleanupPolicy.Action

class Action(value)

Bases: proto.enums.Enum

Action type for a cleanup policy.

Values:

ACTION_UNSPECIFIED (0):

Action not specified.

DELETE (1):

Delete action.

KEEP (2):

Keep action.

class google.cloud.artifactregistry_v1.types.CleanupPolicyCondition(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

CleanupPolicyCondition is a set of conditions attached to a CleanupPolicy. If multiple entries are set, all must be satisfied for the condition to be satisfied.

tag_state

Match versions by tag status.

This field is a member of oneof _tag_state.

Type

google.cloud.artifactregistry_v1.types.CleanupPolicyCondition.TagState

tag_prefixes

Match versions by tag prefix. Applied on any prefix match.

Type

MutableSequence[str]

version_name_prefixes

Match versions by version name prefix. Applied on any prefix match.

Type

MutableSequence[str]

package_name_prefixes

Match versions by package prefix. Applied on any prefix match.

Type

MutableSequence[str]

older_than

Match versions older than a duration.

This field is a member of oneof _older_than.

Type

google.protobuf.duration_pb2.Duration

newer_than

Match versions newer than a duration.

This field is a member of oneof _newer_than.

Type

google.protobuf.duration_pb2.Duration

class TagState(value)

Bases: proto.enums.Enum

Statuses applying to versions.

Values:

TAG_STATE_UNSPECIFIED (0):

Tag status not specified.

TAGGED (1):

Applies to tagged versions only.

UNTAGGED (2):

Applies to untagged versions only.

ANY (3):

Applies to all versions.

class google.cloud.artifactregistry_v1.types.CleanupPolicyMostRecentVersions(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

CleanupPolicyMostRecentVersions is an alternate condition of a CleanupPolicy for retaining a minimum number of versions.

package_name_prefixes

List of package name prefixes that will apply this rule.

Type

MutableSequence[str]

keep_count

Minimum number of versions to keep.

This field is a member of oneof _keep_count.

Type

int

class google.cloud.artifactregistry_v1.types.CreateAttachmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to create a new attachment.

parent

Required. The name of the parent resource where the attachment will be created.

Type

str

attachment_id

Required. The attachment id to use for this attachment.

Type

str

attachment

Required. The attachment to be created.

Type

google.cloud.artifactregistry_v1.types.Attachment

class google.cloud.artifactregistry_v1.types.CreateRepositoryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to create a new repository.

parent

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

Type

str

repository_id

Required. The repository id to use for this repository.

Type

str

repository

Required. The repository to be created.

Type

google.cloud.artifactregistry_v1.types.Repository

class google.cloud.artifactregistry_v1.types.CreateRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to create a new rule.

parent

Required. The name of the parent resource where the rule will be created.

Type

str

rule_id

The rule id to use for this repository.

Type

str

rule

The rule to be created.

Type

google.cloud.artifactregistry_v1.types.Rule

class google.cloud.artifactregistry_v1.types.CreateTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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_v1.types.Tag

class google.cloud.artifactregistry_v1.types.DeleteAttachmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to delete an attachment.

name

Required. The name of the attachment to delete.

Type

str

class google.cloud.artifactregistry_v1.types.DeleteFileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to delete a file.

name

Required. The name of the file to delete.

Type

str

class google.cloud.artifactregistry_v1.types.DeletePackageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to delete a package.

name

Required. The name of the package to delete.

Type

str

class google.cloud.artifactregistry_v1.types.DeleteRepositoryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to delete a repository.

name

Required. The name of the repository to delete.

Type

str

class google.cloud.artifactregistry_v1.types.DeleteRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to delete a rule.

name

Required. The name of the rule to delete.

Type

str

class google.cloud.artifactregistry_v1.types.DeleteTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to delete a tag.

name

The name of the tag to delete.

Type

str

class google.cloud.artifactregistry_v1.types.DeleteVersionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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_v1.types.DockerImage(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

DockerImage represents a docker artifact. The following fields are returned as untyped metadata in the Version resource, using camelcase keys (i.e. metadata.imageSizeBytes):

• imageSizeBytes

• mediaType

• buildTime

name

Required. registry_location, project_id, repository_name and image id forms a unique image name:projects/<project_id>/locations/<location>/repository/<repository_name>/dockerImages/<docker_image>. For example, “projects/test-project/locations/us-west4/repositories/test-repo/dockerImages/ nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf”, where “us-west4” is the registry_location, “test-project” is the project_id, “test-repo” is the repository_name and “nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf” is the image’s digest.

Type

str

uri

Required. URL to access the image. Example:

us-west4-docker.pkg.dev/test-project/test-repo/nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf

Type

str

tags

Tags attached to this image.

Type

MutableSequence[str]

image_size_bytes

Calculated size of the image. This field is returned as the ‘metadata.imageSizeBytes’ field in the Version resource.

Type

int

upload_time

Time the image was uploaded.

Type

google.protobuf.timestamp_pb2.Timestamp

media_type

Media type of this image, e.g. “application/vnd.docker.distribution.manifest.v2+json”. This field is returned as the ‘metadata.mediaType’ field in the Version resource.

Type

str

build_time

The time this image was built. This field is returned as the ‘metadata.buildTime’ field in the Version resource. The build time is returned to the client as an RFC 3339 string, which can be easily used with the JavaScript Date constructor.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. The time when the docker image was last updated.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.artifactregistry_v1.types.File(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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%2Fb%2Fc.txt. If the file ID part contains slashes, they are escaped.

Type

str

size_bytes

The size of the File in bytes.

Type

int

hashes

The hashes of the file content.

Type

MutableSequence[google.cloud.artifactregistry_v1.types.Hash]

create_time

Output only. The time when the File was created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. 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

fetch_time

Output only. The time when the last attempt to refresh the file’s data was made. Only set when the repository is remote.

Type

google.protobuf.timestamp_pb2.Timestamp

annotations

Optional. Client specified annotations.

Type

MutableMapping[str, str]

class AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.artifactregistry_v1.types.GenericArtifact(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

GenericArtifact represents a generic artifact

name

Resource name of the generic artifact. project, location, repository, package_id and version_id create a unique generic artifact. i.e. “projects/test-project/locations/us-west4/repositories/test-repo/ genericArtifacts/package_id:version_id”.

Type

str

version

The version of the generic artifact.

Type

str

create_time

Output only. The time when the Generic module is created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. The time when the Generic module is updated.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.artifactregistry_v1.types.GetAttachmentRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to retrieve an attachment.

name

Required. The name of the attachment to retrieve.

Type

str

class google.cloud.artifactregistry_v1.types.GetDockerImageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to get docker images.

name

Required. The name of the docker images.

Type

str

class google.cloud.artifactregistry_v1.types.GetFileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to retrieve a file.

name

Required. The name of the file to retrieve.

Type

str

class google.cloud.artifactregistry_v1.types.GetMavenArtifactRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to get maven artifacts.

name

Required. The name of the maven artifact.

Type

str

class google.cloud.artifactregistry_v1.types.GetNpmPackageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to get npm packages.

name

Required. The name of the npm package.

Type

str

class google.cloud.artifactregistry_v1.types.GetPackageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to retrieve a package.

name

Required. The name of the package to retrieve.

Type

str

class google.cloud.artifactregistry_v1.types.GetProjectSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Gets the redirection status for a project.

name

Required. The name of the projectSettings resource.

Type

str

class google.cloud.artifactregistry_v1.types.GetPythonPackageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to get python packages.

name

Required. The name of the python package.

Type

str

class google.cloud.artifactregistry_v1.types.GetRepositoryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to retrieve a repository.

name

Required. The name of the repository to retrieve.

Type

str

class google.cloud.artifactregistry_v1.types.GetRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to retrieve a rule.

name

Required. The name of the rule to retrieve.

Type

str

class google.cloud.artifactregistry_v1.types.GetTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to retrieve a tag.

name

The name of the tag to retrieve.

Type

str

class google.cloud.artifactregistry_v1.types.GetVPCSCConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Gets the VPC SC config for a project.

name

Required. The name of the VPCSCConfig resource.

Type

str

class google.cloud.artifactregistry_v1.types.GetVersionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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_v1.types.VersionView

class google.cloud.artifactregistry_v1.types.Hash(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A hash of file content.

type_

The algorithm used to compute the hash value.

Type

google.cloud.artifactregistry_v1.types.Hash.HashType

value

The hash value.

Type

bytes

class HashType(value)

Bases: proto.enums.Enum

The algorithm used to compute the hash.

Values:

HASH_TYPE_UNSPECIFIED (0):

Unspecified.

SHA256 (1):

SHA256 hash.

MD5 (2):

MD5 hash.

class google.cloud.artifactregistry_v1.types.ImportAptArtifactsErrorInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Error information explaining why a package was not imported.

gcs_source

Google Cloud Storage location requested.

This field is a member of oneof source.

Type

google.cloud.artifactregistry_v1.types.ImportAptArtifactsGcsSource

error

The detailed error status.

Type

google.rpc.status_pb2.Status

class google.cloud.artifactregistry_v1.types.ImportAptArtifactsGcsSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Google Cloud Storage location where the artifacts currently reside.

uris

Cloud Storage paths URI (e.g., gs://my_bucket//my_object).

Type

MutableSequence[str]

use_wildcards

Supports URI wildcards for matching multiple objects from a single URI.

Type

bool

class google.cloud.artifactregistry_v1.types.ImportAptArtifactsMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The operation metadata for importing artifacts.

class google.cloud.artifactregistry_v1.types.ImportAptArtifactsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to import new apt artifacts.

gcs_source

Google Cloud Storage location where input content is located.

This field is a member of oneof source.

Type

google.cloud.artifactregistry_v1.types.ImportAptArtifactsGcsSource

parent

The name of the parent resource where the artifacts will be imported.

Type

str

class google.cloud.artifactregistry_v1.types.ImportAptArtifactsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The response message from importing APT artifacts.

apt_artifacts

The Apt artifacts imported.

Type

MutableSequence[google.cloud.artifactregistry_v1.types.AptArtifact]

errors

Detailed error info for packages that were not imported.

Type

MutableSequence[google.cloud.artifactregistry_v1.types.ImportAptArtifactsErrorInfo]

class google.cloud.artifactregistry_v1.types.ImportYumArtifactsErrorInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Error information explaining why a package was not imported.

gcs_source

Google Cloud Storage location requested.

This field is a member of oneof source.

Type

google.cloud.artifactregistry_v1.types.ImportYumArtifactsGcsSource

error

The detailed error status.

Type

google.rpc.status_pb2.Status

class google.cloud.artifactregistry_v1.types.ImportYumArtifactsGcsSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Google Cloud Storage location where the artifacts currently reside.

uris

Cloud Storage paths URI (e.g., gs://my_bucket//my_object).

Type

MutableSequence[str]

use_wildcards

Supports URI wildcards for matching multiple objects from a single URI.

Type

bool

class google.cloud.artifactregistry_v1.types.ImportYumArtifactsMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The operation metadata for importing artifacts.

class google.cloud.artifactregistry_v1.types.ImportYumArtifactsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to import new yum artifacts.

gcs_source

Google Cloud Storage location where input content is located.

This field is a member of oneof source.

Type

google.cloud.artifactregistry_v1.types.ImportYumArtifactsGcsSource

parent

The name of the parent resource where the artifacts will be imported.

Type

str

class google.cloud.artifactregistry_v1.types.ImportYumArtifactsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The response message from importing YUM artifacts.

yum_artifacts

The yum artifacts imported.

Type

MutableSequence[google.cloud.artifactregistry_v1.types.YumArtifact]

errors

Detailed error info for packages that were not imported.

Type

MutableSequence[google.cloud.artifactregistry_v1.types.ImportYumArtifactsErrorInfo]

class google.cloud.artifactregistry_v1.types.ListAttachmentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to list attachments.

parent

Required. The name of the parent resource whose attachments will be listed.

Type

str

filter

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

• target

• type

• attachment_namespace

Type

str

page_size

The maximum number of attachments to return. Maximum page size is 1,000.

Type

int

page_token

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

Type

str

class google.cloud.artifactregistry_v1.types.ListAttachmentsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The response from listing attachments.

attachments

The attachments returned.

Type

MutableSequence[google.cloud.artifactregistry_v1.types.Attachment]

next_page_token

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

Type

str

class google.cloud.artifactregistry_v1.types.ListDockerImagesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to list docker images.

parent

Required. The name of the parent resource whose docker images will be listed.

Type

str

page_size

The maximum number of artifacts to return. Maximum page size is 1,000.

Type

int

page_token

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

Type

str

order_by

The field to order the results by.

Type

str

class google.cloud.artifactregistry_v1.types.ListDockerImagesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The response from listing docker images.

docker_images

The docker images returned.

Type

MutableSequence[google.cloud.artifactregistry_v1.types.DockerImage]

next_page_token

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

Type

str

class google.cloud.artifactregistry_v1.types.ListFilesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to list files.

parent

Required. The name of the repository whose files will be listed. For example: “projects/p1/locations/us-central1/repositories/repo1

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

• annotations

Examples of using a filter:

To filter the results of your request to files with the name my_file.txt in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request:

• name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt"

You can also use wildcards to match any number of characters before or after the value:

• name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-*"

• name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt"

• name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file*"

To filter the results of your request to files owned by the version 1.0 in package pkg1, append the following filter expression to your request:

• owner="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"

To filter the results of your request to files with the annotation key-value pair [external_link: external_link_value], append the following filter expression to your request:

• "annotations.external_link:external_link_value"

To filter just for a specific annotation key external_link, append the following filter expression to your request:

• "annotations.external_link"

If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [external.link:https://example.com/my-file], append the following filter expression to your request:

• "annotations.`external.link:https://example.com/my-file”`

You can also filter with annotations with a wildcard to match any number of characters before or after the value:

• "annotations.*_link:`*example.com*”`

Type

str

page_size

The maximum number of files to return. Maximum page size is 1,000.

Type

int

page_token

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

Type

str

order_by

The field to order the results by.

Type

str

class google.cloud.artifactregistry_v1.types.ListFilesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The response from listing files.

files

The files returned.

Type

MutableSequence[google.cloud.artifactregistry_v1.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

class google.cloud.artifactregistry_v1.types.ListMavenArtifactsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to list maven artifacts.

parent

Required. The name of the parent resource whose maven artifacts will be listed.

Type

str

page_size

The maximum number of artifacts to return. Maximum page size is 1,000.

Type

int

page_token

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

Type

str

class google.cloud.artifactregistry_v1.types.ListMavenArtifactsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The response from listing maven artifacts.

maven_artifacts

The maven artifacts returned.

Type

MutableSequence[google.cloud.artifactregistry_v1.types.MavenArtifact]

next_page_token

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

Type

str

class google.cloud.artifactregistry_v1.types.ListNpmPackagesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to list npm packages.

parent

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

Type

str

page_size

The maximum number of artifacts to return. Maximum page size is 1,000.

Type

int

page_token

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

Type

str

class google.cloud.artifactregistry_v1.types.ListNpmPackagesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The response from listing npm packages.

npm_packages

The npm packages returned.

Type

MutableSequence[google.cloud.artifactregistry_v1.types.NpmPackage]

next_page_token

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

Type

str

class google.cloud.artifactregistry_v1.types.ListPackagesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to list packages.

parent

Required. 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 1,000.

Type

int

page_token

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

Type

str

filter

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

• name

• annotations

Examples of using a filter:

To filter the results of your request to packages with the name my-package in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request:

• name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package"

You can also use wildcards to match any number of characters before or after the value:

• name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-*"

• name="projects/my-project/locations/us-central1/repositories/my-repo/packages/*package"

• name="projects/my-project/locations/us-central1/repositories/my-repo/packages/*pack*"

To filter the results of your request to packages with the annotation key-value pair [external_link: external_link_value], append the following filter expression to your request”:

• "annotations.external_link:external_link_value"

To filter the results just for a specific annotation key external_link, append the following filter expression to your request:

• "annotations.external_link"

If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to packages with the annotation key-value pair [external.link:https://example.com/my-package], append the following filter expression to your request:

• "annotations.`external.link:https://example.com/my-package”`

You can also filter with annotations with a wildcard to match any number of characters before or after the value:

• "annotations.*_link:`*example.com*”`

Type

str

order_by

Optional. The field to order the results by.

Type

str

class google.cloud.artifactregistry_v1.types.ListPackagesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The response from listing packages.

packages

The packages returned.

Type

MutableSequence[google.cloud.artifactregistry_v1.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

class google.cloud.artifactregistry_v1.types.ListPythonPackagesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to list python packages.

parent

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

Type

str

page_size

The maximum number of artifacts to return. Maximum page size is 1,000.

Type

int

page_token

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

Type

str

class google.cloud.artifactregistry_v1.types.ListPythonPackagesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The response from listing python packages.

python_packages

The python packages returned.

Type

MutableSequence[google.cloud.artifactregistry_v1.types.PythonPackage]

next_page_token

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

Type

str

class google.cloud.artifactregistry_v1.types.ListRepositoriesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to list repositories.

parent

Required. 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 1,000.

Type

int

page_token

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

Type

str

filter

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

• name

Examples of using a filter:

To filter the results of your request to repositories with the name my-repo in project my-project in the us-central region, append the following filter expression to your request:

• name="projects/my-project/locations/us-central1/repositories/my-repo"

You can also use wildcards to match any number of characters before or after the value:

• name="projects/my-project/locations/us-central1/repositories/my-*"

• name="projects/my-project/locations/us-central1/repositories/*repo"

• name="projects/my-project/locations/us-central1/repositories/*repo*"

Type

str

order_by

Optional. The field to order the results by.

Type

str

class google.cloud.artifactregistry_v1.types.ListRepositoriesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The response from listing repositories.

repositories

The repositories returned.

Type

MutableSequence[google.cloud.artifactregistry_v1.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

class google.cloud.artifactregistry_v1.types.ListRulesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to list rules.

parent

Required. The name of the parent repository whose rules will be listed. For example: projects/p1/locations/us-central1/repositories/repo1.

Type

str

page_size

The maximum number of rules to return. Maximum page size is 1,000.

Type

int

page_token

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

Type

str

class google.cloud.artifactregistry_v1.types.ListRulesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The response from listing rules.

rules

The rules returned.

Type

MutableSequence[google.cloud.artifactregistry_v1.types.Rule]

next_page_token

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

Type

str

class google.cloud.artifactregistry_v1.types.ListTagsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to list tags.

parent

The name of the parent package whose tags will be listed. For example: projects/p1/locations/us-central1/repositories/repo1/packages/pkg1.

Type

str

filter

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

• name

• version

Examples of using a filter:

To filter the results of your request to tags with the name my-tag in package my-package in repository my-repo in project “y-project in the us-central region, append the following filter expression to your request:

• name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag"

You can also use wildcards to match any number of characters before or after the value:

• name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*"

• name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag"

• name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*"

To filter the results of your request to tags applied to the version 1.0 in package my-package, append the following filter expression to your request:

• version="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"

Type

str

page_size

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

Type

int

page_token

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

Type

str

class google.cloud.artifactregistry_v1.types.ListTagsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The response from listing tags.

tags

The tags returned.

Type

MutableSequence[google.cloud.artifactregistry_v1.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

class google.cloud.artifactregistry_v1.types.ListVersionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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 1,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_v1.types.VersionView

order_by

Optional. The field to order the results by.

Type

str

filter

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

• name

• annotations

Examples of using a filter:

To filter the results of your request to versions with the name my-version in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request:

• name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/my-version"

You can also use wildcards to match any number of characters before or after the value:

• name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/*version"

• name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/my*"

• name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/*version*"

To filter the results of your request to versions with the annotation key-value pair [external_link: external_link_value], append the following filter expression to your request:

• "annotations.external_link:external_link_value"

To filter just for a specific annotation key external_link, append the following filter expression to your request:

• "annotations.external_link"

If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to versions with the annotation key-value pair [external.link:https://example.com/my-version], append the following filter expression to your request:

• "annotations.`external.link:https://example.com/my-version”`

You can also filter with annotations with a wildcard to match any number of characters before or after the value:

• "annotations.*_link:`*example.com*”`

Type

str

class google.cloud.artifactregistry_v1.types.ListVersionsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The response from listing versions.

versions

The versions returned.

Type

MutableSequence[google.cloud.artifactregistry_v1.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

class google.cloud.artifactregistry_v1.types.MavenArtifact(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

MavenArtifact represents a maven artifact.

name

Required. registry_location, project_id, repository_name and maven_artifact forms a unique artifact For example, “projects/test-project/locations/us-west4/repositories/test-repo/mavenArtifacts/ com.google.guava:guava:31.0-jre”, where “us-west4” is the registry_location, “test-project” is the project_id, “test-repo” is the repository_name and “com.google.guava:guava:31.0-jre” is the maven artifact.

Type

str

pom_uri

Required. URL to access the pom file of the artifact. Example:

us-west4-maven.pkg.dev/test-project/test-repo/com/google/guava/guava/31.0/guava-31.0.pom

Type

str

group_id

Group ID for the artifact. Example:

com.google.guava

Type

str

artifact_id

Artifact ID for the artifact.

Type

str

version

Version of this artifact.

Type

str

create_time

Output only. Time the artifact was created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. Time the artifact was updated.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.artifactregistry_v1.types.NpmPackage(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

NpmPackage represents an npm artifact.

name

Required. registry_location, project_id, repository_name and npm_package forms a unique package For example, “projects/test-project/locations/us-west4/repositories/test-repo/npmPackages/ npm_test:1.0.0”, where “us-west4” is the registry_location, “test-project” is the project_id, “test-repo” is the repository_name and npm_test:1.0.0” is the npm package.

Type

str

package_name

Package for the artifact.

Type

str

version

Version of this package.

Type

str

tags

Tags attached to this package.

Type

MutableSequence[str]

create_time

Output only. Time the package was created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. Time the package was updated.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.artifactregistry_v1.types.OperationMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Metadata type for longrunning-operations, currently empty.

class google.cloud.artifactregistry_v1.types.Package(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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. If the package ID part contains slashes, the slashes are escaped.

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

annotations

Optional. Client specified annotations.

Type

MutableMapping[str, str]

class AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.artifactregistry_v1.types.ProjectSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The Artifact Registry settings that apply to a Project.

name

The name of the project’s settings.

Always of the form:

projects/{project-id}/projectSettings

In update request: never set In response: always set

Type

str

legacy_redirection_state

The redirection state of the legacy repositories in this project.

Type

google.cloud.artifactregistry_v1.types.ProjectSettings.RedirectionState

pull_percent

The percentage of pull traffic to redirect from GCR to AR when using partial redirection.

Type

int

class RedirectionState(value)

Bases: proto.enums.Enum

The possible redirection states for legacy repositories.

Values:

REDIRECTION_STATE_UNSPECIFIED (0):

No redirection status has been set.

REDIRECTION_FROM_GCR_IO_DISABLED (1):

Redirection is disabled.

REDIRECTION_FROM_GCR_IO_ENABLED (2):

Redirection is enabled.

REDIRECTION_FROM_GCR_IO_FINALIZED (3):

Redirection is enabled, and has been finalized so cannot be reverted.

REDIRECTION_FROM_GCR_IO_ENABLED_AND_COPYING (5):

Redirection is enabled and missing images are copied from GCR

REDIRECTION_FROM_GCR_IO_PARTIAL_AND_COPYING (6):

Redirection is partially enabled and missing images are copied from GCR

class google.cloud.artifactregistry_v1.types.PythonPackage(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

PythonPackage represents a python artifact.

name

Required. registry_location, project_id, repository_name and python_package forms a unique package name:projects/<project_id>/locations/<location>/repository/<repository_name>/pythonPackages/<python_package>. For example, “projects/test-project/locations/us-west4/repositories/test-repo/pythonPackages/ python_package:1.0.0”, where “us-west4” is the registry_location, “test-project” is the project_id, “test-repo” is the repository_name and python_package:1.0.0” is the python package.

Type

str

uri

Required. URL to access the package. Example: us-west4-python.pkg.dev/test-project/test-repo/python_package/file-name-1.0.0.tar.gz

Type

str

package_name

Package for the artifact.

Type

str

version

Version of this package.

Type

str

create_time

Output only. Time the package was created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. Time the package was updated.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Remote repository configuration.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

docker_repository

Specific settings for a Docker remote repository.

This field is a member of oneof remote_source.

Type

google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig.DockerRepository

maven_repository

Specific settings for a Maven remote repository.

This field is a member of oneof remote_source.

Type

google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig.MavenRepository

npm_repository

Specific settings for an Npm remote repository.

This field is a member of oneof remote_source.

Type

google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig.NpmRepository

python_repository

Specific settings for a Python remote repository.

This field is a member of oneof remote_source.

Type

google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig.PythonRepository

apt_repository

Specific settings for an Apt remote repository.

This field is a member of oneof remote_source.

Type

google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig.AptRepository

yum_repository

Specific settings for a Yum remote repository.

This field is a member of oneof remote_source.

Type

google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig.YumRepository

common_repository

Common remote repository settings. Used as the remote repository upstream URL.

This field is a member of oneof remote_source.

Type

google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig.CommonRemoteRepository

description

The description of the remote source.

Type

str

upstream_credentials

Optional. The credentials used to access the remote repository.

Type

google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig.UpstreamCredentials

disable_upstream_validation

Input only. A create/update remote repo option to avoid making a HEAD/GET request to validate a remote repo and any supplied upstream credentials.

Type

bool

class AptRepository(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration for an Apt remote repository.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

public_repository

One of the publicly available Apt repositories supported by Artifact Registry.

This field is a member of oneof upstream.

Type

google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig.AptRepository.PublicRepository

custom_repository

Customer-specified remote repository.

This field is a member of oneof upstream.

Type

google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig.AptRepository.CustomRepository

class CustomRepository(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Customer-specified publicly available remote repository.

uri

An http/https uri reference to the upstream remote repository, for ex: “https://my.apt.registry/”.

Type

str

class PublicRepository(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Publicly available Apt repositories constructed from a common repository base and a custom repository path.

repository_base

A common public repository base for Apt.

Type

google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig.AptRepository.PublicRepository.RepositoryBase

repository_path

A custom field to define a path to a specific repository from the base.

Type

str

class RepositoryBase(value)

Bases: proto.enums.Enum

Predefined list of publicly available repository bases for Apt.

Values:

REPOSITORY_BASE_UNSPECIFIED (0):

Unspecified repository base.

DEBIAN (1):

Debian.

UBUNTU (2):

Ubuntu LTS/Pro.

DEBIAN_SNAPSHOT (3):

Archived Debian.

class CommonRemoteRepository(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Common remote repository settings type.

uri

Required. A common public repository base for remote repository.

Type

str

class DockerRepository(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration for a Docker remote repository.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

public_repository

One of the publicly available Docker repositories supported by Artifact Registry.

This field is a member of oneof upstream.

Type

google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig.DockerRepository.PublicRepository

custom_repository

Customer-specified remote repository.

This field is a member of oneof upstream.

Type

google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig.DockerRepository.CustomRepository

class CustomRepository(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Customer-specified publicly available remote repository.

uri

An http/https uri reference to the custom remote repository, for ex: “https://registry-1.docker.io”.

Type

str

class PublicRepository(value)

Bases: proto.enums.Enum

Predefined list of publicly available Docker repositories like Docker Hub.

Values:

PUBLIC_REPOSITORY_UNSPECIFIED (0):

Unspecified repository.

DOCKER_HUB (1):

Docker Hub.

class MavenRepository(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration for a Maven remote repository.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

public_repository

One of the publicly available Maven repositories supported by Artifact Registry.

This field is a member of oneof upstream.

Type

google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig.MavenRepository.PublicRepository

custom_repository

Customer-specified remote repository.

This field is a member of oneof upstream.

Type

google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig.MavenRepository.CustomRepository

class CustomRepository(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Customer-specified publicly available remote repository.

uri

An http/https uri reference to the upstream remote repository, for ex: “https://my.maven.registry/”.

Type

str

class PublicRepository(value)

Bases: proto.enums.Enum

Predefined list of publicly available Maven repositories like Maven Central.

Values:

PUBLIC_REPOSITORY_UNSPECIFIED (0):

Unspecified repository.

MAVEN_CENTRAL (1):

Maven Central.

class NpmRepository(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration for a Npm remote repository.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

public_repository

One of the publicly available Npm repositories supported by Artifact Registry.

This field is a member of oneof upstream.

Type

google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig.NpmRepository.PublicRepository

custom_repository

Customer-specified remote repository.

This field is a member of oneof upstream.

Type

google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig.NpmRepository.CustomRepository

class CustomRepository(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Customer-specified publicly available remote repository.

uri

An http/https uri reference to the upstream remote repository, for ex: “https://my.npm.registry/”.

Type

str

class PublicRepository(value)

Bases: proto.enums.Enum

Predefined list of publicly available NPM repositories like npmjs.

Values:

PUBLIC_REPOSITORY_UNSPECIFIED (0):

Unspecified repository.

NPMJS (1):

npmjs.

class PythonRepository(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration for a Python remote repository.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

public_repository

One of the publicly available Python repositories supported by Artifact Registry.

This field is a member of oneof upstream.

Type

google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig.PythonRepository.PublicRepository

custom_repository

Customer-specified remote repository.

This field is a member of oneof upstream.

Type

google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig.PythonRepository.CustomRepository

class CustomRepository(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Customer-specified publicly available remote repository.

uri

An http/https uri reference to the upstream remote repository, for ex: “https://my.python.registry/”.

Type

str

class PublicRepository(value)

Bases: proto.enums.Enum

Predefined list of publicly available Python repositories like PyPI.org.

Values:

PUBLIC_REPOSITORY_UNSPECIFIED (0):

Unspecified repository.

PYPI (1):

PyPI.

class UpstreamCredentials(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The credentials to access the remote repository.

username_password_credentials

Use username and password to access the remote repository.

This field is a member of oneof credentials.

Type

google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig.UpstreamCredentials.UsernamePasswordCredentials

class UsernamePasswordCredentials(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Username and password credentials.

username

The username to access the remote repository.

Type

str

password_secret_version

The Secret Manager key version that holds the password to access the remote repository. Must be in the format of projects/{project}/secrets/{secret}/versions/{version}.

Type

str

class YumRepository(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Configuration for a Yum remote repository.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

public_repository

One of the publicly available Yum repositories supported by Artifact Registry.

This field is a member of oneof upstream.

Type

google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig.YumRepository.PublicRepository

custom_repository

Customer-specified remote repository.

This field is a member of oneof upstream.

Type

google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig.YumRepository.CustomRepository

class CustomRepository(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Customer-specified publicly available remote repository.

uri

An http/https uri reference to the upstream remote repository, for ex: “https://my.yum.registry/”.

Type

str

class PublicRepository(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Publicly available Yum repositories constructed from a common repository base and a custom repository path.

repository_base

A common public repository base for Yum.

Type

google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig.YumRepository.PublicRepository.RepositoryBase

repository_path

A custom field to define a path to a specific repository from the base.

Type

str

class RepositoryBase(value)

Bases: proto.enums.Enum

Predefined list of publicly available repository bases for Yum.

Values:

REPOSITORY_BASE_UNSPECIFIED (0):

Unspecified repository base.

CENTOS (1):

CentOS.

CENTOS_DEBUG (2):

CentOS Debug.

CENTOS_VAULT (3):

CentOS Vault.

CENTOS_STREAM (4):

CentOS Stream.

ROCKY (5):

Rocky.

EPEL (6):

Fedora Extra Packages for Enterprise Linux (EPEL).

class google.cloud.artifactregistry_v1.types.Repository(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A Repository for storing artifacts with a specific format.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

maven_config

Maven repository config contains repository level configuration for the repositories of maven type.

This field is a member of oneof format_config.

Type

google.cloud.artifactregistry_v1.types.Repository.MavenRepositoryConfig

docker_config

Docker repository config contains repository level configuration for the repositories of docker type.

This field is a member of oneof format_config.

Type

google.cloud.artifactregistry_v1.types.Repository.DockerRepositoryConfig

virtual_repository_config

Configuration specific for a Virtual Repository.

This field is a member of oneof mode_config.

Type

google.cloud.artifactregistry_v1.types.VirtualRepositoryConfig

remote_repository_config

Configuration specific for a Remote Repository.

This field is a member of oneof mode_config.

Type

google.cloud.artifactregistry_v1.types.RemoteRepositoryConfig

name

The name of the repository, for example: projects/p1/locations/us-central1/repositories/repo1. For each location in a project, repository names must be unique.

Type

str

format_

Optional. The format of packages that are stored in the repository.

Type

google.cloud.artifactregistry_v1.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

MutableMapping[str, str]

create_time

Output only. The time when the repository was created.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. 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

mode

Optional. The mode of the repository.

Type

google.cloud.artifactregistry_v1.types.Repository.Mode

cleanup_policies

Optional. Cleanup policies for this repository. Cleanup policies indicate when certain package versions can be automatically deleted. Map keys are policy IDs supplied by users during policy creation. They must unique within a repository and be under 128 characters in length.

Type

MutableMapping[str, google.cloud.artifactregistry_v1.types.CleanupPolicy]

size_bytes

Output only. The size, in bytes, of all artifact storage in this repository. Repositories that are generally available or in public preview use this to calculate storage costs.

Type

int

satisfies_pzs

Output only. If set, the repository satisfies physical zone separation.

Type

bool

cleanup_policy_dry_run

Optional. If true, the cleanup pipeline is prevented from deleting versions in this repository.

Type

bool

vulnerability_scanning_config

Optional. Config and state for vulnerability scanning of resources within this Repository.

Type

google.cloud.artifactregistry_v1.types.Repository.VulnerabilityScanningConfig

disallow_unspecified_mode

Optional. If this is true, an unspecified repo type will be treated as error rather than defaulting to standard.

Type

bool

satisfies_pzi

Output only. If set, the repository satisfies physical zone isolation.

Type

bool

class CleanupPoliciesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class DockerRepositoryConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

DockerRepositoryConfig is docker related repository details. Provides additional configuration details for repositories of the docker format type.

immutable_tags

The repository which enabled this flag prevents all tags from being modified, moved or deleted. This does not prevent tags from being created.

Type

bool

class Format(value)

Bases: proto.enums.Enum

A package format.

Values:

FORMAT_UNSPECIFIED (0):

Unspecified package format.

DOCKER (1):

Docker package format.

MAVEN (2):

Maven package format.

NPM (3):

NPM package format.

APT (5):

APT package format.

YUM (6):

YUM package format.

PYTHON (8):

Python package format.

KFP (9):

Kubeflow Pipelines package format.

GO (10):

Go package format.

GENERIC (11):

Generic package format.

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class MavenRepositoryConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

MavenRepositoryConfig is maven related repository details. Provides additional configuration details for repositories of the maven format type.

allow_snapshot_overwrites

The repository with this flag will allow publishing the same snapshot versions.

Type

bool

version_policy

Version policy defines the versions that the registry will accept.

Type

google.cloud.artifactregistry_v1.types.Repository.MavenRepositoryConfig.VersionPolicy

class VersionPolicy(value)

Bases: proto.enums.Enum

VersionPolicy is the version policy for the repository.

Values:

VERSION_POLICY_UNSPECIFIED (0):

VERSION_POLICY_UNSPECIFIED - the version policy is not defined. When the version policy is not defined, no validation is performed for the versions.

RELEASE (1):

RELEASE - repository will accept only Release versions.

SNAPSHOT (2):

SNAPSHOT - repository will accept only Snapshot versions.

class Mode(value)

Bases: proto.enums.Enum

The mode configures the repository to serve artifacts from different sources.

Values:

MODE_UNSPECIFIED (0):

Unspecified mode.

STANDARD_REPOSITORY (1):

A standard repository storing artifacts.

VIRTUAL_REPOSITORY (2):

A virtual repository to serve artifacts from one or more sources.

REMOTE_REPOSITORY (3):

A remote repository to serve artifacts from a remote source.

class VulnerabilityScanningConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Config on whether to perform vulnerability scanning for resources in this repository, as well as output fields describing current state.

enablement_config

Optional. Config for whether this repository has vulnerability scanning disabled.

Type

google.cloud.artifactregistry_v1.types.Repository.VulnerabilityScanningConfig.EnablementConfig

last_enable_time

Output only. The last time this repository config was enabled.

Type

google.protobuf.timestamp_pb2.Timestamp

enablement_state

Output only. State of feature enablement, combining repository enablement config and API enablement state.

Type

google.cloud.artifactregistry_v1.types.Repository.VulnerabilityScanningConfig.EnablementState

enablement_state_reason

Output only. Reason for the repository state.

Type

str

class EnablementConfig(value)

Bases: proto.enums.Enum

Config for vulnerability scanning of resources in this repository.

Values:

ENABLEMENT_CONFIG_UNSPECIFIED (0):

Not set. This will be treated as INHERITED.

INHERITED (1):

Scanning is Enabled, but dependent on API enablement.

DISABLED (2):

No automatic vulnerability scanning will be performed for this repository.

class EnablementState(value)

Bases: proto.enums.Enum

Describes the state of vulnerability scanning in this repository, including both repository enablement and API enablement.

Values:

ENABLEMENT_STATE_UNSPECIFIED (0):

Enablement state is unclear.

SCANNING_UNSUPPORTED (1):

Repository does not support vulnerability scanning.

SCANNING_DISABLED (2):

Vulnerability scanning is disabled for this repository.

SCANNING_ACTIVE (3):

Vulnerability scanning is active for this repository.

class google.cloud.artifactregistry_v1.types.Rule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A rule defines the deny or allow action of the operation it applies to and the conditions required for the rule to apply. You can set one rule for an entire repository and one rule for each package within.

name

The name of the rule, for example: projects/p1/locations/us-central1/repositories/repo1/rules/rule1.

Type

str

action

The action this rule takes.

Type

google.cloud.artifactregistry_v1.types.Rule.Action

operation

Type

google.cloud.artifactregistry_v1.types.Rule.Operation

condition

Optional. A CEL expression for conditions that must be met in order for the rule to apply. If not provided, the rule matches all objects.

Type

google.type.expr_pb2.Expr

package_id

The package ID the rule applies to. If empty, this rule applies to all packages inside the repository.

Type

str

class Action(value)

Bases: proto.enums.Enum

Defines the action of the rule.

Values:

ACTION_UNSPECIFIED (0):

Action not specified.

ALLOW (1):

Allow the operation.

DENY (2):

Deny the operation.

class Operation(value)

Bases: proto.enums.Enum

The operation the rule applies to.

Values:

OPERATION_UNSPECIFIED (0):

Operation not specified.

DOWNLOAD (1):

Download operation.

class google.cloud.artifactregistry_v1.types.Tag(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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”. 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.

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 If the package or version ID parts contain slashes, the slashes are escaped.

Type

str

class google.cloud.artifactregistry_v1.types.UpdateFileRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to update a file.

file

Required. The File that replaces the resource on the server.

Type

google.cloud.artifactregistry_v1.types.File

update_mask

Required. 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_v1.types.UpdatePackageRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to update a package.

package

The package that replaces the resource on the server.

Type

google.cloud.artifactregistry_v1.types.Package

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_v1.types.UpdateProjectSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Sets the settings of the project.

project_settings

The project settings.

Type

google.cloud.artifactregistry_v1.types.ProjectSettings

update_mask

Field mask to support partial updates.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.artifactregistry_v1.types.UpdateRepositoryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to update a repository.

repository

The repository that replaces the resource on the server.

Type

google.cloud.artifactregistry_v1.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_v1.types.UpdateRuleRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to update a rule.

rule

The rule that replaces the resource on the server.

Type

google.cloud.artifactregistry_v1.types.Rule

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_v1.types.UpdateTagRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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_v1.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_v1.types.UpdateVPCSCConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Sets the VPCSC config of the project.

vpcsc_config

The project config.

Type

google.cloud.artifactregistry_v1.types.VPCSCConfig

update_mask

Field mask to support partial updates.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.cloud.artifactregistry_v1.types.UpdateVersionRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The request to update a version.

version

Required. The Version that replaces the resource on the server.

Type

google.cloud.artifactregistry_v1.types.Version

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_v1.types.UpstreamPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Artifact policy configuration for the repository contents.

id

The user-provided ID of the upstream policy.

Type

str

repository

A reference to the repository resource, for example: projects/p1/locations/us-central1/repositories/repo1.

Type

str

priority

Entries with a greater priority value take precedence in the pull order.

Type

int

class google.cloud.artifactregistry_v1.types.VPCSCConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The Artifact Registry VPC SC config that apply to a Project.

name

The name of the project’s VPC SC Config.

Always of the form:

projects/{projectID}/locations/{location}/vpcscConfig

In update request: never set In response: always set

Type

str

vpcsc_policy

The project per location VPC SC policy that defines the VPC SC behavior for the Remote Repository (Allow/Deny).

Type

google.cloud.artifactregistry_v1.types.VPCSCConfig.VPCSCPolicy

class VPCSCPolicy(value)

Bases: proto.enums.Enum

VPCSCPolicy is the VPC SC policy for project and location.

Values:

VPCSC_POLICY_UNSPECIFIED (0):

VPCSC_POLICY_UNSPECIFIED - the VPS SC policy is not defined. When VPS SC policy is not defined - the Service will use the default behavior (VPCSC_DENY).

DENY (1):

VPCSC_DENY - repository will block the requests to the Upstreams for the Remote Repositories if the resource is in the perimeter.

ALLOW (2):

VPCSC_ALLOW - repository will allow the requests to the Upstreams for the Remote Repositories if the resource is in the perimeter.

class google.cloud.artifactregistry_v1.types.Version(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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. If the package or version ID parts contain slashes, the slashes are escaped.

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

MutableSequence[google.cloud.artifactregistry_v1.types.Tag]

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][google.devtools.artifactregistry.v1.DockerImage] [MavenArtifact][google.devtools.artifactregistry.v1.MavenArtifact]

Type

google.protobuf.struct_pb2.Struct

annotations

Optional. Client specified annotations.

Type

MutableMapping[str, str]

class AnnotationsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

class google.cloud.artifactregistry_v1.types.VersionView(value)

Bases: proto.enums.Enum

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

Values:

VERSION_VIEW_UNSPECIFIED (0):

The default / unset value. The API will default to the BASIC view.

BASIC (1):

Includes basic information about the version, but not any related tags.

FULL (2):

Include everything.

class google.cloud.artifactregistry_v1.types.VirtualRepositoryConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Virtual repository configuration.

upstream_policies

Policies that configure the upstream artifacts distributed by the Virtual Repository. Upstream policies cannot be set on a standard repository.

Type

MutableSequence[google.cloud.artifactregistry_v1.types.UpstreamPolicy]

class google.cloud.artifactregistry_v1.types.YumArtifact(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A detailed representation of a Yum artifact.

name

Output only. The Artifact Registry resource name of the artifact.

Type

str

package_name

Output only. The yum package name of the artifact.

Type

str

package_type

Output only. An artifact is a binary or source package.

Type

google.cloud.artifactregistry_v1.types.YumArtifact.PackageType

architecture

Output only. Operating system architecture of the artifact.

Type

str

class PackageType(value)

Bases: proto.enums.Enum

Package type is either binary or source.

Values:

PACKAGE_TYPE_UNSPECIFIED (0):

Package type is not specified.

BINARY (1):

Binary package (.rpm).

SOURCE (2):

Source package (.srpm).