Class ArtifactRegistryClient (1.1.1)

Version 1.1.1

• 1.54.0 (latest)
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.9
• 1.1.1
• 0.5.0
• 0.4.0

public class ArtifactRegistryClient implements BackgroundResource

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:

 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:

1. 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.
2. 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.
3. 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:

 ArtifactRegistrySettings artifactRegistrySettings =
     ArtifactRegistrySettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ArtifactRegistryClient artifactRegistryClient =
     ArtifactRegistryClient.create(artifactRegistrySettings);
 

To customize the endpoint:

 ArtifactRegistrySettings artifactRegistrySettings =
     ArtifactRegistrySettings.newBuilder().setEndpoint(myEndpoint).build();
 ArtifactRegistryClient artifactRegistryClient =
     ArtifactRegistryClient.create(artifactRegistrySettings);
 

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

Inheritance

java.lang.Object > ArtifactRegistryClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final ArtifactRegistryClient create()

Constructs an instance of ArtifactRegistryClient with default settings.

Returns

Type	Description
ArtifactRegistryClient

Exceptions

Type	Description
IOException

create(ArtifactRegistrySettings settings)

public static final ArtifactRegistryClient create(ArtifactRegistrySettings settings)

Constructs an instance of ArtifactRegistryClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter

Name	Description
settings	ArtifactRegistrySettings

Returns

Type	Description
ArtifactRegistryClient

Exceptions

Type	Description
IOException

create(ArtifactRegistryStub stub)

public static final ArtifactRegistryClient create(ArtifactRegistryStub stub)

Constructs an instance of ArtifactRegistryClient, using the given stub for making calls. This is for advanced usage - prefer using create(ArtifactRegistrySettings).

Parameter

Name	Description
stub	ArtifactRegistryStub

Returns

Type	Description
ArtifactRegistryClient

Constructors

ArtifactRegistryClient(ArtifactRegistrySettings settings)

protected ArtifactRegistryClient(ArtifactRegistrySettings settings)

Constructs an instance of ArtifactRegistryClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter

Name	Description
settings	ArtifactRegistrySettings

ArtifactRegistryClient(ArtifactRegistryStub stub)

protected ArtifactRegistryClient(ArtifactRegistryStub stub)

Parameter

Name	Description
stub	ArtifactRegistryStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	long
unit	TimeUnit

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

close()

public final void close()

createRepositoryAsync(CreateRepositoryRequest request)

public final OperationFuture<Repository,OperationMetadata> createRepositoryAsync(CreateRepositoryRequest request)

Creates a repository. The returned Operation will finish once the repository has been created. Its response will be the created Repository.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   CreateRepositoryRequest request =
       CreateRepositoryRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setRepositoryId("repositoryId2113747461")
           .setRepository(Repository.newBuilder().build())
           .build();
   Repository response = artifactRegistryClient.createRepositoryAsync(request).get();
 }
 

Parameter

Name	Description
request	CreateRepositoryRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Repository,OperationMetadata>

createRepositoryAsync(LocationName parent, Repository repository, String repositoryId)

public final OperationFuture<Repository,OperationMetadata> createRepositoryAsync(LocationName parent, Repository repository, String repositoryId)

Creates a repository. The returned Operation will finish once the repository has been created. Its response will be the created Repository.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Repository repository = Repository.newBuilder().build();
   String repositoryId = "repositoryId2113747461";
   Repository response =
       artifactRegistryClient.createRepositoryAsync(parent, repository, repositoryId).get();
 }
 

Parameters

Name	Description
parent	LocationName Required. The name of the parent resource where the repository will be created.
repository	Repository The repository to be created.
repositoryId	String The repository id to use for this repository.

Returns

Type	Description
OperationFuture<Repository,OperationMetadata>

createRepositoryAsync(String parent, Repository repository, String repositoryId)

public final OperationFuture<Repository,OperationMetadata> createRepositoryAsync(String parent, Repository repository, String repositoryId)

Creates a repository. The returned Operation will finish once the repository has been created. Its response will be the created Repository.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Repository repository = Repository.newBuilder().build();
   String repositoryId = "repositoryId2113747461";
   Repository response =
       artifactRegistryClient.createRepositoryAsync(parent, repository, repositoryId).get();
 }
 

Parameters

Name	Description
parent	String Required. The name of the parent resource where the repository will be created.
repository	Repository The repository to be created.
repositoryId	String The repository id to use for this repository.

Returns

Type	Description
OperationFuture<Repository,OperationMetadata>

createRepositoryCallable()

public final UnaryCallable<CreateRepositoryRequest,Operation> createRepositoryCallable()

