Package google.devtools.artifactregistry.v1alpha1

Index

ArtifactRegistry

The Artifact Registry API service.

Artifact Registry is an artifact management system for storing artifacts from different package management systems.

The resources managed by this API are:

  • Repositories, which group packages and their data.
  • Packages, which group versions and their tags.
  • Versions, which are specific forms of a package.
  • Tags, which represent alternative names for versions.
  • Files, which contain content and are optionally associated with a Package or Version.
CreateRepository
DeleteRepository
GetRepository
ImportAptArtifacts
ImportGoogetArtifacts
ImportYumArtifacts
ListRepositories
UpdateRepository

AptArtifact

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

Fields
name

string

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

package_name

string

Output only. The Apt package name of the artifact.

package_type

PackageType

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

architecture

string

Output only. Operating system architecture of the artifact.

component

string

Output only. Repository component of the artifact.

control_file

bytes

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

PackageType

Package type is either binary or source.

Enums
PACKAGE_TYPE_UNSPECIFIED Package type is not specified.
BINARY Binary package.
SOURCE Source package.

CreateRepositoryRequest

The request to create a new repository.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • artifactregistry.repositories.create
repository_id

string

Required. The repository id to use for this repository.

repository

Repository

Required. The repository to be created.

DeleteRepositoryRequest

The request to delete a repository.

Fields
name

string

Required. The name of the repository to delete.

Authorization requires the following IAM permission on the specified resource name:

  • artifactregistry.repositories.delete

GetRepositoryRequest

The request to retrieve a repository.

Fields
name

string

Required. The name of the repository to retrieve.

Authorization requires the following IAM permission on the specified resource name:

  • artifactregistry.repositories.get

GoogetArtifact

A detailed representation of a GooGet artifact.

Fields
name

string

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

package_name

string

Output only. The GooGet package name of the artifact.

architecture

string

Output only. Operating system architecture of the artifact.

ImportAptArtifactsErrorInfo

Error information explaining why a package was not imported.

Fields
error

Status

The detailed error status.

Union field source. The source that was not imported. source can be only one of the following:
gcs_source

ImportAptArtifactsGcsSource

Google Cloud Storage location requested.

ImportAptArtifactsGcsSource

Google Cloud Storage location where the artifacts currently reside.

Fields
uris[]

string

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

use_wildcards

bool

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

ImportAptArtifactsMetadata

This type has no fields.

The operation metadata for importing artifacts.

ImportAptArtifactsRequest

The request to import new apt artifacts.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • artifactregistry.aptartifacts.create
Union field source. The source location of the package binaries. source can be only one of the following:
gcs_source

ImportAptArtifactsGcsSource

Google Cloud Storage location where input content is located.

ImportAptArtifactsResponse

The response message from importing APT artifacts.

Fields
apt_artifacts[]

AptArtifact

The Apt artifacts imported.

errors[]

ImportAptArtifactsErrorInfo

Detailed error info for packages that were not imported.

ImportGoogetArtifactsErrorInfo

Error information explaining why a package was not imported.

Fields
error

Status

The detailed error status.

Union field source. The source that was not imported. source can be only one of the following:
gcs_source

ImportGoogetArtifactsGcsSource

Google Cloud Storage location requested.

ImportGoogetArtifactsGcsSource

Google Cloud Storage location where the artifacts currently reside.

Fields
uris[]

string

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

use_wildcards

bool

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

ImportGoogetArtifactsMetadata

This type has no fields.

The operation metadata for importing artifacts.

ImportGoogetArtifactsRequest

The request to import new googet artifacts.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • artifactregistry.googetartifacts.create
Union field source. The source location of the package binaries. source can be only one of the following:
gcs_source

ImportGoogetArtifactsGcsSource

Google Cloud Storage location where input content is located.

ImportGoogetArtifactsResponse

The response message from importing artifacts.

Fields
googet_artifacts[]

GoogetArtifact

The GooGet artifacts updated.

errors[]

ImportGoogetArtifactsErrorInfo

Detailed error info for packages that were not imported.

