Class DataCatalogStubSettings (1.39.0)

public class DataCatalogStubSettings extends StubSettings<DataCatalogStubSettings>

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 total timeout of createEntryGroup to 30 seconds:


 // 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()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DataCatalogStubSettings dataCatalogSettings = dataCatalogSettingsBuilder.build();

Inheritance

java.lang.Object > StubSettings > DataCatalogStubSettings

Inherited Members

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getGdchApiAudience()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getServiceName()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.getUniverseDomain()

StubSettings.toBuilder()

StubSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

Returns a new gRPC builder for this class.

Returns
Type	Description
`DataCatalogStubSettings.Builder`

newBuilder(ClientContext clientContext)

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

public static DataCatalogStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
`DataCatalogStubSettings.Builder`

Constructors

DataCatalogStubSettings(DataCatalogStubSettings.Builder settingsBuilder)

protected DataCatalogStubSettings(DataCatalogStubSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`DataCatalogStubSettings.Builder`

Methods

createEntryGroupSettings()

public UnaryCallSettings<CreateEntryGroupRequest,EntryGroup> createEntryGroupSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateEntryGroupRequest,EntryGroup>`

createEntrySettings()

public UnaryCallSettings<CreateEntryRequest,Entry> createEntrySettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateEntryRequest,Entry>`

createStub()

public DataCatalogStub createStub()

Returns
Type	Description
`DataCatalogStub`

Exceptions
Type	Description
`IOException`

createTagSettings()

public UnaryCallSettings<CreateTagRequest,Tag> createTagSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateTagRequest,Tag>`

createTagTemplateFieldSettings()

public UnaryCallSettings<CreateTagTemplateFieldRequest,TagTemplateField> createTagTemplateFieldSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateTagTemplateFieldRequest,TagTemplateField>`

createTagTemplateSettings()

public UnaryCallSettings<CreateTagTemplateRequest,TagTemplate> createTagTemplateSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateTagTemplateRequest,TagTemplate>`

deleteEntryGroupSettings()

public UnaryCallSettings<DeleteEntryGroupRequest,Empty> deleteEntryGroupSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteEntryGroupRequest,Empty>`

deleteEntrySettings()

public UnaryCallSettings<DeleteEntryRequest,Empty> deleteEntrySettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteEntryRequest,Empty>`

deleteTagSettings()

public UnaryCallSettings<DeleteTagRequest,Empty> deleteTagSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteTagRequest,Empty>`

deleteTagTemplateFieldSettings()

public UnaryCallSettings<DeleteTagTemplateFieldRequest,Empty> deleteTagTemplateFieldSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteTagTemplateFieldRequest,Empty>`

deleteTagTemplateSettings()

public UnaryCallSettings<DeleteTagTemplateRequest,Empty> deleteTagTemplateSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteTagTemplateRequest,Empty>`

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>`

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>`

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type	Description
`String`

Overrides

StubSettings<SettingsT>.getServiceName()

getTagTemplateSettings()

public UnaryCallSettings<GetTagTemplateRequest,TagTemplate> getTagTemplateSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetTagTemplateRequest,TagTemplate>`

importEntriesOperationSettings()

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

public UnaryCallSettings<ImportEntriesRequest,Operation> importEntriesSettings()

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

Returns
Type	Description
`UnaryCallSettings<ImportEntriesRequest,Operation>`

listEntriesSettings()

public PagedCallSettings<ListEntriesRequest,ListEntriesResponse,DataCatalogClient.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,DataCatalogClient.ListEntryGroupsPagedResponse> listEntryGroupsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListEntryGroupsRequest,ListEntryGroupsResponse,ListEntryGroupsPagedResponse>`

listTagsSettings()

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

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

Returns
Type	Description
`PagedCallSettings<ListTagsRequest,ListTagsResponse,ListTagsPagedResponse>`

lookupEntrySettings()

public UnaryCallSettings<LookupEntryRequest,Entry> lookupEntrySettings()

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

Returns
Type	Description
`UnaryCallSettings<LookupEntryRequest,Entry>`

modifyEntryContactsSettings()

public UnaryCallSettings<ModifyEntryContactsRequest,Contacts> modifyEntryContactsSettings()

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

Returns
Type	Description
`UnaryCallSettings<ModifyEntryContactsRequest,Contacts>`

modifyEntryOverviewSettings()

public UnaryCallSettings<ModifyEntryOverviewRequest,EntryOverview> modifyEntryOverviewSettings()

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

Returns
Type	Description
`UnaryCallSettings<ModifyEntryOverviewRequest,EntryOverview>`

reconcileTagsOperationSettings()

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

public UnaryCallSettings<ReconcileTagsRequest,Operation> reconcileTagsSettings()

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

Returns
Type	Description
`UnaryCallSettings<ReconcileTagsRequest,Operation>`

renameTagTemplateFieldEnumValueSettings()

public UnaryCallSettings<RenameTagTemplateFieldEnumValueRequest,TagTemplateField> renameTagTemplateFieldEnumValueSettings()

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

Returns
Type	Description
`UnaryCallSettings<RenameTagTemplateFieldEnumValueRequest,TagTemplateField>`

renameTagTemplateFieldSettings()

public UnaryCallSettings<RenameTagTemplateFieldRequest,TagTemplateField> renameTagTemplateFieldSettings()

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

Returns
Type	Description
`UnaryCallSettings<RenameTagTemplateFieldRequest,TagTemplateField>`

searchCatalogSettings()

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

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

Returns
Type	Description
`PagedCallSettings<SearchCatalogRequest,SearchCatalogResponse,SearchCatalogPagedResponse>`

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>`

starEntrySettings()

public UnaryCallSettings<StarEntryRequest,StarEntryResponse> starEntrySettings()

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

Returns
Type	Description
`UnaryCallSettings<StarEntryRequest,StarEntryResponse>`

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

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

Returns
Type	Description
`DataCatalogStubSettings.Builder`

Overrides

StubSettings<SettingsT>.toBuilder()

unstarEntrySettings()

public UnaryCallSettings<UnstarEntryRequest,UnstarEntryResponse> unstarEntrySettings()

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

Returns
Type	Description
`UnaryCallSettings<UnstarEntryRequest,UnstarEntryResponse>`

updateEntryGroupSettings()

public UnaryCallSettings<UpdateEntryGroupRequest,EntryGroup> updateEntryGroupSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateEntryGroupRequest,EntryGroup>`

updateEntrySettings()

public UnaryCallSettings<UpdateEntryRequest,Entry> updateEntrySettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateEntryRequest,Entry>`

updateTagSettings()

public UnaryCallSettings<UpdateTagRequest,Tag> updateTagSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateTagRequest,Tag>`

updateTagTemplateFieldSettings()

public UnaryCallSettings<UpdateTagTemplateFieldRequest,TagTemplateField> updateTagTemplateFieldSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateTagTemplateFieldRequest,TagTemplateField>`

updateTagTemplateSettings()

public UnaryCallSettings<UpdateTagTemplateRequest,TagTemplate> updateTagTemplateSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateTagTemplateRequest,TagTemplate>`