Creates a repository. The returned Operation will finish once the repository has been created. Its response will be the created Repository.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   CreateRepositoryRequest request =
       CreateRepositoryRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setRepositoryId("repositoryId2113747461")
           .setRepository(Repository.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       artifactRegistryClient.createRepositoryCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<CreateRepositoryRequest,Operation>

createRepositoryOperationCallable()

public final OperationCallable<CreateRepositoryRequest,Repository,OperationMetadata> createRepositoryOperationCallable()

Creates a repository. The returned Operation will finish once the repository has been created. Its response will be the created Repository.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   CreateRepositoryRequest request =
       CreateRepositoryRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setRepositoryId("repositoryId2113747461")
           .setRepository(Repository.newBuilder().build())
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<CreateRepositoryRequest,Repository,OperationMetadata>

createTag(CreateTagRequest request)

public final Tag createTag(CreateTagRequest request)

Creates a tag.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   CreateTagRequest request =
       CreateTagRequest.newBuilder()
           .setParent("parent-995424086")
           .setTagId("tagId110119509")
           .setTag(Tag.newBuilder().build())
           .build();
   Tag response = artifactRegistryClient.createTag(request);
 }
 

Parameter

Name	Description
request	CreateTagRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Tag

createTag(String parent, Tag tag, String tagId)

public final Tag createTag(String parent, Tag tag, String tagId)

Creates a tag.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   String parent = "parent-995424086";
   Tag tag = Tag.newBuilder().build();
   String tagId = "tagId110119509";
   Tag response = artifactRegistryClient.createTag(parent, tag, tagId);
 }
 

Parameters

Name	Description
parent	String The name of the parent resource where the tag will be created.
tag	Tag The tag to be created.
tagId	String The tag id to use for this repository.

Returns

Type	Description
Tag

createTagCallable()

public final UnaryCallable<CreateTagRequest,Tag> createTagCallable()

Creates a tag.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   CreateTagRequest request =
       CreateTagRequest.newBuilder()
           .setParent("parent-995424086")
           .setTagId("tagId110119509")
           .setTag(Tag.newBuilder().build())
           .build();
   ApiFuture<Tag> future = artifactRegistryClient.createTagCallable().futureCall(request);
   // Do something.
   Tag response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<CreateTagRequest,Tag>

deletePackageAsync(DeletePackageRequest request)

public final OperationFuture<Empty,OperationMetadata> deletePackageAsync(DeletePackageRequest request)

Deletes a package and all of its versions and tags. The returned operation will complete once the package has been deleted.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   DeletePackageRequest request =
       DeletePackageRequest.newBuilder().setName("name3373707").build();
   artifactRegistryClient.deletePackageAsync(request).get();
 }
 

Parameter

Name	Description
request	DeletePackageRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deletePackageAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deletePackageAsync(String name)

Deletes a package and all of its versions and tags. The returned operation will complete once the package has been deleted.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   String name = "name3373707";
   artifactRegistryClient.deletePackageAsync(name).get();
 }
 

Parameter

Name	Description
name	String The name of the package to delete.

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deletePackageCallable()

public final UnaryCallable<DeletePackageRequest,Operation> deletePackageCallable()

Deletes a package and all of its versions and tags. The returned operation will complete once the package has been deleted.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   DeletePackageRequest request =
       DeletePackageRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Operation> future =
       artifactRegistryClient.deletePackageCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns

Type	Description
UnaryCallable<DeletePackageRequest,Operation>

deletePackageOperationCallable()

public final OperationCallable<DeletePackageRequest,Empty,OperationMetadata> deletePackageOperationCallable()

Deletes a package and all of its versions and tags. The returned operation will complete once the package has been deleted.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   DeletePackageRequest request =
       DeletePackageRequest.newBuilder().setName("name3373707").build();
   OperationFuture

Returns

Type	Description
OperationCallable<DeletePackageRequest,Empty,OperationMetadata>

deleteRepositoryAsync(DeleteRepositoryRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteRepositoryAsync(DeleteRepositoryRequest request)

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.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   DeleteRepositoryRequest request =
       DeleteRepositoryRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .build();
   artifactRegistryClient.deleteRepositoryAsync(request).get();
 }
 

Parameter

Name	Description
request	DeleteRepositoryRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deleteRepositoryAsync(RepositoryName name)

public final OperationFuture<Empty,OperationMetadata> deleteRepositoryAsync(RepositoryName name)

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.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   RepositoryName name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
   artifactRegistryClient.deleteRepositoryAsync(name).get();
 }
 

Parameter

Name	Description
name	RepositoryName Required. The name of the repository to delete.

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deleteRepositoryAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteRepositoryAsync(String name)

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.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   String name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString();
   artifactRegistryClient.deleteRepositoryAsync(name).get();
 }
 

