Class BusinessGlossaryServiceSettings (1.72.0)

public class BusinessGlossaryServiceSettings extends ClientSettings<BusinessGlossaryServiceSettings>

Settings class to configure an instance of BusinessGlossaryServiceClient.

The default instance has everything set to sensible defaults:

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


 // 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
 BusinessGlossaryServiceSettings.Builder businessGlossaryServiceSettingsBuilder =
     BusinessGlossaryServiceSettings.newBuilder();
 businessGlossaryServiceSettingsBuilder
     .getGlossarySettings()
     .setRetrySettings(
         businessGlossaryServiceSettingsBuilder
             .getGlossarySettings()
             .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());
 BusinessGlossaryServiceSettings businessGlossaryServiceSettings =
     businessGlossaryServiceSettingsBuilder.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 createGlossary:


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

Inheritance

java.lang.Object > ClientSettings > BusinessGlossaryServiceSettings

Static Methods

create(BusinessGlossaryServiceStubSettings stub)

public static final BusinessGlossaryServiceSettings create(BusinessGlossaryServiceStubSettings stub)
Parameter
Name Description
stub BusinessGlossaryServiceStubSettings
Returns
Type Description
BusinessGlossaryServiceSettings
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 BusinessGlossaryServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
BusinessGlossaryServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static BusinessGlossaryServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
BusinessGlossaryServiceSettings.Builder

newHttpJsonBuilder()

public static BusinessGlossaryServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
BusinessGlossaryServiceSettings.Builder

Constructors

BusinessGlossaryServiceSettings(BusinessGlossaryServiceSettings.Builder settingsBuilder)

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

Methods

createGlossaryCategorySettings()

public UnaryCallSettings<CreateGlossaryCategoryRequest,GlossaryCategory> createGlossaryCategorySettings()

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

Returns
Type Description
UnaryCallSettings<CreateGlossaryCategoryRequest,GlossaryCategory>

createGlossaryOperationSettings()

public OperationCallSettings<CreateGlossaryRequest,Glossary,OperationMetadata> createGlossaryOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateGlossaryRequest,Glossary,OperationMetadata>

createGlossarySettings()

public UnaryCallSettings<CreateGlossaryRequest,Operation> createGlossarySettings()

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

Returns
Type Description
UnaryCallSettings<CreateGlossaryRequest,Operation>

createGlossaryTermSettings()

public UnaryCallSettings<CreateGlossaryTermRequest,GlossaryTerm> createGlossaryTermSettings()

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

Returns
Type Description
UnaryCallSettings<CreateGlossaryTermRequest,GlossaryTerm>

deleteGlossaryCategorySettings()

public UnaryCallSettings<DeleteGlossaryCategoryRequest,Empty> deleteGlossaryCategorySettings()

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

Returns
Type Description
UnaryCallSettings<DeleteGlossaryCategoryRequest,Empty>

deleteGlossaryOperationSettings()

public OperationCallSettings<DeleteGlossaryRequest,Empty,OperationMetadata> deleteGlossaryOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteGlossaryRequest,Empty,OperationMetadata>

deleteGlossarySettings()

public UnaryCallSettings<DeleteGlossaryRequest,Operation> deleteGlossarySettings()

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

Returns
Type Description
UnaryCallSettings<DeleteGlossaryRequest,Operation>

deleteGlossaryTermSettings()

public UnaryCallSettings<DeleteGlossaryTermRequest,Empty> deleteGlossaryTermSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteGlossaryTermRequest,Empty>

getGlossaryCategorySettings()

public UnaryCallSettings<GetGlossaryCategoryRequest,GlossaryCategory> getGlossaryCategorySettings()

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

Returns
Type Description
UnaryCallSettings<GetGlossaryCategoryRequest,GlossaryCategory>

getGlossarySettings()

public UnaryCallSettings<GetGlossaryRequest,Glossary> getGlossarySettings()

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

Returns
Type Description
UnaryCallSettings<GetGlossaryRequest,Glossary>

getGlossaryTermSettings()

public UnaryCallSettings<GetGlossaryTermRequest,GlossaryTerm> getGlossaryTermSettings()

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

Returns
Type Description
UnaryCallSettings<GetGlossaryTermRequest,GlossaryTerm>

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>

listGlossariesSettings()

public PagedCallSettings<ListGlossariesRequest,ListGlossariesResponse,BusinessGlossaryServiceClient.ListGlossariesPagedResponse> listGlossariesSettings()

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

Returns
Type Description
PagedCallSettings<ListGlossariesRequest,ListGlossariesResponse,ListGlossariesPagedResponse>

listGlossaryCategoriesSettings()

public PagedCallSettings<ListGlossaryCategoriesRequest,ListGlossaryCategoriesResponse,BusinessGlossaryServiceClient.ListGlossaryCategoriesPagedResponse> listGlossaryCategoriesSettings()

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

Returns
Type Description
PagedCallSettings<ListGlossaryCategoriesRequest,ListGlossaryCategoriesResponse,ListGlossaryCategoriesPagedResponse>

listGlossaryTermsSettings()

public PagedCallSettings<ListGlossaryTermsRequest,ListGlossaryTermsResponse,BusinessGlossaryServiceClient.ListGlossaryTermsPagedResponse> listGlossaryTermsSettings()

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

Returns
Type Description
PagedCallSettings<ListGlossaryTermsRequest,ListGlossaryTermsResponse,ListGlossaryTermsPagedResponse>

listLocationsSettings()

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

toBuilder()

public BusinessGlossaryServiceSettings.Builder toBuilder()

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

Returns
Type Description
BusinessGlossaryServiceSettings.Builder
Overrides

updateGlossaryCategorySettings()

public UnaryCallSettings<UpdateGlossaryCategoryRequest,GlossaryCategory> updateGlossaryCategorySettings()

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

Returns
Type Description
UnaryCallSettings<UpdateGlossaryCategoryRequest,GlossaryCategory>

updateGlossaryOperationSettings()

public OperationCallSettings<UpdateGlossaryRequest,Glossary,OperationMetadata> updateGlossaryOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateGlossaryRequest,Glossary,OperationMetadata>

updateGlossarySettings()

public UnaryCallSettings<UpdateGlossaryRequest,Operation> updateGlossarySettings()

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

Returns
Type Description
UnaryCallSettings<UpdateGlossaryRequest,Operation>

updateGlossaryTermSettings()

public UnaryCallSettings<UpdateGlossaryTermRequest,GlossaryTerm> updateGlossaryTermSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateGlossaryTermRequest,GlossaryTerm>