Class DataTaxonomyServiceSettings (1.52.0) 

public class DataTaxonomyServiceSettings extends ClientSettings<DataTaxonomyServiceSettings>

Settings class to configure an instance of DataTaxonomyServiceClient.

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 getDataTaxonomy:


 // 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
 DataTaxonomyServiceSettings.Builder dataTaxonomyServiceSettingsBuilder =
     DataTaxonomyServiceSettings.newBuilder();
 dataTaxonomyServiceSettingsBuilder
     .getDataTaxonomySettings()
     .setRetrySettings(
         dataTaxonomyServiceSettingsBuilder
             .getDataTaxonomySettings()
             .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());
 DataTaxonomyServiceSettings dataTaxonomyServiceSettings =
     dataTaxonomyServiceSettingsBuilder.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 createDataTaxonomy:


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

Inheritance

java.lang.Object > ClientSettings > DataTaxonomyServiceSettings

Static Methods

create(DataTaxonomyServiceStubSettings stub)

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

Returns a new gRPC builder for this class.

Returns
Type Description
DataTaxonomyServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static DataTaxonomyServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
DataTaxonomyServiceSettings.Builder

newHttpJsonBuilder()

public static DataTaxonomyServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
DataTaxonomyServiceSettings.Builder

Constructors

DataTaxonomyServiceSettings(DataTaxonomyServiceSettings.Builder settingsBuilder)

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

Methods

createDataAttributeBindingOperationSettings()

public OperationCallSettings<CreateDataAttributeBindingRequest,DataAttributeBinding,OperationMetadata> createDataAttributeBindingOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateDataAttributeBindingRequest,DataAttributeBinding,OperationMetadata>

createDataAttributeBindingSettings()

public UnaryCallSettings<CreateDataAttributeBindingRequest,Operation> createDataAttributeBindingSettings()

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

Returns
Type Description
UnaryCallSettings<CreateDataAttributeBindingRequest,Operation>

createDataAttributeOperationSettings()

public OperationCallSettings<CreateDataAttributeRequest,DataAttribute,OperationMetadata> createDataAttributeOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateDataAttributeRequest,DataAttribute,OperationMetadata>

createDataAttributeSettings()

public UnaryCallSettings<CreateDataAttributeRequest,Operation> createDataAttributeSettings()

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

Returns
Type Description
UnaryCallSettings<CreateDataAttributeRequest,Operation>

createDataTaxonomyOperationSettings()

public OperationCallSettings<CreateDataTaxonomyRequest,DataTaxonomy,OperationMetadata> createDataTaxonomyOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateDataTaxonomyRequest,DataTaxonomy,OperationMetadata>

createDataTaxonomySettings()

public UnaryCallSettings<CreateDataTaxonomyRequest,Operation> createDataTaxonomySettings()

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

Returns
Type Description
UnaryCallSettings<CreateDataTaxonomyRequest,Operation>

deleteDataAttributeBindingOperationSettings()

public OperationCallSettings<DeleteDataAttributeBindingRequest,Empty,OperationMetadata> deleteDataAttributeBindingOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteDataAttributeBindingRequest,Empty,OperationMetadata>

deleteDataAttributeBindingSettings()

public UnaryCallSettings<DeleteDataAttributeBindingRequest,Operation> deleteDataAttributeBindingSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteDataAttributeBindingRequest,Operation>

deleteDataAttributeOperationSettings()

public OperationCallSettings<DeleteDataAttributeRequest,Empty,OperationMetadata> deleteDataAttributeOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteDataAttributeRequest,Empty,OperationMetadata>

deleteDataAttributeSettings()

public UnaryCallSettings<DeleteDataAttributeRequest,Operation> deleteDataAttributeSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteDataAttributeRequest,Operation>

deleteDataTaxonomyOperationSettings()

public OperationCallSettings<DeleteDataTaxonomyRequest,Empty,OperationMetadata> deleteDataTaxonomyOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteDataTaxonomyRequest,Empty,OperationMetadata>