Parameter

Name	Description
name	String Required. The name of the repository to delete.

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deleteRepositoryCallable()

public final UnaryCallable<DeleteRepositoryRequest,Operation> deleteRepositoryCallable()

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.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   DeleteRepositoryRequest request =
       DeleteRepositoryRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .build();
   ApiFuture<Operation> future =
       artifactRegistryClient.deleteRepositoryCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns

Type	Description
UnaryCallable<DeleteRepositoryRequest,Operation>

deleteRepositoryOperationCallable()

public final OperationCallable<DeleteRepositoryRequest,Empty,OperationMetadata> deleteRepositoryOperationCallable()

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.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   DeleteRepositoryRequest request =
       DeleteRepositoryRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .build();
   OperationFuture

Returns

Type	Description
OperationCallable<DeleteRepositoryRequest,Empty,OperationMetadata>

deleteTag(DeleteTagRequest request)

public final void deleteTag(DeleteTagRequest request)

Deletes a tag.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   DeleteTagRequest request = DeleteTagRequest.newBuilder().setName("name3373707").build();
   artifactRegistryClient.deleteTag(request);
 }
 

Parameter

Name	Description
request	DeleteTagRequest The request object containing all of the parameters for the API call.

deleteTag(String name)

public final void deleteTag(String name)

Deletes a tag.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   String name = "name3373707";
   artifactRegistryClient.deleteTag(name);
 }
 

Parameter

Name	Description
name	String The name of the tag to delete.

deleteTagCallable()

public final UnaryCallable<DeleteTagRequest,Empty> deleteTagCallable()

Deletes a tag.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   DeleteTagRequest request = DeleteTagRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Empty> future = artifactRegistryClient.deleteTagCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns

Type	Description
UnaryCallable<DeleteTagRequest,Empty>

deleteVersionAsync(DeleteVersionRequest request)

public final OperationFuture<Empty,OperationMetadata> deleteVersionAsync(DeleteVersionRequest request)

Deletes a version and all of its content. The returned operation will complete once the version has been deleted.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   DeleteVersionRequest request =
       DeleteVersionRequest.newBuilder().setName("name3373707").setForce(true).build();
   artifactRegistryClient.deleteVersionAsync(request).get();
 }
 

Parameter

Name	Description
request	DeleteVersionRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deleteVersionAsync(String name)

public final OperationFuture<Empty,OperationMetadata> deleteVersionAsync(String name)

Deletes a version and all of its content. The returned operation will complete once the version has been deleted.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   String name = "name3373707";
   artifactRegistryClient.deleteVersionAsync(name).get();
 }
 

Parameter

Name	Description
name	String The name of the version to delete.

Returns

Type	Description
OperationFuture<Empty,OperationMetadata>

deleteVersionCallable()

public final UnaryCallable<DeleteVersionRequest,Operation> deleteVersionCallable()

Deletes a version and all of its content. The returned operation will complete once the version has been deleted.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   DeleteVersionRequest request =
       DeleteVersionRequest.newBuilder().setName("name3373707").setForce(true).build();
   ApiFuture<Operation> future =
       artifactRegistryClient.deleteVersionCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns

Type	Description
UnaryCallable<DeleteVersionRequest,Operation>

deleteVersionOperationCallable()

public final OperationCallable<DeleteVersionRequest,Empty,OperationMetadata> deleteVersionOperationCallable()

Deletes a version and all of its content. The returned operation will complete once the version has been deleted.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   DeleteVersionRequest request =
       DeleteVersionRequest.newBuilder().setName("name3373707").setForce(true).build();
   OperationFuture

Returns

Type	Description
OperationCallable<DeleteVersionRequest,Empty,OperationMetadata>

getFile(GetFileRequest request)

public final File getFile(GetFileRequest request)

Gets a file.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   GetFileRequest request = GetFileRequest.newBuilder().setName("name3373707").build();
   File response = artifactRegistryClient.getFile(request);
 }
 

Parameter

Name	Description
request	GetFileRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
File

getFile(String name)

public final File getFile(String name)

Gets a file.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   String name = "name3373707";
   File response = artifactRegistryClient.getFile(name);
 }
 

Parameter

Name	Description
name	String The name of the file to retrieve.

Returns

Type	Description
File

getFileCallable()

public final UnaryCallable<GetFileRequest,File> getFileCallable()

Gets a file.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   GetFileRequest request = GetFileRequest.newBuilder().setName("name3373707").build();
   ApiFuture<File> future = artifactRegistryClient.getFileCallable().futureCall(request);
   // Do something.
   File response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetFileRequest,File>

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

