Class RegistrySettings (0.51.0) 

public class RegistrySettings extends ClientSettings<RegistrySettings>

Settings class to configure an instance of RegistryClient.

The default instance has everything set to sensible defaults:

  • The default service address (apigeeregistry.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 getApi:


 // 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
 RegistrySettings.Builder registrySettingsBuilder = RegistrySettings.newBuilder();
 registrySettingsBuilder
     .getApiSettings()
     .setRetrySettings(
         registrySettingsBuilder
             .getApiSettings()
             .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());
 RegistrySettings registrySettings = registrySettingsBuilder.build();

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

Inheritance

java.lang.Object > ClientSettings > RegistrySettings

Static Methods

create(RegistryStubSettings stub)

public static final RegistrySettings create(RegistryStubSettings stub)
Parameter
Name Description
stub RegistryStubSettings
Returns
Type Description
RegistrySettings
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()

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 RegistrySettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
RegistrySettings.Builder

newBuilder(ClientContext clientContext)

public static RegistrySettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
RegistrySettings.Builder

newHttpJsonBuilder()

public static RegistrySettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
RegistrySettings.Builder

Constructors

RegistrySettings(RegistrySettings.Builder settingsBuilder)

protected RegistrySettings(RegistrySettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder RegistrySettings.Builder

Methods

createApiDeploymentSettings()

public UnaryCallSettings<CreateApiDeploymentRequest,ApiDeployment> createApiDeploymentSettings()

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

Returns
Type Description
UnaryCallSettings<CreateApiDeploymentRequest,ApiDeployment>

createApiSettings()

public UnaryCallSettings<CreateApiRequest,Api> createApiSettings()

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

Returns
Type Description
UnaryCallSettings<CreateApiRequest,Api>

createApiSpecSettings()

public UnaryCallSettings<CreateApiSpecRequest,ApiSpec> createApiSpecSettings()

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

Returns
Type Description
UnaryCallSettings<CreateApiSpecRequest,ApiSpec>

createApiVersionSettings()

public UnaryCallSettings<CreateApiVersionRequest,ApiVersion> createApiVersionSettings()

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

Returns
Type Description
UnaryCallSettings<CreateApiVersionRequest,ApiVersion>

createArtifactSettings()

public UnaryCallSettings<CreateArtifactRequest,Artifact> createArtifactSettings()

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

Returns
Type Description
UnaryCallSettings<CreateArtifactRequest,Artifact>

deleteApiDeploymentRevisionSettings()

public UnaryCallSettings<DeleteApiDeploymentRevisionRequest,ApiDeployment> deleteApiDeploymentRevisionSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteApiDeploymentRevisionRequest,ApiDeployment>

deleteApiDeploymentSettings()

public UnaryCallSettings<DeleteApiDeploymentRequest,Empty> deleteApiDeploymentSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteApiDeploymentRequest,Empty>

deleteApiSettings()

public UnaryCallSettings<DeleteApiRequest,Empty> deleteApiSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteApiRequest,Empty>

deleteApiSpecRevisionSettings()

public UnaryCallSettings<DeleteApiSpecRevisionRequest,ApiSpec> deleteApiSpecRevisionSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteApiSpecRevisionRequest,ApiSpec>

deleteApiSpecSettings()

public UnaryCallSettings<DeleteApiSpecRequest,Empty> deleteApiSpecSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteApiSpecRequest,Empty>

deleteApiVersionSettings()

public UnaryCallSettings<DeleteApiVersionRequest,Empty> deleteApiVersionSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteApiVersionRequest,Empty>

deleteArtifactSettings()

public UnaryCallSettings<DeleteArtifactRequest,Empty> deleteArtifactSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteArtifactRequest,Empty>

getApiDeploymentSettings()

public UnaryCallSettings<GetApiDeploymentRequest,ApiDeployment> getApiDeploymentSettings()

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

Returns
Type Description
UnaryCallSettings<GetApiDeploymentRequest,ApiDeployment>

getApiSettings()

public UnaryCallSettings<GetApiRequest,Api> getApiSettings()

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

Returns
Type Description
UnaryCallSettings<GetApiRequest,Api>

getApiSpecContentsSettings()

public UnaryCallSettings<GetApiSpecContentsRequest,HttpBody> getApiSpecContentsSettings()

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

Returns
Type Description
UnaryCallSettings<GetApiSpecContentsRequest,com.google.api.HttpBody>

getApiSpecSettings()

public UnaryCallSettings<GetApiSpecRequest,ApiSpec> getApiSpecSettings()

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

Returns
Type Description
UnaryCallSettings<GetApiSpecRequest,ApiSpec>

getApiVersionSettings()

public UnaryCallSettings<GetApiVersionRequest,ApiVersion> getApiVersionSettings()

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

Returns
Type Description
UnaryCallSettings<GetApiVersionRequest,ApiVersion>

getArtifactContentsSettings()

public UnaryCallSettings<GetArtifactContentsRequest,HttpBody> getArtifactContentsSettings()

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

Returns
Type Description
UnaryCallSettings<GetArtifactContentsRequest,com.google.api.HttpBody>

getArtifactSettings()

public UnaryCallSettings<GetArtifactRequest,Artifact> getArtifactSettings()

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

Returns
Type Description
UnaryCallSettings<GetArtifactRequest,Artifact>

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>

listApiDeploymentRevisionsSettings()

public PagedCallSettings<ListApiDeploymentRevisionsRequest,ListApiDeploymentRevisionsResponse,RegistryClient.ListApiDeploymentRevisionsPagedResponse> listApiDeploymentRevisionsSettings()

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

Returns
Type Description
PagedCallSettings<ListApiDeploymentRevisionsRequest,ListApiDeploymentRevisionsResponse,ListApiDeploymentRevisionsPagedResponse>

listApiDeploymentsSettings()

public PagedCallSettings<ListApiDeploymentsRequest,ListApiDeploymentsResponse,RegistryClient.ListApiDeploymentsPagedResponse> listApiDeploymentsSettings()

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

Returns
Type Description
PagedCallSettings<ListApiDeploymentsRequest,ListApiDeploymentsResponse,ListApiDeploymentsPagedResponse>

listApiSpecRevisionsSettings()

public PagedCallSettings<ListApiSpecRevisionsRequest,ListApiSpecRevisionsResponse,RegistryClient.ListApiSpecRevisionsPagedResponse> listApiSpecRevisionsSettings()

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

Returns
Type Description
PagedCallSettings<ListApiSpecRevisionsRequest,ListApiSpecRevisionsResponse,ListApiSpecRevisionsPagedResponse>

listApiSpecsSettings()

public PagedCallSettings<ListApiSpecsRequest,ListApiSpecsResponse,RegistryClient.ListApiSpecsPagedResponse> listApiSpecsSettings()

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

Returns
Type Description
PagedCallSettings<ListApiSpecsRequest,ListApiSpecsResponse,ListApiSpecsPagedResponse>

listApiVersionsSettings()

public PagedCallSettings<ListApiVersionsRequest,ListApiVersionsResponse,RegistryClient.ListApiVersionsPagedResponse> listApiVersionsSettings()

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

Returns
Type Description
PagedCallSettings<ListApiVersionsRequest,ListApiVersionsResponse,ListApiVersionsPagedResponse>

listApisSettings()

public PagedCallSettings<ListApisRequest,ListApisResponse,RegistryClient.ListApisPagedResponse> listApisSettings()

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

Returns
Type Description
PagedCallSettings<ListApisRequest,ListApisResponse,ListApisPagedResponse>

listArtifactsSettings()

public PagedCallSettings<ListArtifactsRequest,ListArtifactsResponse,RegistryClient.ListArtifactsPagedResponse> listArtifactsSettings()

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

Returns
Type Description
PagedCallSettings<ListArtifactsRequest,ListArtifactsResponse,ListArtifactsPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,RegistryClient.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>

replaceArtifactSettings()

public UnaryCallSettings<ReplaceArtifactRequest,Artifact> replaceArtifactSettings()

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

Returns
Type Description
UnaryCallSettings<ReplaceArtifactRequest,Artifact>

rollbackApiDeploymentSettings()

public UnaryCallSettings<RollbackApiDeploymentRequest,ApiDeployment> rollbackApiDeploymentSettings()

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

Returns
Type Description
UnaryCallSettings<RollbackApiDeploymentRequest,ApiDeployment>

rollbackApiSpecSettings()

public UnaryCallSettings<RollbackApiSpecRequest,ApiSpec> rollbackApiSpecSettings()

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

Returns
Type Description
UnaryCallSettings<RollbackApiSpecRequest,ApiSpec>

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>

tagApiDeploymentRevisionSettings()

public UnaryCallSettings<TagApiDeploymentRevisionRequest,ApiDeployment> tagApiDeploymentRevisionSettings()

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

Returns
Type Description
UnaryCallSettings<TagApiDeploymentRevisionRequest,ApiDeployment>

tagApiSpecRevisionSettings()

public UnaryCallSettings<TagApiSpecRevisionRequest,ApiSpec> tagApiSpecRevisionSettings()

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

Returns
Type Description
UnaryCallSettings<TagApiSpecRevisionRequest,ApiSpec>

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 RegistrySettings.Builder toBuilder()

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

Returns
Type Description
RegistrySettings.Builder
Overrides

updateApiDeploymentSettings()

public UnaryCallSettings<UpdateApiDeploymentRequest,ApiDeployment> updateApiDeploymentSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateApiDeploymentRequest,ApiDeployment>

updateApiSettings()

public UnaryCallSettings<UpdateApiRequest,Api> updateApiSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateApiRequest,Api>

updateApiSpecSettings()

public UnaryCallSettings<UpdateApiSpecRequest,ApiSpec> updateApiSpecSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateApiSpecRequest,ApiSpec>

updateApiVersionSettings()

public UnaryCallSettings<UpdateApiVersionRequest,ApiVersion> updateApiVersionSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateApiVersionRequest,ApiVersion>