Class DataCatalogStubSettings (1.66.0) 

public class DataCatalogStubSettings extends StubSettings<DataCatalogStubSettings>

Deprecated. This class is deprecated and will be removed in the next major version update.

Settings class to configure an instance of DataCatalogStub.

The default instance has everything set to sensible defaults:

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


 // 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
 DataCatalogStubSettings.Builder dataCatalogSettingsBuilder =
     DataCatalogStubSettings.newBuilder();
 dataCatalogSettingsBuilder
     .createEntryGroupSettings()
     .setRetrySettings(
         dataCatalogSettingsBuilder
             .createEntryGroupSettings()
             .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());
 DataCatalogStubSettings dataCatalogSettings = dataCatalogSettingsBuilder.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 reconcileTags:


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

Inheritance

java.lang.Object > StubSettings > DataCatalogStubSettings

Static Methods

defaultApiClientHeaderProviderBuilder() (deprecated)

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder() (deprecated)

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder() (deprecated)

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcApiClientHeaderProviderBuilder() (deprecated)

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder() (deprecated)

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
Type Description
Builder

defaultHttpJsonApiClientHeaderProviderBuilder() (deprecated)

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder() (deprecated)

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns
Type Description
Builder

defaultTransportChannelProvider() (deprecated)

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint() (deprecated)

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultMtlsEndpoint() (deprecated)

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
Type Description
String

getDefaultServiceScopes() (deprecated)

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder() (deprecated)

public static DataCatalogStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
DataCatalogStubSettings.Builder

newBuilder(ClientContext clientContext) (deprecated)

public static DataCatalogStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
DataCatalogStubSettings.Builder

newHttpJsonBuilder() (deprecated)

public static DataCatalogStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
DataCatalogStubSettings.Builder

Constructors

DataCatalogStubSettings(DataCatalogStubSettings.Builder settingsBuilder) (deprecated)

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

Methods

createEntryGroupSettings() (deprecated)

public UnaryCallSettings<CreateEntryGroupRequest,EntryGroup> createEntryGroupSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<CreateEntryGroupRequest,EntryGroup>

createEntrySettings() (deprecated)

public UnaryCallSettings<CreateEntryRequest,Entry> createEntrySettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<CreateEntryRequest,Entry>

createStub() (deprecated)

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

createTagSettings() (deprecated)

public UnaryCallSettings<CreateTagRequest,Tag> createTagSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<CreateTagRequest,Tag>

createTagTemplateFieldSettings() (deprecated)

public UnaryCallSettings<CreateTagTemplateFieldRequest,TagTemplateField> createTagTemplateFieldSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<CreateTagTemplateFieldRequest,TagTemplateField>

createTagTemplateSettings() (deprecated)

public UnaryCallSettings<CreateTagTemplateRequest,TagTemplate> createTagTemplateSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<CreateTagTemplateRequest,TagTemplate>

deleteEntryGroupSettings() (deprecated)

public UnaryCallSettings<DeleteEntryGroupRequest,Empty> deleteEntryGroupSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<DeleteEntryGroupRequest,Empty>

deleteEntrySettings() (deprecated)

public UnaryCallSettings<DeleteEntryRequest,Empty> deleteEntrySettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<DeleteEntryRequest,Empty>

deleteTagSettings() (deprecated)

public UnaryCallSettings<DeleteTagRequest,Empty> deleteTagSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<DeleteTagRequest,Empty>

deleteTagTemplateFieldSettings() (deprecated)

public UnaryCallSettings<DeleteTagTemplateFieldRequest,Empty> deleteTagTemplateFieldSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<DeleteTagTemplateFieldRequest,Empty>

deleteTagTemplateSettings() (deprecated)

public UnaryCallSettings<DeleteTagTemplateRequest,Empty> deleteTagTemplateSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<DeleteTagTemplateRequest,Empty>

getEntryGroupSettings() (deprecated)

public UnaryCallSettings<GetEntryGroupRequest,EntryGroup> getEntryGroupSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<GetEntryGroupRequest,EntryGroup>

getEntrySettings() (deprecated)

public UnaryCallSettings<GetEntryRequest,Entry> getEntrySettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<GetEntryRequest,Entry>

getIamPolicySettings() (deprecated)

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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>

getServiceName() (deprecated)

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

getTagTemplateSettings() (deprecated)

public UnaryCallSettings<GetTagTemplateRequest,TagTemplate> getTagTemplateSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<GetTagTemplateRequest,TagTemplate>

importEntriesOperationSettings() (deprecated)

public OperationCallSettings<ImportEntriesRequest,ImportEntriesResponse,ImportEntriesMetadata> importEntriesOperationSettings()

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

Returns
Type Description
OperationCallSettings<ImportEntriesRequest,ImportEntriesResponse,ImportEntriesMetadata>

importEntriesSettings() (deprecated)