Gets the IAM policy for a given resource.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(ProjectSettingsName.of("[PROJECT]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = artifactRegistryClient.getIamPolicy(request);
 }
 

Parameter

Name	Description
request	com.google.iam.v1.GetIamPolicyRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
com.google.iam.v1.Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

Gets the IAM policy for a given resource.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(ProjectSettingsName.of("[PROJECT]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future = artifactRegistryClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns

Type	Description
OperationsClient

getPackage(GetPackageRequest request)

public final Package getPackage(GetPackageRequest request)

Gets a package.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   GetPackageRequest request = GetPackageRequest.newBuilder().setName("name3373707").build();
   Package response = artifactRegistryClient.getPackage(request);
 }
 

Parameter

Name	Description
request	GetPackageRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Package

getPackage(String name)

public final Package getPackage(String name)

Gets a package.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   String name = "name3373707";
   Package response = artifactRegistryClient.getPackage(name);
 }
 

Parameter

Name	Description
name	String The name of the package to retrieve.

Returns

Type	Description
Package

getPackageCallable()

public final UnaryCallable<GetPackageRequest,Package> getPackageCallable()

Gets a package.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   GetPackageRequest request = GetPackageRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Package> future = artifactRegistryClient.getPackageCallable().futureCall(request);
   // Do something.
   Package response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetPackageRequest,Package>

getProjectSettings(GetProjectSettingsRequest request)

public final ProjectSettings getProjectSettings(GetProjectSettingsRequest request)

Retrieves the Settings for the Project.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   GetProjectSettingsRequest request =
       GetProjectSettingsRequest.newBuilder()
           .setName(ProjectSettingsName.of("[PROJECT]").toString())
           .build();
   ProjectSettings response = artifactRegistryClient.getProjectSettings(request);
 }
 

Parameter

Name	Description
request	GetProjectSettingsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
ProjectSettings

getProjectSettings(ProjectSettingsName name)

public final ProjectSettings getProjectSettings(ProjectSettingsName name)

Retrieves the Settings for the Project.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   ProjectSettingsName name = ProjectSettingsName.of("[PROJECT]");
   ProjectSettings response = artifactRegistryClient.getProjectSettings(name);
 }
 

Parameter

Name	Description
name	ProjectSettingsName Required. The name of the projectSettings resource.

Returns

Type	Description
ProjectSettings

getProjectSettings(String name)

public final ProjectSettings getProjectSettings(String name)

Retrieves the Settings for the Project.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   String name = ProjectSettingsName.of("[PROJECT]").toString();
   ProjectSettings response = artifactRegistryClient.getProjectSettings(name);
 }
 

Parameter

Name	Description
name	String Required. The name of the projectSettings resource.

Returns

Type	Description
ProjectSettings

getProjectSettingsCallable()

public final UnaryCallable<GetProjectSettingsRequest,ProjectSettings> getProjectSettingsCallable()

Retrieves the Settings for the Project.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   GetProjectSettingsRequest request =
       GetProjectSettingsRequest.newBuilder()
           .setName(ProjectSettingsName.of("[PROJECT]").toString())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<GetProjectSettingsRequest,ProjectSettings>

getRepository(GetRepositoryRequest request)

public final Repository getRepository(GetRepositoryRequest request)

Gets a repository.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   GetRepositoryRequest request =
       GetRepositoryRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .build();
   Repository response = artifactRegistryClient.getRepository(request);
 }
 

Parameter

Name	Description
request	GetRepositoryRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Repository

getRepository(RepositoryName name)

public final Repository getRepository(RepositoryName name)

Gets a repository.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   RepositoryName name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]");
   Repository response = artifactRegistryClient.getRepository(name);
 }
 

Parameter

Name	Description
name	RepositoryName Required. The name of the repository to retrieve.

Returns

Type	Description
Repository

getRepository(String name)

public final Repository getRepository(String name)

Gets a repository.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   String name = RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString();
   Repository response = artifactRegistryClient.getRepository(name);
 }
 

Parameter

Name	Description
name	String Required. The name of the repository to retrieve.

Returns

Type	Description
Repository

getRepositoryCallable()

public final UnaryCallable<GetRepositoryRequest,Repository> getRepositoryCallable()

Gets a repository.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   GetRepositoryRequest request =
       GetRepositoryRequest.newBuilder()
           .setName(RepositoryName.of("[PROJECT]", "[LOCATION]", "[REPOSITORY]").toString())
           .build();
   ApiFuture<Repository> future =
       artifactRegistryClient.getRepositoryCallable().futureCall(request);
   // Do something.
   Repository response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetRepositoryRequest,Repository>

getSettings()

public final ArtifactRegistrySettings getSettings()

