Class DataCatalogSettings (1.10.0)

Version 1.10.0

• 1.58.0 (latest)
• 1.57.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.5
• 1.8.4
• 1.7.2
• 1.6.2
• 1.5.4

public class DataCatalogSettings extends ClientSettings<DataCatalogSettings>

Settings class to configure an instance of DataCatalogClient.

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
 DataCatalogSettings.Builder dataCatalogSettingsBuilder = DataCatalogSettings.newBuilder();
 dataCatalogSettingsBuilder
     .createEntryGroupSettings()
     .setRetrySettings(
         dataCatalogSettingsBuilder.createEntryGroupSettings().getRetrySettings().toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DataCatalogSettings dataCatalogSettings = dataCatalogSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > DataCatalogSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.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

create(DataCatalogStubSettings stub)

public static final DataCatalogSettings create(DataCatalogStubSettings stub)

Parameter

Name	Description
stub	DataCatalogStubSettings

Returns

Type	Description
DataCatalogSettings

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

Returns a new gRPC builder for this class.

Returns

Type	Description
DataCatalogSettings.Builder

newBuilder(ClientContext clientContext)

public static DataCatalogSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	ClientContext

Returns

Type	Description
DataCatalogSettings.Builder

newHttpJsonBuilder()

public static DataCatalogSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns

Type	Description
DataCatalogSettings.Builder

Constructors

DataCatalogSettings(DataCatalogSettings.Builder settingsBuilder)

protected DataCatalogSettings(DataCatalogSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	DataCatalogSettings.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>

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>

getTagTemplateSettings()

public UnaryCallSettings<GetTagTemplateRequest,TagTemplate> getTagTemplateSettings()

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

Returns

Type	Description
UnaryCallSettings<GetTagTemplateRequest,TagTemplate>

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>

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

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

Returns

Type	Description
DataCatalogSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>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>