public UnaryCallSettings<ImportEntriesRequest,Operation> importEntriesSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<ImportEntriesRequest,Operation>

listEntriesSettings() (deprecated)

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

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
PagedCallSettings<ListEntriesRequest,ListEntriesResponse,ListEntriesPagedResponse>

listEntryGroupsSettings() (deprecated)

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

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
PagedCallSettings<ListEntryGroupsRequest,ListEntryGroupsResponse,ListEntryGroupsPagedResponse>

listTagsSettings() (deprecated)

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

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
PagedCallSettings<ListTagsRequest,ListTagsResponse,ListTagsPagedResponse>

lookupEntrySettings() (deprecated)

public UnaryCallSettings<LookupEntryRequest,Entry> lookupEntrySettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<LookupEntryRequest,Entry>

modifyEntryContactsSettings() (deprecated)

public UnaryCallSettings<ModifyEntryContactsRequest,Contacts> modifyEntryContactsSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<ModifyEntryContactsRequest,Contacts>

modifyEntryOverviewSettings() (deprecated)

public UnaryCallSettings<ModifyEntryOverviewRequest,EntryOverview> modifyEntryOverviewSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<ModifyEntryOverviewRequest,EntryOverview>

reconcileTagsOperationSettings() (deprecated)

public OperationCallSettings<ReconcileTagsRequest,ReconcileTagsResponse,ReconcileTagsMetadata> reconcileTagsOperationSettings()

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

Returns
Type Description
OperationCallSettings<ReconcileTagsRequest,ReconcileTagsResponse,ReconcileTagsMetadata>

reconcileTagsSettings() (deprecated)

public UnaryCallSettings<ReconcileTagsRequest,Operation> reconcileTagsSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<ReconcileTagsRequest,Operation>

renameTagTemplateFieldEnumValueSettings() (deprecated)

public UnaryCallSettings<RenameTagTemplateFieldEnumValueRequest,TagTemplateField> renameTagTemplateFieldEnumValueSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<RenameTagTemplateFieldEnumValueRequest,TagTemplateField>

renameTagTemplateFieldSettings() (deprecated)

public UnaryCallSettings<RenameTagTemplateFieldRequest,TagTemplateField> renameTagTemplateFieldSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<RenameTagTemplateFieldRequest,TagTemplateField>

retrieveConfigSettings() (deprecated)

public UnaryCallSettings<RetrieveConfigRequest,OrganizationConfig> retrieveConfigSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<RetrieveConfigRequest,OrganizationConfig>

retrieveEffectiveConfigSettings() (deprecated)

public UnaryCallSettings<RetrieveEffectiveConfigRequest,MigrationConfig> retrieveEffectiveConfigSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<RetrieveEffectiveConfigRequest,MigrationConfig>

searchCatalogSettings() (deprecated)

public PagedCallSettings<SearchCatalogRequest,SearchCatalogResponse,DataCatalogClient.SearchCatalogPagedResponse> searchCatalogSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
PagedCallSettings<SearchCatalogRequest,SearchCatalogResponse,SearchCatalogPagedResponse>

setConfigSettings() (deprecated)

public UnaryCallSettings<SetConfigRequest,MigrationConfig> setConfigSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<SetConfigRequest,MigrationConfig>

setIamPolicySettings() (deprecated)

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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>

starEntrySettings() (deprecated)

public UnaryCallSettings<StarEntryRequest,StarEntryResponse> starEntrySettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<StarEntryRequest,StarEntryResponse>

testIamPermissionsSettings() (deprecated)

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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() (deprecated)

public DataCatalogStubSettings.Builder toBuilder()

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

Returns
Type Description
DataCatalogStubSettings.Builder
Overrides

unstarEntrySettings() (deprecated)

public UnaryCallSettings<UnstarEntryRequest,UnstarEntryResponse> unstarEntrySettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<UnstarEntryRequest,UnstarEntryResponse>

updateEntryGroupSettings() (deprecated)

public UnaryCallSettings<UpdateEntryGroupRequest,EntryGroup> updateEntryGroupSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<UpdateEntryGroupRequest,EntryGroup>

updateEntrySettings() (deprecated)

public UnaryCallSettings<UpdateEntryRequest,Entry> updateEntrySettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<UpdateEntryRequest,Entry>

updateTagSettings() (deprecated)

public UnaryCallSettings<UpdateTagRequest,Tag> updateTagSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<UpdateTagRequest,Tag>

updateTagTemplateFieldSettings() (deprecated)

public UnaryCallSettings<UpdateTagTemplateFieldRequest,TagTemplateField> updateTagTemplateFieldSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<UpdateTagTemplateFieldRequest,TagTemplateField>

updateTagTemplateSettings() (deprecated)

public UnaryCallSettings<UpdateTagTemplateRequest,TagTemplate> updateTagTemplateSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

Returns
Type Description
UnaryCallSettings<UpdateTagTemplateRequest,TagTemplate>