Class CatalogServiceStubSettings (1.51.0) 

public class CatalogServiceStubSettings extends StubSettings<CatalogServiceStubSettings>

Settings class to configure an instance of CatalogServiceStub.

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


 // 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
 CatalogServiceStubSettings.Builder catalogServiceSettingsBuilder =
     CatalogServiceStubSettings.newBuilder();
 catalogServiceSettingsBuilder
     .getEntryTypeSettings()
     .setRetrySettings(
         catalogServiceSettingsBuilder
             .getEntryTypeSettings()
             .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());
 CatalogServiceStubSettings catalogServiceSettings = catalogServiceSettingsBuilder.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 createEntryType:


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

Inheritance

java.lang.Object > StubSettings > CatalogServiceStubSettings

Static Methods

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

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
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

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
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

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 CatalogServiceStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
CatalogServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static CatalogServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
CatalogServiceStubSettings.Builder

newHttpJsonBuilder()

public static CatalogServiceStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
CatalogServiceStubSettings.Builder

Constructors

CatalogServiceStubSettings(CatalogServiceStubSettings.Builder settingsBuilder)

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

Methods

createAspectTypeOperationSettings()

public OperationCallSettings<CreateAspectTypeRequest,AspectType,OperationMetadata> createAspectTypeOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateAspectTypeRequest,AspectType,OperationMetadata>

createAspectTypeSettings()

public UnaryCallSettings<CreateAspectTypeRequest,Operation> createAspectTypeSettings()

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

Returns
Type Description
UnaryCallSettings<CreateAspectTypeRequest,Operation>

createEntryGroupOperationSettings()

public OperationCallSettings<CreateEntryGroupRequest,EntryGroup,OperationMetadata> createEntryGroupOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateEntryGroupRequest,EntryGroup,OperationMetadata>

createEntryGroupSettings()

public UnaryCallSettings<CreateEntryGroupRequest,Operation> createEntryGroupSettings()

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

Returns
Type Description
UnaryCallSettings<CreateEntryGroupRequest,Operation>

createEntrySettings()

public UnaryCallSettings<CreateEntryRequest,Entry> createEntrySettings()

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

Returns
Type Description
UnaryCallSettings<CreateEntryRequest,Entry>

createEntryTypeOperationSettings()

public OperationCallSettings<CreateEntryTypeRequest,EntryType,OperationMetadata> createEntryTypeOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateEntryTypeRequest,EntryType,OperationMetadata>

createEntryTypeSettings()

public UnaryCallSettings<CreateEntryTypeRequest,Operation> createEntryTypeSettings()

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

Returns
Type Description
UnaryCallSettings<CreateEntryTypeRequest,Operation>

createStub()

public CatalogServiceStub createStub()
Returns
Type Description
CatalogServiceStub
Exceptions
Type Description
IOException

deleteAspectTypeOperationSettings()

public OperationCallSettings<DeleteAspectTypeRequest,Empty,OperationMetadata> deleteAspectTypeOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteAspectTypeRequest,Empty,OperationMetadata>

deleteAspectTypeSettings()

public UnaryCallSettings<DeleteAspectTypeRequest,Operation> deleteAspectTypeSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteAspectTypeRequest,Operation>

deleteEntryGroupOperationSettings()

public OperationCallSettings<DeleteEntryGroupRequest,Empty,OperationMetadata> deleteEntryGroupOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteEntryGroupRequest,Empty,OperationMetadata>

deleteEntryGroupSettings()

public UnaryCallSettings<DeleteEntryGroupRequest,Operation> deleteEntryGroupSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteEntryGroupRequest,Operation>

deleteEntrySettings()

public UnaryCallSettings<DeleteEntryRequest,Entry> deleteEntrySettings()

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

Returns
Type Description
UnaryCallSettings<DeleteEntryRequest,Entry>

deleteEntryTypeOperationSettings()

public OperationCallSettings<DeleteEntryTypeRequest,Empty,OperationMetadata> deleteEntryTypeOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteEntryTypeRequest,Empty,OperationMetadata>

deleteEntryTypeSettings()

public UnaryCallSettings<DeleteEntryTypeRequest,Operation> deleteEntryTypeSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteEntryTypeRequest,Operation>

getAspectTypeSettings()

public UnaryCallSettings<GetAspectTypeRequest,AspectType> getAspectTypeSettings()

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

