Class ArtifactRegistrySettings (1.52.0)

Version latest

• 1.52.0 (latest)
• 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

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

public class ArtifactRegistrySettings extends ClientSettings<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 RetrySettings of getRepository:

 // 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()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 ArtifactRegistrySettings artifactRegistrySettings = artifactRegistrySettingsBuilder.build();
 

Please refer to the Client Side Retry Guide for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for importAptArtifacts:

 // 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();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 artifactRegistrySettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Inheritance

java.lang.Object > ClientSettings > ArtifactRegistrySettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getApiKey()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getUniverseDomain()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogCheckIntervalDuration()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(ArtifactRegistryStubSettings stub)

public static final ArtifactRegistrySettings create(ArtifactRegistryStubSettings stub)

Parameter
Name	Description
stub	ArtifactRegistryStubSettings

Returns
Type	Description
ArtifactRegistrySettings

Exceptions
Type	Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns
Type	Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type	Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type	Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type	Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type	Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns
Type	Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type	Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type	Description
List<String>

newBuilder()

public static ArtifactRegistrySettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
ArtifactRegistrySettings.Builder

newBuilder(ClientContext clientContext)

public static ArtifactRegistrySettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
ArtifactRegistrySettings.Builder

newHttpJsonBuilder()

public static ArtifactRegistrySettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
ArtifactRegistrySettings.Builder

Constructors

ArtifactRegistrySettings(ArtifactRegistrySettings.Builder settingsBuilder)

