Package com.google.devtools.artifactregistry.v1 (1.6.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()) {
   DockerImageName name =
       DockerImageName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[DOCKER_IMAGE]");
   DockerImage response = artifactRegistryClient.getDockerImage(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.v1.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.v1.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()) {
   DockerImageName name =
       DockerImageName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]", "[DOCKER_IMAGE]");
   DockerImage response = artifactRegistryClient.getDockerImage(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.ListDockerImagesFixedSizeCollection

ArtifactRegistryClient.ListDockerImagesPage

ArtifactRegistryClient.ListDockerImagesPagedResponse

ArtifactRegistryClient.ListFilesFixedSizeCollection

ArtifactRegistryClient.ListFilesPage

ArtifactRegistryClient.ListFilesPagedResponse

ArtifactRegistryClient.ListPackagesFixedSizeCollection

ArtifactRegistryClient.ListPackagesPage

ArtifactRegistryClient.ListPackagesPagedResponse

ArtifactRegistryClient.ListRepositoriesFixedSizeCollection

ArtifactRegistryClient.ListRepositoriesPage

ArtifactRegistryClient.ListRepositoriesPagedResponse

ArtifactRegistryClient.ListTagsFixedSizeCollection

ArtifactRegistryClient.ListTagsPage

ArtifactRegistryClient.ListTagsPagedResponse