Returns
Type Description
UnaryCallSettings<GetAspectTypeRequest,AspectType>

getEntryGroupSettings()

public UnaryCallSettings<GetEntryGroupRequest,EntryGroup> getEntryGroupSettings()

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

Returns
Type Description
UnaryCallSettings<GetEntryGroupRequest,EntryGroup>

getEntrySettings()

public UnaryCallSettings<GetEntryRequest,Entry> getEntrySettings()

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

Returns
Type Description
UnaryCallSettings<GetEntryRequest,Entry>

getEntryTypeSettings()

public UnaryCallSettings<GetEntryTypeRequest,EntryType> getEntryTypeSettings()

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

Returns
Type Description
UnaryCallSettings<GetEntryTypeRequest,EntryType>

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>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

listAspectTypesSettings()

public PagedCallSettings<ListAspectTypesRequest,ListAspectTypesResponse,CatalogServiceClient.ListAspectTypesPagedResponse> listAspectTypesSettings()

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

Returns
Type Description
PagedCallSettings<ListAspectTypesRequest,ListAspectTypesResponse,ListAspectTypesPagedResponse>

listEntriesSettings()

public PagedCallSettings<ListEntriesRequest,ListEntriesResponse,CatalogServiceClient.ListEntriesPagedResponse> listEntriesSettings()

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

Returns
Type Description
PagedCallSettings<ListEntriesRequest,ListEntriesResponse,ListEntriesPagedResponse>

listEntryGroupsSettings()

public PagedCallSettings<ListEntryGroupsRequest,ListEntryGroupsResponse,CatalogServiceClient.ListEntryGroupsPagedResponse> listEntryGroupsSettings()

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

Returns
Type Description
PagedCallSettings<ListEntryGroupsRequest,ListEntryGroupsResponse,ListEntryGroupsPagedResponse>

listEntryTypesSettings()

public PagedCallSettings<ListEntryTypesRequest,ListEntryTypesResponse,CatalogServiceClient.ListEntryTypesPagedResponse> listEntryTypesSettings()

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

Returns
Type Description
PagedCallSettings<ListEntryTypesRequest,ListEntryTypesResponse,ListEntryTypesPagedResponse>

listLocationsSettings()

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

lookupEntrySettings()

public UnaryCallSettings<LookupEntryRequest,Entry> lookupEntrySettings()

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

Returns
Type Description
UnaryCallSettings<LookupEntryRequest,Entry>

searchEntriesSettings()

public PagedCallSettings<SearchEntriesRequest,SearchEntriesResponse,CatalogServiceClient.SearchEntriesPagedResponse> searchEntriesSettings()

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

Returns
Type Description
PagedCallSettings<SearchEntriesRequest,SearchEntriesResponse,SearchEntriesPagedResponse>

toBuilder()

public CatalogServiceStubSettings.Builder toBuilder()

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

Returns
Type Description
CatalogServiceStubSettings.Builder
Overrides

updateAspectTypeOperationSettings()

public OperationCallSettings<UpdateAspectTypeRequest,AspectType,OperationMetadata> updateAspectTypeOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateAspectTypeRequest,AspectType,OperationMetadata>

updateAspectTypeSettings()

public UnaryCallSettings<UpdateAspectTypeRequest,Operation> updateAspectTypeSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateAspectTypeRequest,Operation>

updateEntryGroupOperationSettings()

public OperationCallSettings<UpdateEntryGroupRequest,EntryGroup,OperationMetadata> updateEntryGroupOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateEntryGroupRequest,EntryGroup,OperationMetadata>

updateEntryGroupSettings()

public UnaryCallSettings<UpdateEntryGroupRequest,Operation> updateEntryGroupSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateEntryGroupRequest,Operation>

updateEntrySettings()

public UnaryCallSettings<UpdateEntryRequest,Entry> updateEntrySettings()

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

Returns
Type Description
UnaryCallSettings<UpdateEntryRequest,Entry>

updateEntryTypeOperationSettings()

public OperationCallSettings<UpdateEntryTypeRequest,EntryType,OperationMetadata> updateEntryTypeOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateEntryTypeRequest,EntryType,OperationMetadata>

updateEntryTypeSettings()

public UnaryCallSettings<UpdateEntryTypeRequest,Operation> updateEntryTypeSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateEntryTypeRequest,Operation>