Types for Google Cloud Artifactregistry v1beta2 API¶
- class google.cloud.artifactregistry_v1beta2.types.AptArtifact(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
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
- package_type¶
Output only. An artifact is a binary or source package.
- class PackageType(value)[source]¶
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_v1beta2.types.CreateRepositoryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
The request to create a new repository.
- repository¶
The repository to be created.
- 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.
- tag¶
The tag to be created.
- 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.
- 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.
- 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.
- 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.
- 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%2Fb%2Fc.txt”. If the file ID part contains slashes, they are escaped.
- Type
- hashes¶
The hashes of the file content.
- Type
MutableSequence[google.cloud.artifactregistry_v1beta2.types.Hash]
- create_time¶
The time when the File was created.
- update_time¶
The time when the File was last updated.
- 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.
- 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.
- class google.cloud.artifactregistry_v1beta2.types.GetProjectSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Gets the redirection status for a project.
- 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.
- 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.
- 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.
- view¶
The view that should be returned in the response.
- 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.
- class HashType(value)[source]¶
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_v1beta2.types.ImportAptArtifactsErrorInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Error information explaining why a package was not imported.
- error¶
The detailed error status.
- Type
google.rpc.status_pb2.Status
- class google.cloud.artifactregistry_v1beta2.types.ImportAptArtifactsGcsSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Google Cloud Storage location where the artifacts currently reside.
- class google.cloud.artifactregistry_v1beta2.types.ImportAptArtifactsMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
The operation metadata for importing artifacts.
- class google.cloud.artifactregistry_v1beta2.types.ImportAptArtifactsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
The request to import new apt artifacts.
- class google.cloud.artifactregistry_v1beta2.types.ImportAptArtifactsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
The response message from importing APT artifacts.
- apt_artifacts¶
The Apt artifacts imported.
- Type
MutableSequence[google.cloud.artifactregistry_v1beta2.types.AptArtifact]
- errors¶
Detailed error info for artifacts that were not imported.
- Type
MutableSequence[google.cloud.artifactregistry_v1beta2.types.ImportAptArtifactsErrorInfo]
- class google.cloud.artifactregistry_v1beta2.types.ImportYumArtifactsErrorInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Error information explaining why a package was not imported.
- error¶
The detailed error status.
- Type
google.rpc.status_pb2.Status
- class google.cloud.artifactregistry_v1beta2.types.ImportYumArtifactsGcsSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Google Cloud Storage location where the artifacts currently reside.
- class google.cloud.artifactregistry_v1beta2.types.ImportYumArtifactsMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
The operation metadata for importing artifacts.
- class google.cloud.artifactregistry_v1beta2.types.ImportYumArtifactsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
The request to import new yum artifacts.
- class google.cloud.artifactregistry_v1beta2.types.ImportYumArtifactsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
The response message from importing YUM artifacts.
- yum_artifacts¶
The yum artifacts imported.
- Type
MutableSequence[google.cloud.artifactregistry_v1beta2.types.YumArtifact]
- errors¶
Detailed error info for artifacts that were not imported.
- Type
MutableSequence[google.cloud.artifactregistry_v1beta2.types.ImportYumArtifactsErrorInfo]
- 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 repository whose files will be listed. For example: “projects/p1/locations/us-central1/repositories/repo1
- Type
- 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 version1.0
in packagepkg1
.
- Type
- 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
MutableSequence[google.cloud.artifactregistry_v1beta2.types.File]
- class google.cloud.artifactregistry_v1beta2.types.ListPackagesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
The request to list packages.
- 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
MutableSequence[google.cloud.artifactregistry_v1beta2.types.Package]
- class google.cloud.artifactregistry_v1beta2.types.ListRepositoriesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
The request to list repositories.
- 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
MutableSequence[google.cloud.artifactregistry_v1beta2.types.Repository]
- class google.cloud.artifactregistry_v1beta2.types.ListTagsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
The request to list tags.
- 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 version1.0
in packagepkg1
.
- Type
- 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
MutableSequence[google.cloud.artifactregistry_v1beta2.types.Tag]
- class google.cloud.artifactregistry_v1beta2.types.ListVersionsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
The request to list versions.
- view¶
The view that should be returned in the response.
- 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
MutableSequence[google.cloud.artifactregistry_v1beta2.types.Version]
- 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
- create_time¶
The time when the package was created.
- update_time¶
The time when the package was last updated. This includes publishing a new version of the package.
- class google.cloud.artifactregistry_v1beta2.types.ProjectSettings(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
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
- legacy_redirection_state¶
The redirection state of the legacy repositories in this project.
- class RedirectionState(value)[source]¶
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.
- 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.
- maven_config¶
Maven repository config contains repository level configuration for the repositories of maven type.
This field is a member of oneof
format_config
.
- name¶
The name of the repository, for example:
“projects/p1/locations/us-central1/repositories/repo1”.
- Type
- format_¶
The format of packages that are stored in the repository.
- 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.
- create_time¶
The time when the repository was created.
- update_time¶
The time when the repository was last updated.
- 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
- class Format(value)[source]¶
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.
- class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)¶
Bases:
proto.message.Message
- class MavenRepositoryConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
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
- version_policy¶
Version policy defines the versions that the registry will accept.
- class VersionPolicy(value)[source]¶
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 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”. 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
- class google.cloud.artifactregistry_v1beta2.types.UpdateProjectSettingsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
Sets the settings of the project.
- project_settings¶
The project settings.
- update_mask¶
Field mask to support partial updates.
- 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.
- 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
- 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.
- 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
- 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”. If the package or version ID parts contain slashes, the slashes are escaped.
- Type
- create_time¶
The time when the version was created.
- update_time¶
The time when the version was last updated.
Output only. A list of related tags. Will contain up to 100 tags that reference this version.
- Type
MutableSequence[google.cloud.artifactregistry_v1beta2.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 only resource in use is [DockerImage][google.devtools.artifactregistry.v1.DockerImage]
- 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.
- 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_v1beta2.types.YumArtifact(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.Message
A detailed representation of a Yum artifact.
- package_type¶
Output only. An artifact is a binary or source package.
- class PackageType(value)[source]¶
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).