Returns

Type	Description
ArtifactRegistrySettings

getStub()

public ArtifactRegistryStub getStub()

Returns

Type	Description
ArtifactRegistryStub

getTag(GetTagRequest request)

public final Tag getTag(GetTagRequest request)

Gets a tag.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   GetTagRequest request = GetTagRequest.newBuilder().setName("name3373707").build();
   Tag response = artifactRegistryClient.getTag(request);
 }
 

Parameter

Name	Description
request	GetTagRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Tag

getTag(String name)

public final Tag getTag(String name)

Gets a tag.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   String name = "name3373707";
   Tag response = artifactRegistryClient.getTag(name);
 }
 

Parameter

Name	Description
name	String The name of the tag to retrieve.

Returns

Type	Description
Tag

getTagCallable()

public final UnaryCallable<GetTagRequest,Tag> getTagCallable()

Gets a tag.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   GetTagRequest request = GetTagRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Tag> future = artifactRegistryClient.getTagCallable().futureCall(request);
   // Do something.
   Tag response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetTagRequest,Tag>

getVersion(GetVersionRequest request)

public final Version getVersion(GetVersionRequest request)

Gets a version

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   GetVersionRequest request =
       GetVersionRequest.newBuilder()
           .setName("name3373707")
           .setView(VersionView.forNumber(0))
           .build();
   Version response = artifactRegistryClient.getVersion(request);
 }
 

Parameter

Name	Description
request	GetVersionRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Version

getVersion(String name)

public final Version getVersion(String name)

Gets a version

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   String name = "name3373707";
   Version response = artifactRegistryClient.getVersion(name);
 }
 

Parameter

Name	Description
name	String The name of the version to retrieve.

Returns

Type	Description
Version

getVersionCallable()

public final UnaryCallable<GetVersionRequest,Version> getVersionCallable()

Gets a version

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   GetVersionRequest request =
       GetVersionRequest.newBuilder()
           .setName("name3373707")
           .setView(VersionView.forNumber(0))
           .build();
   ApiFuture<Version> future = artifactRegistryClient.getVersionCallable().futureCall(request);
   // Do something.
   Version response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetVersionRequest,Version>

importAptArtifactsAsync(ImportAptArtifactsRequest request)

public final OperationFuture<ImportAptArtifactsResponse,ImportAptArtifactsMetadata> importAptArtifactsAsync(ImportAptArtifactsRequest request)

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.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   ImportAptArtifactsRequest request =
       ImportAptArtifactsRequest.newBuilder().setParent("parent-995424086").build();
   ImportAptArtifactsResponse response =
       artifactRegistryClient.importAptArtifactsAsync(request).get();
 }
 

Parameter

Name	Description
request	ImportAptArtifactsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<ImportAptArtifactsResponse,ImportAptArtifactsMetadata>

importAptArtifactsCallable()

public final UnaryCallable<ImportAptArtifactsRequest,Operation> importAptArtifactsCallable()

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.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   ImportAptArtifactsRequest request =
       ImportAptArtifactsRequest.newBuilder().setParent("parent-995424086").build();
   ApiFuture<Operation> future =
       artifactRegistryClient.importAptArtifactsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<ImportAptArtifactsRequest,Operation>

importAptArtifactsOperationCallable()

public final OperationCallable<ImportAptArtifactsRequest,ImportAptArtifactsResponse,ImportAptArtifactsMetadata> importAptArtifactsOperationCallable()

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.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   ImportAptArtifactsRequest request =
       ImportAptArtifactsRequest.newBuilder().setParent("parent-995424086").build();
   OperationFuture

Returns

Type	Description
OperationCallable<ImportAptArtifactsRequest,ImportAptArtifactsResponse,ImportAptArtifactsMetadata>

importYumArtifactsAsync(ImportYumArtifactsRequest request)

public final OperationFuture<ImportYumArtifactsResponse,ImportYumArtifactsMetadata> importYumArtifactsAsync(ImportYumArtifactsRequest request)

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.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   ImportYumArtifactsRequest request =
       ImportYumArtifactsRequest.newBuilder().setParent("parent-995424086").build();
   ImportYumArtifactsResponse response =
       artifactRegistryClient.importYumArtifactsAsync(request).get();
 }
 

Parameter

Name	Description
request	ImportYumArtifactsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<ImportYumArtifactsResponse,ImportYumArtifactsMetadata>

importYumArtifactsCallable()

public final UnaryCallable<ImportYumArtifactsRequest,Operation> importYumArtifactsCallable()

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.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   ImportYumArtifactsRequest request =
       ImportYumArtifactsRequest.newBuilder().setParent("parent-995424086").build();
   ApiFuture<Operation> future =
       artifactRegistryClient.importYumArtifactsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<ImportYumArtifactsRequest,Operation>