ImportYumArtifactsErrorInfo

Error information explaining why a package was not imported.

Fields
error

Status

The detailed error status.

Union field source. The source that was not imported. source can be only one of the following:
gcs_source

ImportYumArtifactsGcsSource

Google Cloud Storage location requested.

ImportYumArtifactsGcsSource

Google Cloud Storage location where the artifacts currently reside.

Fields
uris[]

string

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

use_wildcards

bool

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

ImportYumArtifactsMetadata

This type has no fields.

The operation metadata for importing artifacts.

ImportYumArtifactsRequest

The request to import new yum artifacts.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • artifactregistry.yumartifacts.create
Union field source. The source location of the package binaries. source can be only one of the following:
gcs_source

ImportYumArtifactsGcsSource

Google Cloud Storage location where input content is located.

ImportYumArtifactsResponse

The response message from importing YUM artifacts.

Fields
yum_artifacts[]

YumArtifact

The yum artifacts imported.

errors[]

ImportYumArtifactsErrorInfo

Detailed error info for packages that were not imported.

ListRepositoriesRequest

The request to list repositories.

Fields
parent

string

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

Authorization requires the following IAM permission on the specified resource parent:

  • artifactregistry.repositories.list
page_size

int32

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

page_token

string

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

order_by

string

Optional. The field to order the results by.

ListRepositoriesResponse

The response from listing repositories.

Fields
repositories[]

Repository

The repositories returned.

next_page_token

string

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

OperationMetadata

This type has no fields.

Metadata type for longrunning-operations, currently empty.

Repository

A Repository for storing artifacts with a specific format.

Fields
name

string

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.

format

Format

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

description

string

The user-provided description of the repository.

labels

map<string, string>

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

Timestamp

Output only. The time when the repository was created.

update_time

Timestamp

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

kms_key_name

string

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.

mode

Mode

Optional. The mode of the repository.

size_bytes

int64

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.

satisfies_pzs

bool

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

satisfies_pzi

bool

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

Format

A package format.

Enums
FORMAT_UNSPECIFIED Unspecified package format.
DOCKER Docker package format.
MAVEN Maven package format.
NPM NPM package format.
APT APT package format.
YUM YUM package format.
GOOGET GooGet package format.
PYTHON Python package format.

Mode

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

Enums
MODE_UNSPECIFIED Unspecified mode.
STANDARD_REPOSITORY A standard repository storing artifacts.
VIRTUAL_REPOSITORY A virtual repository to serve artifacts from one or more sources.

UpdateRepositoryRequest

The request to update a repository.

Fields
repository

Repository

The repository that replaces the resource on the server.

Authorization requires the following IAM permission on the specified resource repository:

  • artifactregistry.repositories.update
update_mask

FieldMask

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

UploadAptArtifactMetadata

This type has no fields.

The operation metadata for uploading artifacts.

UploadAptArtifactResponse

The response of the completed artifact upload operation. This response is contained in the Operation and available to users.

Fields
apt_artifacts[]

AptArtifact

The Apt artifacts updated.

UploadGoogetArtifactMetadata

This type has no fields.

The operation metadata for uploading artifacts.

UploadGoogetArtifactResponse

The response of the completed artifact upload operation. This response is contained in the Operation and available to users.

Fields
googet_artifacts[]

GoogetArtifact

The GooGet artifacts updated.

UploadYumArtifactMetadata

This type has no fields.

The operation metadata for uploading artifacts.

UploadYumArtifactResponse

The response of the completed artifact upload operation. This response is contained in the Operation and available to users.

Fields
yum_artifacts[]

YumArtifact

The Yum artifacts updated.

YumArtifact

A detailed representation of a Yum artifact.

Fields
name

string

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

package_name

string

Output only. The yum package name of the artifact.

package_type

PackageType

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

architecture

string

Output only. Operating system architecture of the artifact.

PackageType

Package type is either binary or source.

Enums
PACKAGE_TYPE_UNSPECIFIED Package type is not specified.
BINARY Binary package (.rpm).
SOURCE Source package (.srpm).