Index
ArtifactRegistry
(interface)AptArtifact
(message)AptArtifact.PackageType
(enum)CreateRepositoryRequest
(message)CreateTagRequest
(message)DeletePackageRequest
(message)DeleteRepositoryRequest
(message)DeleteTagRequest
(message)DeleteVersionRequest
(message)File
(message)GetFileRequest
(message)GetPackageRequest
(message)GetProjectSettingsRequest
(message)GetRepositoryRequest
(message)GetTagRequest
(message)GetVersionRequest
(message)Hash
(message)Hash.HashType
(enum)ImportAptArtifactsErrorInfo
(message)ImportAptArtifactsGcsSource
(message)ImportAptArtifactsMetadata
(message)ImportAptArtifactsRequest
(message)ImportAptArtifactsResponse
(message)ImportYumArtifactsErrorInfo
(message)ImportYumArtifactsGcsSource
(message)ImportYumArtifactsMetadata
(message)ImportYumArtifactsRequest
(message)ImportYumArtifactsResponse
(message)ListFilesRequest
(message)ListFilesResponse
(message)ListPackagesRequest
(message)ListPackagesResponse
(message)ListRepositoriesRequest
(message)ListRepositoriesResponse
(message)ListTagsRequest
(message)ListTagsResponse
(message)ListVersionsRequest
(message)ListVersionsResponse
(message)OperationMetadata
(message)Package
(message)ProjectSettings
(message)ProjectSettings.RedirectionState
(enum)Repository
(message)Repository.Format
(enum)Repository.MavenRepositoryConfig
(message)Repository.MavenRepositoryConfig.VersionPolicy
(enum)Tag
(message)UpdateProjectSettingsRequest
(message)UpdateRepositoryRequest
(message)UpdateTagRequest
(message)UploadAptArtifactMediaResponse
(message)UploadAptArtifactMetadata
(message)UploadAptArtifactRequest
(message)UploadAptArtifactResponse
(message)UploadYumArtifactMediaResponse
(message)UploadYumArtifactMetadata
(message)UploadYumArtifactRequest
(message)UploadYumArtifactResponse
(message)Version
(message)VersionView
(enum)YumArtifact
(message)YumArtifact.PackageType
(enum)
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 |
---|
Creates a repository. The returned Operation will finish once the repository has been created. Its response will be the created Repository.
|
CreateTag |
---|
Creates a tag.
|
DeletePackage |
---|
Deletes a package and all of its versions and tags. The returned operation will complete once the package has been deleted.
|
DeleteRepository |
---|
Deletes a repository and all of its contents. The returned Operation will finish once the repository has been deleted. It will not have any Operation metadata and will return a google.protobuf.Empty response.
|
DeleteTag |
---|
Deletes a tag.
|
DeleteVersion |
---|
Deletes a version and all of its content. The returned operation will complete once the version has been deleted.
|
GetFile |
---|
Gets a file.
|
GetIamPolicy |
---|
Gets the IAM policy for a given resource.
|
GetPackage |
---|
Gets a package.
|
GetProjectSettings |
---|
Retrieves the Settings for the Project.
|
GetRepository |
---|
Gets a repository.
|
GetTag |
---|
Gets a tag.
|
GetVersion |
---|
Gets a version
|
ImportAptArtifacts |
---|
Imports Apt artifacts. The returned Operation will complete once the resources are imported. Package, Version, and File resources are created based on the imported artifacts. Imported artifacts that conflict with existing resources are ignored.
|
ImportYumArtifacts |
---|
Imports Yum (RPM) artifacts. The returned Operation will complete once the resources are imported. Package, Version, and File resources are created based on the imported artifacts. Imported artifacts that conflict with existing resources are ignored.
|
ListFiles |
---|
Lists files.
|
ListPackages |
---|
Lists packages.
|
ListRepositories |
---|
Lists repositories.
|
ListTags |
---|
Lists tags.
|
ListVersions |
---|
Lists versions.
|
SetIamPolicy |
---|
Updates the IAM policy for a given resource.
|
TestIamPermissions |
---|
Tests if the caller has a list of permissions on a resource.
|
UpdateProjectSettings |
---|
Updates the Settings for the Project.
|
UpdateRepository |
---|
Updates a repository.
|
UpdateTag |
---|
Updates a tag.
|
UploadAptArtifact |
---|
Directly uploads an Apt artifact. The returned Operation will complete once the resources are uploaded. Package, Version, and File resources are created based on the imported artifact. Imported artifacts that conflict with existing resources are ignored.
|
UploadYumArtifact |
---|
Directly uploads a Yum artifact. The returned Operation will complete once the resources are uploaded. Package, Version, and File resources are created based on the imported artifact. Imported artifacts that conflict with existing resources are ignored.
|
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 |
Output only. The Artifact Registry resource name of the artifact. |
package_name |
Output only. The Apt package name of the artifact. |
package_type |
Output only. An artifact is a binary or source package. |
architecture |
Output only. Operating system architecture of the artifact. |
component |
Output only. Repository component of the artifact. |
control_file |
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 |
Required. The name of the parent resource where the repository will be created. Authorization requires the following IAM permission on the specified resource
|
repository_id |
The repository id to use for this repository. |
repository |
The repository to be created. |
CreateTagRequest
The request to create a new tag.
Fields | |
---|---|
parent |
The name of the parent resource where the tag will be created. Authorization requires the following IAM permission on the specified resource
|
tag_id |
The tag id to use for this repository. |
tag |
The tag to be created. |
DeletePackageRequest
The request to delete a package.
Fields | |
---|---|
name |
Required. The name of the package to delete. Authorization requires the following IAM permission on the specified resource
|
DeleteRepositoryRequest
The request to delete a repository.
Fields | |
---|---|
name |
Required. The name of the repository to delete. Authorization requires the following IAM permission on the specified resource
|
DeleteTagRequest
The request to delete a tag.
Fields | |
---|---|
name |
The name of the tag to delete. Authorization requires the following IAM permission on the specified resource
|
DeleteVersionRequest
The request to delete a version.
Fields | |
---|---|
name |
The name of the version to delete. Authorization requires the following IAM permission on the specified resource
|
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. |
File
Files store content that is potentially associated with Packages or Versions.
Fields | |
---|---|
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. |
size_bytes |
The size of the File in bytes. |
hashes[] |
The hashes of the file content. |
create_time |
The time when the File was created. |
update_time |
The time when the File was last updated. |
owner |
The name of the Package or Version that owns this file, if any. |
GetFileRequest
The request to retrieve a file.
Fields | |
---|---|
name |
The name of the file to retrieve. Authorization requires the following IAM permission on the specified resource
|
GetPackageRequest
The request to retrieve a package.
Fields | |
---|---|
name |
Required. The name of the package to retrieve. Authorization requires the following IAM permission on the specified resource
|
GetProjectSettingsRequest
Gets the redirection status for a project.
Fields | |
---|---|
name |
Required. The name of the projectSettings resource. Authorization requires the following IAM permission on the specified resource
|
GetRepositoryRequest
The request to retrieve a repository.
Fields | |
---|---|
name |
Required. The name of the repository to retrieve. Authorization requires the following IAM permission on the specified resource
|
GetTagRequest
The request to retrieve a tag.
Fields | |
---|---|
name |
The name of the tag to retrieve. Authorization requires the following IAM permission on the specified resource
|
GetVersionRequest
The request to retrieve a version.
Fields | |
---|---|
name |
The name of the version to retrieve. Authorization requires the following IAM permission on the specified resource
|
view |
The view that should be returned in the response. |
Hash
A hash of file content.
Fields | |
---|---|
type |
The algorithm used to compute the hash value. |
value |
The hash value. |
HashType
The algorithm used to compute the hash.
Enums | |
---|---|
HASH_TYPE_UNSPECIFIED |
Unspecified. |
SHA256 |
SHA256 hash. |
MD5 |
MD5 hash. |
ImportAptArtifactsErrorInfo
Error information explaining why a package was not imported.
Fields | |
---|---|
error |
The detailed error status. |
gcs_source |
Google Cloud Storage location requested. |
ImportAptArtifactsGcsSource
Google Cloud Storage location where the artifacts currently reside.
Fields | |
---|---|
uris[] |
Cloud Storage paths URI (e.g., gs://my_bucket//my_object). |
use_wildcards |
Supports URI wildcards for matching multiple objects from a single URI. |
ImportAptArtifactsMetadata
The operation metadata for importing artifacts.
ImportAptArtifactsRequest
The request to import new apt artifacts.
Fields | |
---|---|
parent |
The name of the parent resource where the artifacts will be imported. Authorization requires the following IAM permission on the specified resource
|
gcs_source |
Google Cloud Storage location where input content is located. |
ImportAptArtifactsResponse
The response message from importing APT artifacts.
Fields | |
---|---|
apt_artifacts[] |
The Apt artifacts imported. |
errors[] |
Detailed error info for packages that were not imported. |
ImportYumArtifactsErrorInfo
Error information explaining why a package was not imported.
Fields | |
---|---|
error |
The detailed error status. |
gcs_source |
Google Cloud Storage location requested. |
ImportYumArtifactsGcsSource
Google Cloud Storage location where the artifacts currently reside.
Fields | |
---|---|
uris[] |
Cloud Storage paths URI (e.g., gs://my_bucket//my_object). |
use_wildcards |
Supports URI wildcards for matching multiple objects from a single URI. |
ImportYumArtifactsMetadata
The operation metadata for importing artifacts.
ImportYumArtifactsRequest
The request to import new yum artifacts.
Fields | |
---|---|
parent |
The name of the parent resource where the artifacts will be imported. Authorization requires the following IAM permission on the specified resource
|
gcs_source |
Google Cloud Storage location where input content is located. |
ImportYumArtifactsResponse
The response message from importing YUM artifacts.
Fields | |
---|---|
yum_artifacts[] |
The yum artifacts imported. |
errors[] |
Detailed error info for packages that were not imported. |
ListFilesRequest
The request to list files.
Fields | |
---|---|
parent |
The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1 Authorization requires the following IAM permission on the specified resource
|
filter |
An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:
An example of using a filter:
|
page_size |
The maximum number of files to return. |
page_token |
The next_page_token value returned from a previous list request, if any. |
ListFilesResponse
The response from listing files.
Fields | |
---|---|
files[] |
The files returned. |
next_page_token |
The token to retrieve the next page of files, or empty if there are no more files to return. |
ListPackagesRequest
The request to list packages.
Fields | |
---|---|
parent |
Required. The name of the parent resource whose packages will be listed. Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of packages to return. Maximum page size is 1,000. |
page_token |
The next_page_token value returned from a previous list request, if any. |
ListPackagesResponse
The response from listing packages.
Fields | |
---|---|
packages[] |
The packages returned. |
next_page_token |
The token to retrieve the next page of packages, or empty if there are no more packages to return. |
ListRepositoriesRequest
The request to list repositories.
Fields | |
---|---|
parent |
Required. The name of the parent resource whose repositories will be listed. Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of repositories to return. Maximum page size is 1,000. |
page_token |
The next_page_token value returned from a previous list request, if any. |
ListRepositoriesResponse
The response from listing repositories.
Fields | |
---|---|
repositories[] |
The repositories returned. |
next_page_token |
The token to retrieve the next page of repositories, or empty if there are no more repositories to return. |
ListTagsRequest
The request to list tags.
Fields | |
---|---|
parent |
The name of the parent resource whose tags will be listed. Authorization requires the following IAM permission on the specified resource
|
filter |
An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:
An example of using a filter:
|
page_size |
The maximum number of tags to return. Maximum page size is 10,000. |
page_token |
The next_page_token value returned from a previous list request, if any. |
ListTagsResponse
The response from listing tags.
Fields | |
---|---|
tags[] |
The tags returned. |
next_page_token |
The token to retrieve the next page of tags, or empty if there are no more tags to return. |
ListVersionsRequest
The request to list versions.
Fields | |
---|---|
parent |
The name of the parent resource whose versions will be listed. Authorization requires the following IAM permission on the specified resource
|
page_size |
The maximum number of versions to return. Maximum page size is 1,000. |
page_token |
The next_page_token value returned from a previous list request, if any. |
view |
The view that should be returned in the response. |
order_by |
Optional. The field to order the results by. |
ListVersionsResponse
The response from listing versions.
Fields | |
---|---|
versions[] |
The versions returned. |
next_page_token |
The token to retrieve the next page of versions, or empty if there are no more versions to return. |
OperationMetadata
Metadata type for longrunning-operations, currently empty.
Package
Packages are named collections of versions.
Fields | |
---|---|
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. |
display_name |
The display name of the package. |
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. |
ProjectSettings
The Artifact Registry settings that apply to a Project.
Fields | |
---|---|
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 |
legacy_redirection_state |
The redirection state of the legacy repositories in this project. |
RedirectionState
The possible redirection states for legacy repositories.
Enums | |
---|---|
REDIRECTION_STATE_UNSPECIFIED |
No redirection status has been set. |
REDIRECTION_FROM_GCR_IO_DISABLED |
Redirection is disabled. |
REDIRECTION_FROM_GCR_IO_ENABLED |
Redirection is enabled. |
REDIRECTION_FROM_GCR_IO_FINALIZED |
Redirection is enabled, and has been finalized so cannot be reverted. |
Repository
A Repository for storing artifacts with a specific format.
Fields | |
---|---|
name |
The name of the repository, for example: "projects/p1/locations/us-central1/repositories/repo1". |
format |
The format of packages that are stored in the repository. |
description |
The user-provided description of 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: |
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. |
maven_config |
Maven repository config contains repository level configuration for the repositories of maven type. |
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. |
PYTHON |
Python package format. |
MavenRepositoryConfig
MavenRepositoryConfig is maven related repository details. Provides additional configuration details for repositories of the maven format type.
Fields | |
---|---|
allow_snapshot_overwrites |
The repository with this flag will allow publishing the same snapshot versions. |
version_policy |
Version policy defines the versions that the registry will accept. |
VersionPolicy
VersionPolicy is the version policy for the repository.
Enums | |
---|---|
VERSION_POLICY_UNSPECIFIED |
VERSION_POLICY_UNSPECIFIED - the version policy is not defined. When the version policy is not defined, no validation is performed for the versions. |
RELEASE |
RELEASE - repository will accept only Release versions. |
SNAPSHOT |
SNAPSHOT - repository will accept only Snapshot versions. |
Tag
Tags point to a version and represent an alternative name that can be used to access the version.
Fields | |
---|---|
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. |
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. |
UpdateProjectSettingsRequest
Sets the settings of the project.
Fields | |
---|---|
project_settings |
The project settings. Authorization requires the following IAM permission on the specified resource
|
update_mask |
Field mask to support partial updates. |
UpdateRepositoryRequest
The request to update a repository.
Fields | |
---|---|
repository |
The repository that replaces the resource on the server. Authorization requires the following IAM permission on the specified resource
|
update_mask |
The update mask applies to the resource. For the |
UpdateTagRequest
The request to create or update a tag.
Fields | |
---|---|
tag |
The tag that replaces the resource on the server. Authorization requires the following IAM permission on the specified resource
|
update_mask |
The update mask applies to the resource. For the |
UploadAptArtifactMediaResponse
The response to upload an artifact.
Fields | |
---|---|
operation |
Operation to be returned to the user. |
UploadAptArtifactMetadata
The operation metadata for uploading artifacts.
UploadAptArtifactRequest
The request to upload an artifact.
Fields | |
---|---|
parent |
The name of the parent resource where the artifacts will be uploaded. Authorization requires the following IAM permission on the specified resource
|
UploadAptArtifactResponse
The response of the completed artifact upload operation. This response is contained in the Operation and available to users.
Fields | |
---|---|
apt_artifacts[] |
The Apt artifacts updated. |
UploadYumArtifactMediaResponse
The response to upload an artifact.
Fields | |
---|---|
operation |
Operation to be returned to the user. |
UploadYumArtifactMetadata
The operation metadata for uploading artifacts.
UploadYumArtifactRequest
The request to upload an artifact.
Fields | |
---|---|
parent |
The name of the parent resource where the artifacts will be uploaded. Authorization requires the following IAM permission on the specified resource
|
UploadYumArtifactResponse
The response of the completed artifact upload operation. This response is contained in the Operation and available to users.
Fields | |
---|---|
yum_artifacts[] |
The Apt artifacts updated. |
Version
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.
Fields | |
---|---|
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. |
description |
Optional. Description of the version, as specified in its metadata. |
create_time |
The time when the version was created. |
update_time |
The time when the version was last updated. |
related_tags[] |
Output only. A list of related tags. Will contain up to 100 tags that reference this version. |
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: |
VersionView
The view, which determines what version information is returned in a response.
Enums | |
---|---|
VERSION_VIEW_UNSPECIFIED |
The default / unset value. The API will default to the BASIC view. |
BASIC |
Includes basic information about the version, but not any related tags. |
FULL |
Include everything. |
YumArtifact
A detailed representation of a Yum artifact.
Fields | |
---|---|
name |
Output only. The Artifact Registry resource name of the artifact. |
package_name |
Output only. The yum package name of the artifact. |
package_type |
Output only. An artifact is a binary or source package. |
architecture |
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). |