Package com.google.devtools.artifactregistry.v1beta2 (1.17.0)

A client to Artifact Registry API

The interfaces provided are listed below, along with usage samples.

ArtifactRegistryClient

Service Description: 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.

Sample for ArtifactRegistryClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   RepositoryName name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
   Repository response = artifactRegistryClient.getRepository(name);
 }

Classes

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

Protobuf type google.devtools.artifactregistry.v1beta2.AptArtifact

AptArtifact.Builder

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

Protobuf type google.devtools.artifactregistry.v1beta2.AptArtifact

ArtifactRegistryClient

Service Description: 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.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   RepositoryName name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
   Repository response = artifactRegistryClient.getRepository(name);
 }

Note: close() needs to be called on the ArtifactRegistryClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of ArtifactRegistrySettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ArtifactRegistrySettings artifactRegistrySettings =
     ArtifactRegistrySettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ArtifactRegistryClient artifactRegistryClient =
     ArtifactRegistryClient.create(artifactRegistrySettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ArtifactRegistrySettings artifactRegistrySettings =
     ArtifactRegistrySettings.newBuilder().setEndpoint(myEndpoint).build();
 ArtifactRegistryClient artifactRegistryClient =
     ArtifactRegistryClient.create(artifactRegistrySettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ArtifactRegistrySettings artifactRegistrySettings =
     ArtifactRegistrySettings.newHttpJsonBuilder().build();
 ArtifactRegistryClient artifactRegistryClient =
     ArtifactRegistryClient.create(artifactRegistrySettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

ArtifactRegistryClient.ListFilesFixedSizeCollection

ArtifactRegistryClient.ListFilesPage

ArtifactRegistryClient.ListFilesPagedResponse

ArtifactRegistryClient.ListLocationsFixedSizeCollection

ArtifactRegistryClient.ListLocationsPage

ArtifactRegistryClient.ListLocationsPagedResponse

ArtifactRegistryClient.ListPackagesFixedSizeCollection

ArtifactRegistryClient.ListPackagesPage

ArtifactRegistryClient.ListPackagesPagedResponse

ArtifactRegistryClient.ListRepositoriesFixedSizeCollection

ArtifactRegistryClient.ListRepositoriesPage

ArtifactRegistryClient.ListRepositoriesPagedResponse

ArtifactRegistryClient.ListTagsFixedSizeCollection

ArtifactRegistryClient.ListTagsPage

ArtifactRegistryClient.ListTagsPagedResponse

ArtifactRegistryClient.ListVersionsFixedSizeCollection

ArtifactRegistryClient.ListVersionsPage

ArtifactRegistryClient.ListVersionsPagedResponse

ArtifactRegistryGrpc

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.

ArtifactRegistryGrpc.ArtifactRegistryBlockingStub

A stub to allow clients to do synchronous rpc calls to service 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.

ArtifactRegistryGrpc.ArtifactRegistryFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service 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.

ArtifactRegistryGrpc.ArtifactRegistryImplBase

Base class for the server implementation of the service 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.

ArtifactRegistryGrpc.ArtifactRegistryStub

A stub to allow clients to do asynchronous rpc calls to service 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.

ArtifactRegistrySettings

Settings class to configure an instance of ArtifactRegistryClient.

The default instance has everything set to sensible defaults:

The default service address (artifactregistry.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getRepository to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ArtifactRegistrySettings.Builder artifactRegistrySettingsBuilder =
     ArtifactRegistrySettings.newBuilder();
 artifactRegistrySettingsBuilder
     .getRepositorySettings()
     .setRetrySettings(
         artifactRegistrySettingsBuilder
             .getRepositorySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ArtifactRegistrySettings artifactRegistrySettings = artifactRegistrySettingsBuilder.build();

ArtifactRegistrySettings.Builder

Builder for ArtifactRegistrySettings.

CreateRepositoryRequest

The request to create a new repository.

Protobuf type google.devtools.artifactregistry.v1beta2.CreateRepositoryRequest

CreateRepositoryRequest.Builder

The request to create a new repository.

Protobuf type google.devtools.artifactregistry.v1beta2.CreateRepositoryRequest

CreateTagRequest

The request to create a new tag.

Protobuf type google.devtools.artifactregistry.v1beta2.CreateTagRequest

CreateTagRequest.Builder

The request to create a new tag.

Protobuf type google.devtools.artifactregistry.v1beta2.CreateTagRequest

DeletePackageRequest

The request to delete a package.

Protobuf type google.devtools.artifactregistry.v1beta2.DeletePackageRequest

DeletePackageRequest.Builder

The request to delete a package.

Protobuf type google.devtools.artifactregistry.v1beta2.DeletePackageRequest

DeleteRepositoryRequest

The request to delete a repository.

Protobuf type google.devtools.artifactregistry.v1beta2.DeleteRepositoryRequest

DeleteRepositoryRequest.Builder

The request to delete a repository.

Protobuf type google.devtools.artifactregistry.v1beta2.DeleteRepositoryRequest

DeleteTagRequest

The request to delete a tag.

Protobuf type google.devtools.artifactregistry.v1beta2.DeleteTagRequest

DeleteTagRequest.Builder

The request to delete a tag.

Protobuf type google.devtools.artifactregistry.v1beta2.DeleteTagRequest

DeleteVersionRequest

The request to delete a version.

Protobuf type google.devtools.artifactregistry.v1beta2.DeleteVersionRequest

DeleteVersionRequest.Builder

The request to delete a version.

Protobuf type google.devtools.artifactregistry.v1beta2.DeleteVersionRequest

File

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

Protobuf type google.devtools.artifactregistry.v1beta2.File

File.Builder

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

Protobuf type google.devtools.artifactregistry.v1beta2.File

FileProto

GetFileRequest

The request to retrieve a file.

Protobuf type google.devtools.artifactregistry.v1beta2.GetFileRequest

GetFileRequest.Builder

The request to retrieve a file.

Protobuf type google.devtools.artifactregistry.v1beta2.GetFileRequest

GetPackageRequest

The request to retrieve a package.

Protobuf type google.devtools.artifactregistry.v1beta2.GetPackageRequest

GetPackageRequest.Builder

The request to retrieve a package.

Protobuf type google.devtools.artifactregistry.v1beta2.GetPackageRequest

GetProjectSettingsRequest

Gets the redirection status for a project.

Protobuf type google.devtools.artifactregistry.v1beta2.GetProjectSettingsRequest

GetProjectSettingsRequest.Builder

Gets the redirection status for a project.

Protobuf type google.devtools.artifactregistry.v1beta2.GetProjectSettingsRequest

GetRepositoryRequest

The request to retrieve a repository.

Protobuf type google.devtools.artifactregistry.v1beta2.GetRepositoryRequest

GetRepositoryRequest.Builder

The request to retrieve a repository.

Protobuf type google.devtools.artifactregistry.v1beta2.GetRepositoryRequest

GetTagRequest

The request to retrieve a tag.

Protobuf type google.devtools.artifactregistry.v1beta2.GetTagRequest

GetTagRequest.Builder

The request to retrieve a tag.

Protobuf type google.devtools.artifactregistry.v1beta2.GetTagRequest

GetVersionRequest

The request to retrieve a version.

Protobuf type google.devtools.artifactregistry.v1beta2.GetVersionRequest

GetVersionRequest.Builder

The request to retrieve a version.

Protobuf type google.devtools.artifactregistry.v1beta2.GetVersionRequest

Hash

A hash of file content.

Protobuf type google.devtools.artifactregistry.v1beta2.Hash

Hash.Builder

A hash of file content.

Protobuf type google.devtools.artifactregistry.v1beta2.Hash

ImportAptArtifactsErrorInfo

Error information explaining why a package was not imported.

Protobuf type google.devtools.artifactregistry.v1beta2.ImportAptArtifactsErrorInfo

ImportAptArtifactsErrorInfo.Builder

Error information explaining why a package was not imported.

Protobuf type google.devtools.artifactregistry.v1beta2.ImportAptArtifactsErrorInfo

ImportAptArtifactsGcsSource

Google Cloud Storage location where the artifacts currently reside.

Protobuf type google.devtools.artifactregistry.v1beta2.ImportAptArtifactsGcsSource

ImportAptArtifactsGcsSource.Builder

Google Cloud Storage location where the artifacts currently reside.

Protobuf type google.devtools.artifactregistry.v1beta2.ImportAptArtifactsGcsSource

ImportAptArtifactsMetadata

The operation metadata for importing artifacts.

Protobuf type google.devtools.artifactregistry.v1beta2.ImportAptArtifactsMetadata

ImportAptArtifactsMetadata.Builder

The operation metadata for importing artifacts.

Protobuf type google.devtools.artifactregistry.v1beta2.ImportAptArtifactsMetadata

ImportAptArtifactsRequest

The request to import new apt artifacts.

Protobuf type google.devtools.artifactregistry.v1beta2.ImportAptArtifactsRequest

ImportAptArtifactsRequest.Builder

The request to import new apt artifacts.

Protobuf type google.devtools.artifactregistry.v1beta2.ImportAptArtifactsRequest

ImportAptArtifactsResponse

The response message from importing APT artifacts.

Protobuf type google.devtools.artifactregistry.v1beta2.ImportAptArtifactsResponse

ImportAptArtifactsResponse.Builder

The response message from importing APT artifacts.

Protobuf type google.devtools.artifactregistry.v1beta2.ImportAptArtifactsResponse

ImportYumArtifactsErrorInfo

Error information explaining why a package was not imported.

Protobuf type google.devtools.artifactregistry.v1beta2.ImportYumArtifactsErrorInfo

ImportYumArtifactsErrorInfo.Builder

Error information explaining why a package was not imported.

Protobuf type google.devtools.artifactregistry.v1beta2.ImportYumArtifactsErrorInfo

ImportYumArtifactsGcsSource

Google Cloud Storage location where the artifacts currently reside.

Protobuf type google.devtools.artifactregistry.v1beta2.ImportYumArtifactsGcsSource

ImportYumArtifactsGcsSource.Builder

Google Cloud Storage location where the artifacts currently reside.

Protobuf type google.devtools.artifactregistry.v1beta2.ImportYumArtifactsGcsSource

ImportYumArtifactsMetadata

The operation metadata for importing artifacts.

Protobuf type google.devtools.artifactregistry.v1beta2.ImportYumArtifactsMetadata

ImportYumArtifactsMetadata.Builder

The operation metadata for importing artifacts.

Protobuf type google.devtools.artifactregistry.v1beta2.ImportYumArtifactsMetadata

ImportYumArtifactsRequest

The request to import new yum artifacts.

Protobuf type google.devtools.artifactregistry.v1beta2.ImportYumArtifactsRequest

ImportYumArtifactsRequest.Builder

The request to import new yum artifacts.

Protobuf type google.devtools.artifactregistry.v1beta2.ImportYumArtifactsRequest

ImportYumArtifactsResponse

The response message from importing YUM artifacts.

Protobuf type google.devtools.artifactregistry.v1beta2.ImportYumArtifactsResponse

ImportYumArtifactsResponse.Builder

The response message from importing YUM artifacts.

Protobuf type google.devtools.artifactregistry.v1beta2.ImportYumArtifactsResponse

ListFilesRequest

The request to list files.

Protobuf type google.devtools.artifactregistry.v1beta2.ListFilesRequest

ListFilesRequest.Builder

The request to list files.

Protobuf type google.devtools.artifactregistry.v1beta2.ListFilesRequest

ListFilesResponse

The response from listing files.

Protobuf type google.devtools.artifactregistry.v1beta2.ListFilesResponse

ListFilesResponse.Builder

The response from listing files.

Protobuf type google.devtools.artifactregistry.v1beta2.ListFilesResponse

ListPackagesRequest

The request to list packages.

Protobuf type google.devtools.artifactregistry.v1beta2.ListPackagesRequest

ListPackagesRequest.Builder

The request to list packages.

Protobuf type google.devtools.artifactregistry.v1beta2.ListPackagesRequest

ListPackagesResponse

The response from listing packages.

Protobuf type google.devtools.artifactregistry.v1beta2.ListPackagesResponse

ListPackagesResponse.Builder

The response from listing packages.

Protobuf type google.devtools.artifactregistry.v1beta2.ListPackagesResponse

ListRepositoriesRequest

The request to list repositories.

Protobuf type google.devtools.artifactregistry.v1beta2.ListRepositoriesRequest

ListRepositoriesRequest.Builder

The request to list repositories.

Protobuf type google.devtools.artifactregistry.v1beta2.ListRepositoriesRequest

ListRepositoriesResponse

The response from listing repositories.

Protobuf type google.devtools.artifactregistry.v1beta2.ListRepositoriesResponse

ListRepositoriesResponse.Builder

The response from listing repositories.

Protobuf type google.devtools.artifactregistry.v1beta2.ListRepositoriesResponse

ListTagsRequest

The request to list tags.

Protobuf type google.devtools.artifactregistry.v1beta2.ListTagsRequest

ListTagsRequest.Builder

The request to list tags.

Protobuf type google.devtools.artifactregistry.v1beta2.ListTagsRequest

ListTagsResponse

The response from listing tags.

Protobuf type google.devtools.artifactregistry.v1beta2.ListTagsResponse

ListTagsResponse.Builder

The response from listing tags.

Protobuf type google.devtools.artifactregistry.v1beta2.ListTagsResponse

ListVersionsRequest

The request to list versions.

Protobuf type google.devtools.artifactregistry.v1beta2.ListVersionsRequest

ListVersionsRequest.Builder

The request to list versions.

Protobuf type google.devtools.artifactregistry.v1beta2.ListVersionsRequest

ListVersionsResponse

The response from listing versions.

Protobuf type google.devtools.artifactregistry.v1beta2.ListVersionsResponse

ListVersionsResponse.Builder

The response from listing versions.

Protobuf type google.devtools.artifactregistry.v1beta2.ListVersionsResponse

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

OperationMetadata

Metadata type for longrunning-operations, currently empty.

Protobuf type google.devtools.artifactregistry.v1beta2.OperationMetadata

OperationMetadata.Builder

Metadata type for longrunning-operations, currently empty.

Protobuf type google.devtools.artifactregistry.v1beta2.OperationMetadata

Package

Packages are named collections of versions.

Protobuf type google.devtools.artifactregistry.v1beta2.Package

Package.Builder

Packages are named collections of versions.

Protobuf type google.devtools.artifactregistry.v1beta2.Package

PackageProto

ProjectSettings

The Artifact Registry settings that apply to a Project.

Protobuf type google.devtools.artifactregistry.v1beta2.ProjectSettings

ProjectSettings.Builder

The Artifact Registry settings that apply to a Project.

Protobuf type google.devtools.artifactregistry.v1beta2.ProjectSettings

ProjectSettingsName

ProjectSettingsName.Builder

Builder for projects/{project}/projectSettings.

Repository

A Repository for storing artifacts with a specific format.

Protobuf type google.devtools.artifactregistry.v1beta2.Repository

Repository.Builder

A Repository for storing artifacts with a specific format.

Protobuf type google.devtools.artifactregistry.v1beta2.Repository

Repository.MavenRepositoryConfig

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

Protobuf type google.devtools.artifactregistry.v1beta2.Repository.MavenRepositoryConfig

Repository.MavenRepositoryConfig.Builder

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

Protobuf type google.devtools.artifactregistry.v1beta2.Repository.MavenRepositoryConfig

RepositoryName

RepositoryName.Builder

Builder for projects/{project}/locations/{location}/repositories/{repository}.

RepositoryProto

ServiceProto

SettingsProto

Tag

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

Protobuf type google.devtools.artifactregistry.v1beta2.Tag

Tag.Builder

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

Protobuf type google.devtools.artifactregistry.v1beta2.Tag

TagProto

UpdateProjectSettingsRequest

Sets the settings of the project.

Protobuf type google.devtools.artifactregistry.v1beta2.UpdateProjectSettingsRequest

UpdateProjectSettingsRequest.Builder

Sets the settings of the project.

Protobuf type google.devtools.artifactregistry.v1beta2.UpdateProjectSettingsRequest

UpdateRepositoryRequest

The request to update a repository.

Protobuf type google.devtools.artifactregistry.v1beta2.UpdateRepositoryRequest

UpdateRepositoryRequest.Builder

The request to update a repository.

Protobuf type google.devtools.artifactregistry.v1beta2.UpdateRepositoryRequest

UpdateTagRequest

The request to create or update a tag.

Protobuf type google.devtools.artifactregistry.v1beta2.UpdateTagRequest

UpdateTagRequest.Builder

The request to create or update a tag.

Protobuf type google.devtools.artifactregistry.v1beta2.UpdateTagRequest

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.

Protobuf type google.devtools.artifactregistry.v1beta2.Version

Version.Builder

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.

Protobuf type google.devtools.artifactregistry.v1beta2.Version

VersionProto

YumArtifact

A detailed representation of a Yum artifact.

Protobuf type google.devtools.artifactregistry.v1beta2.YumArtifact

YumArtifact.Builder

A detailed representation of a Yum artifact.

Protobuf type google.devtools.artifactregistry.v1beta2.YumArtifact

YumArtifactProto

Interfaces

AptArtifactOrBuilder

ArtifactRegistryGrpc.AsyncService

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.