importYumArtifactsOperationCallable()

public final OperationCallable<ImportYumArtifactsRequest,ImportYumArtifactsResponse,ImportYumArtifactsMetadata> importYumArtifactsOperationCallable()

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.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   ImportYumArtifactsRequest request =
       ImportYumArtifactsRequest.newBuilder().setParent("parent-995424086").build();
   OperationFuture

Returns

Type	Description
OperationCallable<ImportYumArtifactsRequest,ImportYumArtifactsResponse,ImportYumArtifactsMetadata>

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listFiles(ListFilesRequest request)

public final ArtifactRegistryClient.ListFilesPagedResponse listFiles(ListFilesRequest request)

Lists files.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   ListFilesRequest request =
       ListFilesRequest.newBuilder()
           .setParent("parent-995424086")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (File element : artifactRegistryClient.listFiles(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListFilesRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
ArtifactRegistryClient.ListFilesPagedResponse

listFiles(String parent)

public final ArtifactRegistryClient.ListFilesPagedResponse listFiles(String parent)

Lists files.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   String parent = "parent-995424086";
   for (File element : artifactRegistryClient.listFiles(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	String The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1

Returns

Type	Description
ArtifactRegistryClient.ListFilesPagedResponse

listFilesCallable()

public final UnaryCallable<ListFilesRequest,ListFilesResponse> listFilesCallable()

Lists files.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   ListFilesRequest request =
       ListFilesRequest.newBuilder()
           .setParent("parent-995424086")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListFilesResponse response = artifactRegistryClient.listFilesCallable().call(request);
     for (File element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListFilesRequest,ListFilesResponse>

listFilesPagedCallable()

public final UnaryCallable<ListFilesRequest,ArtifactRegistryClient.ListFilesPagedResponse> listFilesPagedCallable()

Lists files.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   ListFilesRequest request =
       ListFilesRequest.newBuilder()
           .setParent("parent-995424086")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<File> future = artifactRegistryClient.listFilesPagedCallable().futureCall(request);
   // Do something.
   for (File element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListFilesRequest,ListFilesPagedResponse>

listPackages(ListPackagesRequest request)

public final ArtifactRegistryClient.ListPackagesPagedResponse listPackages(ListPackagesRequest request)

Lists packages.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   ListPackagesRequest request =
       ListPackagesRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Package element : artifactRegistryClient.listPackages(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListPackagesRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
ArtifactRegistryClient.ListPackagesPagedResponse

listPackages(String parent)

public final ArtifactRegistryClient.ListPackagesPagedResponse listPackages(String parent)

Lists packages.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   String parent = "parent-995424086";
   for (Package element : artifactRegistryClient.listPackages(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	String The name of the parent resource whose packages will be listed.

Returns

Type	Description
ArtifactRegistryClient.ListPackagesPagedResponse

listPackagesCallable()

public final UnaryCallable<ListPackagesRequest,ListPackagesResponse> listPackagesCallable()

Lists packages.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   ListPackagesRequest request =
       ListPackagesRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListPackagesResponse response = artifactRegistryClient.listPackagesCallable().call(request);
     for (Package element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListPackagesRequest,ListPackagesResponse>

listPackagesPagedCallable()

public final UnaryCallable<ListPackagesRequest,ArtifactRegistryClient.ListPackagesPagedResponse> listPackagesPagedCallable()

Lists packages.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   ListPackagesRequest request =
       ListPackagesRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Package> future =
       artifactRegistryClient.listPackagesPagedCallable().futureCall(request);
   // Do something.
   for (Package element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListPackagesRequest,ListPackagesPagedResponse>

listRepositories(ListRepositoriesRequest request)

public final ArtifactRegistryClient.ListRepositoriesPagedResponse listRepositories(ListRepositoriesRequest request)

Lists repositories.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   ListRepositoriesRequest request =
       ListRepositoriesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Repository element : artifactRegistryClient.listRepositories(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListRepositoriesRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
ArtifactRegistryClient.ListRepositoriesPagedResponse

listRepositories(LocationName parent)

public final ArtifactRegistryClient.ListRepositoriesPagedResponse listRepositories(LocationName parent)

Lists repositories.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Repository element : artifactRegistryClient.listRepositories(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

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

Returns

Type	Description
ArtifactRegistryClient.ListRepositoriesPagedResponse

listRepositories(String parent)

public final ArtifactRegistryClient.ListRepositoriesPagedResponse listRepositories(String parent)

Lists repositories.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Repository element : artifactRegistryClient.listRepositories(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

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

Returns

Type	Description
ArtifactRegistryClient.ListRepositoriesPagedResponse

listRepositoriesCallable()

public final UnaryCallable<ListRepositoriesRequest,ListRepositoriesResponse> listRepositoriesCallable()

Lists repositories.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   ListRepositoriesRequest request =
       ListRepositoriesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListRepositoriesResponse response =
         artifactRegistryClient.listRepositoriesCallable().call(request);
     for (Repository element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListRepositoriesRequest,ListRepositoriesResponse>

listRepositoriesPagedCallable()

public final UnaryCallable<ListRepositoriesRequest,ArtifactRegistryClient.ListRepositoriesPagedResponse> listRepositoriesPagedCallable()

Lists repositories.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   ListRepositoriesRequest request =
       ListRepositoriesRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Repository> future =
       artifactRegistryClient.listRepositoriesPagedCallable().futureCall(request);
   // Do something.
   for (Repository element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListRepositoriesRequest,ListRepositoriesPagedResponse>

listTags(ListTagsRequest request)

public final ArtifactRegistryClient.ListTagsPagedResponse listTags(ListTagsRequest request)

Lists tags.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   ListTagsRequest request =
       ListTagsRequest.newBuilder()
           .setParent("parent-995424086")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Tag element : artifactRegistryClient.listTags(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListTagsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
ArtifactRegistryClient.ListTagsPagedResponse

listTags(String parent)

public final ArtifactRegistryClient.ListTagsPagedResponse listTags(String parent)

Lists tags.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   String parent = "parent-995424086";
   for (Tag element : artifactRegistryClient.listTags(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	String The name of the parent resource whose tags will be listed.

Returns

Type	Description
ArtifactRegistryClient.ListTagsPagedResponse

listTagsCallable()

public final UnaryCallable<ListTagsRequest,ListTagsResponse> listTagsCallable()

Lists tags.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   ListTagsRequest request =
       ListTagsRequest.newBuilder()
           .setParent("parent-995424086")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListTagsResponse response = artifactRegistryClient.listTagsCallable().call(request);
     for (Tag element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListTagsRequest,ListTagsResponse>

listTagsPagedCallable()

public final UnaryCallable<ListTagsRequest,ArtifactRegistryClient.ListTagsPagedResponse> listTagsPagedCallable()

Lists tags.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   ListTagsRequest request =
       ListTagsRequest.newBuilder()
           .setParent("parent-995424086")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Tag> future = artifactRegistryClient.listTagsPagedCallable().futureCall(request);
   // Do something.
   for (Tag element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListTagsRequest,ListTagsPagedResponse>

listVersions(ListVersionsRequest request)

public final ArtifactRegistryClient.ListVersionsPagedResponse listVersions(ListVersionsRequest request)

Lists versions.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   ListVersionsRequest request =
       ListVersionsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(VersionView.forNumber(0))
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Version element : artifactRegistryClient.listVersions(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListVersionsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
ArtifactRegistryClient.ListVersionsPagedResponse

listVersions(String parent)

public final ArtifactRegistryClient.ListVersionsPagedResponse listVersions(String parent)

Lists versions.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   String parent = "parent-995424086";
   for (Version element : artifactRegistryClient.listVersions(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
parent	String The name of the parent resource whose versions will be listed.

Returns

Type	Description
ArtifactRegistryClient.ListVersionsPagedResponse

listVersionsCallable()

public final UnaryCallable<ListVersionsRequest,ListVersionsResponse> listVersionsCallable()

Lists versions.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   ListVersionsRequest request =
       ListVersionsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(VersionView.forNumber(0))
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListVersionsResponse response = artifactRegistryClient.listVersionsCallable().call(request);
     for (Version element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListVersionsRequest,ListVersionsResponse>

listVersionsPagedCallable()

public final UnaryCallable<ListVersionsRequest,ArtifactRegistryClient.ListVersionsPagedResponse> listVersionsPagedCallable()

Lists versions.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   ListVersionsRequest request =
       ListVersionsRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(VersionView.forNumber(0))
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Version> future =
       artifactRegistryClient.listVersionsPagedCallable().futureCall(request);
   // Do something.
   for (Version element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListVersionsRequest,ListVersionsPagedResponse>

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

Updates the IAM policy for a given resource.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(ProjectSettingsName.of("[PROJECT]").toString())
           .setPolicy(Policy.newBuilder().build())
           .build();
   Policy response = artifactRegistryClient.setIamPolicy(request);
 }
 

Parameter

Name	Description
request	com.google.iam.v1.SetIamPolicyRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
com.google.iam.v1.Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

Updates the IAM policy for a given resource.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(ProjectSettingsName.of("[PROJECT]").toString())
           .setPolicy(Policy.newBuilder().build())
           .build();
   ApiFuture<Policy> future = artifactRegistryClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsRequest request)

public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

Tests if the caller has a list of permissions on a resource.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(ProjectSettingsName.of("[PROJECT]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = artifactRegistryClient.testIamPermissions(request);
 }
 

Parameter

Name	Description
request	com.google.iam.v1.TestIamPermissionsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
com.google.iam.v1.TestIamPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

Tests if the caller has a list of permissions on a resource.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(ProjectSettingsName.of("[PROJECT]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

updateProjectSettings(ProjectSettings projectSettings, FieldMask updateMask)

public final ProjectSettings updateProjectSettings(ProjectSettings projectSettings, FieldMask updateMask)

Updates the Settings for the Project.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   ProjectSettings projectSettings = ProjectSettings.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   ProjectSettings response =
       artifactRegistryClient.updateProjectSettings(projectSettings, updateMask);
 }
 

Parameters

Name	Description
projectSettings	ProjectSettings The project settings.
updateMask	FieldMask Field mask to support partial updates.

Returns

Type	Description
ProjectSettings

updateProjectSettings(UpdateProjectSettingsRequest request)

public final ProjectSettings updateProjectSettings(UpdateProjectSettingsRequest request)

Updates the Settings for the Project.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   UpdateProjectSettingsRequest request =
       UpdateProjectSettingsRequest.newBuilder()
           .setProjectSettings(ProjectSettings.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ProjectSettings response = artifactRegistryClient.updateProjectSettings(request);
 }
 

Parameter

Name	Description
request	UpdateProjectSettingsRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
ProjectSettings

updateProjectSettingsCallable()

public final UnaryCallable<UpdateProjectSettingsRequest,ProjectSettings> updateProjectSettingsCallable()

Updates the Settings for the Project.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   UpdateProjectSettingsRequest request =
       UpdateProjectSettingsRequest.newBuilder()
           .setProjectSettings(ProjectSettings.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture

Returns

Type	Description
UnaryCallable<UpdateProjectSettingsRequest,ProjectSettings>

updateRepository(Repository repository, FieldMask updateMask)

public final Repository updateRepository(Repository repository, FieldMask updateMask)

Updates a repository.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   Repository repository = Repository.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Repository response = artifactRegistryClient.updateRepository(repository, updateMask);
 }
 

Parameters

Name	Description
repository	Repository The repository that replaces the resource on the server.
updateMask	FieldMask The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

Returns

Type	Description
Repository

updateRepository(UpdateRepositoryRequest request)

public final Repository updateRepository(UpdateRepositoryRequest request)

Updates a repository.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   UpdateRepositoryRequest request =
       UpdateRepositoryRequest.newBuilder()
           .setRepository(Repository.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Repository response = artifactRegistryClient.updateRepository(request);
 }
 

Parameter

Name	Description
request	UpdateRepositoryRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Repository

updateRepositoryCallable()

public final UnaryCallable<UpdateRepositoryRequest,Repository> updateRepositoryCallable()

Updates a repository.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   UpdateRepositoryRequest request =
       UpdateRepositoryRequest.newBuilder()
           .setRepository(Repository.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Repository> future =
       artifactRegistryClient.updateRepositoryCallable().futureCall(request);
   // Do something.
   Repository response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<UpdateRepositoryRequest,Repository>

updateTag(Tag tag, FieldMask updateMask)

public final Tag updateTag(Tag tag, FieldMask updateMask)

Updates a tag.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   Tag tag = Tag.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Tag response = artifactRegistryClient.updateTag(tag, updateMask);
 }
 

Parameters

Name	Description
tag	Tag The tag that replaces the resource on the server.
updateMask	FieldMask The update mask applies to the resource. For the FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

Returns

Type	Description
Tag

updateTag(UpdateTagRequest request)

public final Tag updateTag(UpdateTagRequest request)

Updates a tag.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   UpdateTagRequest request =
       UpdateTagRequest.newBuilder()
           .setTag(Tag.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Tag response = artifactRegistryClient.updateTag(request);
 }
 

Parameter

Name	Description
request	UpdateTagRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Tag

updateTagCallable()

public final UnaryCallable<UpdateTagRequest,Tag> updateTagCallable()

Updates a tag.

Sample code:

 try (ArtifactRegistryClient artifactRegistryClient = ArtifactRegistryClient.create()) {
   UpdateTagRequest request =
       UpdateTagRequest.newBuilder()
           .setTag(Tag.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Tag> future = artifactRegistryClient.updateTagCallable().futureCall(request);
   // Do something.
   Tag response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<UpdateTagRequest,Tag>