deleteDataTaxonomySettings()

public UnaryCallSettings<DeleteDataTaxonomyRequest,Operation> deleteDataTaxonomySettings()

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

Returns
Type Description
UnaryCallSettings<DeleteDataTaxonomyRequest,Operation>

getDataAttributeBindingSettings()

public UnaryCallSettings<GetDataAttributeBindingRequest,DataAttributeBinding> getDataAttributeBindingSettings()

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

Returns
Type Description
UnaryCallSettings<GetDataAttributeBindingRequest,DataAttributeBinding>

getDataAttributeSettings()

public UnaryCallSettings<GetDataAttributeRequest,DataAttribute> getDataAttributeSettings()

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

Returns
Type Description
UnaryCallSettings<GetDataAttributeRequest,DataAttribute>

getDataTaxonomySettings()

public UnaryCallSettings<GetDataTaxonomyRequest,DataTaxonomy> getDataTaxonomySettings()

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

Returns
Type Description
UnaryCallSettings<GetDataTaxonomyRequest,DataTaxonomy>

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>

listDataAttributeBindingsSettings()

public PagedCallSettings<ListDataAttributeBindingsRequest,ListDataAttributeBindingsResponse,DataTaxonomyServiceClient.ListDataAttributeBindingsPagedResponse> listDataAttributeBindingsSettings()

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

Returns
Type Description
PagedCallSettings<ListDataAttributeBindingsRequest,ListDataAttributeBindingsResponse,ListDataAttributeBindingsPagedResponse>

listDataAttributesSettings()

public PagedCallSettings<ListDataAttributesRequest,ListDataAttributesResponse,DataTaxonomyServiceClient.ListDataAttributesPagedResponse> listDataAttributesSettings()

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

Returns
Type Description
PagedCallSettings<ListDataAttributesRequest,ListDataAttributesResponse,ListDataAttributesPagedResponse>

listDataTaxonomiesSettings()

public PagedCallSettings<ListDataTaxonomiesRequest,ListDataTaxonomiesResponse,DataTaxonomyServiceClient.ListDataTaxonomiesPagedResponse> listDataTaxonomiesSettings()

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

Returns
Type Description
PagedCallSettings<ListDataTaxonomiesRequest,ListDataTaxonomiesResponse,ListDataTaxonomiesPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,DataTaxonomyServiceClient.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 DataTaxonomyServiceSettings.Builder toBuilder()

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

Returns
Type Description
DataTaxonomyServiceSettings.Builder
Overrides

updateDataAttributeBindingOperationSettings()

public OperationCallSettings<UpdateDataAttributeBindingRequest,DataAttributeBinding,OperationMetadata> updateDataAttributeBindingOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateDataAttributeBindingRequest,DataAttributeBinding,OperationMetadata>

updateDataAttributeBindingSettings()

public UnaryCallSettings<UpdateDataAttributeBindingRequest,Operation> updateDataAttributeBindingSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateDataAttributeBindingRequest,Operation>

updateDataAttributeOperationSettings()

public OperationCallSettings<UpdateDataAttributeRequest,DataAttribute,OperationMetadata> updateDataAttributeOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateDataAttributeRequest,DataAttribute,OperationMetadata>

updateDataAttributeSettings()

public UnaryCallSettings<UpdateDataAttributeRequest,Operation> updateDataAttributeSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateDataAttributeRequest,Operation>

updateDataTaxonomyOperationSettings()

public OperationCallSettings<UpdateDataTaxonomyRequest,DataTaxonomy,OperationMetadata> updateDataTaxonomyOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateDataTaxonomyRequest,DataTaxonomy,OperationMetadata>

updateDataTaxonomySettings()

public UnaryCallSettings<UpdateDataTaxonomyRequest,Operation> updateDataTaxonomySettings()

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

Returns
Type Description
UnaryCallSettings<UpdateDataTaxonomyRequest,Operation>