protected ArtifactRegistrySettings(ArtifactRegistrySettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	ArtifactRegistrySettings.Builder

Methods

createRepositoryOperationSettings()

public OperationCallSettings<CreateRepositoryRequest,Repository,OperationMetadata> createRepositoryOperationSettings()

Returns the object with the settings used for calls to createRepository.

Returns
Type	Description
OperationCallSettings<CreateRepositoryRequest,Repository,OperationMetadata>

createRepositorySettings()

public UnaryCallSettings<CreateRepositoryRequest,Operation> createRepositorySettings()

Returns the object with the settings used for calls to createRepository.

Returns
Type	Description
UnaryCallSettings<CreateRepositoryRequest,Operation>

createTagSettings()

public UnaryCallSettings<CreateTagRequest,Tag> createTagSettings()

Returns the object with the settings used for calls to createTag.

Returns
Type	Description
UnaryCallSettings<CreateTagRequest,Tag>

deletePackageOperationSettings()

public OperationCallSettings<DeletePackageRequest,Empty,OperationMetadata> deletePackageOperationSettings()

Returns the object with the settings used for calls to deletePackage.

Returns
Type	Description
OperationCallSettings<DeletePackageRequest,Empty,OperationMetadata>

deletePackageSettings()

public UnaryCallSettings<DeletePackageRequest,Operation> deletePackageSettings()

Returns the object with the settings used for calls to deletePackage.

Returns
Type	Description
UnaryCallSettings<DeletePackageRequest,Operation>

deleteRepositoryOperationSettings()

public OperationCallSettings<DeleteRepositoryRequest,Empty,OperationMetadata> deleteRepositoryOperationSettings()

Returns the object with the settings used for calls to deleteRepository.

Returns
Type	Description
OperationCallSettings<DeleteRepositoryRequest,Empty,OperationMetadata>

deleteRepositorySettings()

public UnaryCallSettings<DeleteRepositoryRequest,Operation> deleteRepositorySettings()

Returns the object with the settings used for calls to deleteRepository.

Returns
Type	Description
UnaryCallSettings<DeleteRepositoryRequest,Operation>

deleteTagSettings()

public UnaryCallSettings<DeleteTagRequest,Empty> deleteTagSettings()

Returns the object with the settings used for calls to deleteTag.

Returns
Type	Description
UnaryCallSettings<DeleteTagRequest,Empty>

deleteVersionOperationSettings()

public OperationCallSettings<DeleteVersionRequest,Empty,OperationMetadata> deleteVersionOperationSettings()

Returns the object with the settings used for calls to deleteVersion.

Returns
Type	Description
OperationCallSettings<DeleteVersionRequest,Empty,OperationMetadata>

deleteVersionSettings()

public UnaryCallSettings<DeleteVersionRequest,Operation> deleteVersionSettings()

Returns the object with the settings used for calls to deleteVersion.

Returns
Type	Description
UnaryCallSettings<DeleteVersionRequest,Operation>

getFileSettings()

public UnaryCallSettings<GetFileRequest,File> getFileSettings()

Returns the object with the settings used for calls to getFile.

Returns
Type	Description
UnaryCallSettings<GetFileRequest,File>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

Returns the object with the settings used for calls to getIamPolicy.

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

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

Returns the object with the settings used for calls to getLocation.

Returns
Type	Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getPackageSettings()

public UnaryCallSettings<GetPackageRequest,Package> getPackageSettings()

Returns the object with the settings used for calls to getPackage.

Returns
Type	Description
UnaryCallSettings<GetPackageRequest,Package>

getProjectSettingsSettings()

public UnaryCallSettings<GetProjectSettingsRequest,ProjectSettings> getProjectSettingsSettings()

Returns the object with the settings used for calls to getProjectSettings.

Returns
Type	Description
UnaryCallSettings<GetProjectSettingsRequest,ProjectSettings>

getRepositorySettings()

public UnaryCallSettings<GetRepositoryRequest,Repository> getRepositorySettings()

Returns the object with the settings used for calls to getRepository.

Returns
Type	Description
UnaryCallSettings<GetRepositoryRequest,Repository>

getTagSettings()

public UnaryCallSettings<GetTagRequest,Tag> getTagSettings()

Returns the object with the settings used for calls to getTag.

Returns
Type	Description
UnaryCallSettings<GetTagRequest,Tag>

getVersionSettings()

public UnaryCallSettings<GetVersionRequest,Version> getVersionSettings()

Returns the object with the settings used for calls to getVersion.

Returns
Type	Description
UnaryCallSettings<GetVersionRequest,Version>

importAptArtifactsOperationSettings()

public OperationCallSettings<ImportAptArtifactsRequest,ImportAptArtifactsResponse,ImportAptArtifactsMetadata> importAptArtifactsOperationSettings()

Returns the object with the settings used for calls to importAptArtifacts.

Returns
Type	Description
OperationCallSettings<ImportAptArtifactsRequest,ImportAptArtifactsResponse,ImportAptArtifactsMetadata>

importAptArtifactsSettings()

public UnaryCallSettings<ImportAptArtifactsRequest,Operation> importAptArtifactsSettings()

Returns the object with the settings used for calls to importAptArtifacts.

Returns
Type	Description
UnaryCallSettings<ImportAptArtifactsRequest,Operation>

importYumArtifactsOperationSettings()

public OperationCallSettings<ImportYumArtifactsRequest,ImportYumArtifactsResponse,ImportYumArtifactsMetadata> importYumArtifactsOperationSettings()

Returns the object with the settings used for calls to importYumArtifacts.

Returns
Type	Description
OperationCallSettings<ImportYumArtifactsRequest,ImportYumArtifactsResponse,ImportYumArtifactsMetadata>

importYumArtifactsSettings()

public UnaryCallSettings<ImportYumArtifactsRequest,Operation> importYumArtifactsSettings()

Returns the object with the settings used for calls to importYumArtifacts.

Returns
Type	Description
UnaryCallSettings<ImportYumArtifactsRequest,Operation>

listFilesSettings()

public PagedCallSettings<ListFilesRequest,ListFilesResponse,ArtifactRegistryClient.ListFilesPagedResponse> listFilesSettings()

Returns the object with the settings used for calls to listFiles.

Returns
Type	Description
PagedCallSettings<ListFilesRequest,ListFilesResponse,ListFilesPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,ArtifactRegistryClient.ListLocationsPagedResponse> listLocationsSettings()

Returns the object with the settings used for calls to listLocations.

Returns
Type	Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

listPackagesSettings()

public PagedCallSettings<ListPackagesRequest,ListPackagesResponse,ArtifactRegistryClient.ListPackagesPagedResponse> listPackagesSettings()

Returns the object with the settings used for calls to listPackages.

Returns
Type	Description
PagedCallSettings<ListPackagesRequest,ListPackagesResponse,ListPackagesPagedResponse>

listRepositoriesSettings()

public PagedCallSettings<ListRepositoriesRequest,ListRepositoriesResponse,ArtifactRegistryClient.ListRepositoriesPagedResponse> listRepositoriesSettings()

Returns the object with the settings used for calls to listRepositories.

Returns
Type	Description
PagedCallSettings<ListRepositoriesRequest,ListRepositoriesResponse,ListRepositoriesPagedResponse>

listTagsSettings()

public PagedCallSettings<ListTagsRequest,ListTagsResponse,ArtifactRegistryClient.ListTagsPagedResponse> listTagsSettings()

Returns the object with the settings used for calls to listTags.

Returns
Type	Description
PagedCallSettings<ListTagsRequest,ListTagsResponse,ListTagsPagedResponse>

listVersionsSettings()

public PagedCallSettings<ListVersionsRequest,ListVersionsResponse,ArtifactRegistryClient.ListVersionsPagedResponse> listVersionsSettings()

Returns the object with the settings used for calls to listVersions.

Returns
Type	Description
PagedCallSettings<ListVersionsRequest,ListVersionsResponse,ListVersionsPagedResponse>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

Returns the object with the settings used for calls to setIamPolicy.

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

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

Returns the object with the settings used for calls to testIamPermissions.

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

toBuilder()

public ArtifactRegistrySettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type	Description
ArtifactRegistrySettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateProjectSettingsSettings()

public UnaryCallSettings<UpdateProjectSettingsRequest,ProjectSettings> updateProjectSettingsSettings()

Returns the object with the settings used for calls to updateProjectSettings.

Returns
Type	Description
UnaryCallSettings<UpdateProjectSettingsRequest,ProjectSettings>

updateRepositorySettings()

public UnaryCallSettings<UpdateRepositoryRequest,Repository> updateRepositorySettings()

Returns the object with the settings used for calls to updateRepository.

Returns
Type	Description
UnaryCallSettings<UpdateRepositoryRequest,Repository>

updateTagSettings()

public UnaryCallSettings<UpdateTagRequest,Tag> updateTagSettings()

Returns the object with the settings used for calls to updateTag.

Returns
Type	Description
UnaryCallSettings<UpdateTagRequest,Tag>