Class DataCatalogStubSettings (1.8.2)

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 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

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static DataCatalogStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
DataCatalogStubSettings.Builder

newBuilder(ClientContext clientContext)

public static DataCatalogStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
DataCatalogStubSettings.Builder

Constructors

DataCatalogStubSettings(DataCatalogStubSettings.Builder settingsBuilder)

protected DataCatalogStubSettings(DataCatalogStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderDataCatalogStubSettings.Builder

Methods

createEntryGroupSettings()

public UnaryCallSettings<CreateEntryGroupRequest,EntryGroup> createEntryGroupSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateEntryGroupRequest,EntryGroup>

createEntrySettings()

public UnaryCallSettings<CreateEntryRequest,Entry> createEntrySettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateEntryRequest,Entry>

createStub()

public DataCatalogStub createStub()
Returns
TypeDescription
DataCatalogStub
Exceptions
TypeDescription
IOException

createTagSettings()

public UnaryCallSettings<CreateTagRequest,Tag> createTagSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateTagRequest,Tag>

createTagTemplateFieldSettings()

public UnaryCallSettings<CreateTagTemplateFieldRequest,TagTemplateField> createTagTemplateFieldSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateTagTemplateFieldRequest,TagTemplateField>

createTagTemplateSettings()

public UnaryCallSettings<CreateTagTemplateRequest,TagTemplate> createTagTemplateSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateTagTemplateRequest,TagTemplate>

deleteEntryGroupSettings()

public UnaryCallSettings<DeleteEntryGroupRequest,Empty> deleteEntryGroupSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteEntryGroupRequest,Empty>

deleteEntrySettings()

public UnaryCallSettings<DeleteEntryRequest,Empty> deleteEntrySettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteEntryRequest,Empty>

deleteTagSettings()

public UnaryCallSettings<DeleteTagRequest,Empty> deleteTagSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteTagRequest,Empty>

deleteTagTemplateFieldSettings()

public UnaryCallSettings<DeleteTagTemplateFieldRequest,Empty> deleteTagTemplateFieldSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteTagTemplateFieldRequest,Empty>

deleteTagTemplateSettings()

public UnaryCallSettings<DeleteTagTemplateRequest,Empty> deleteTagTemplateSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteTagTemplateRequest,Empty>

getEntryGroupSettings()

public UnaryCallSettings<GetEntryGroupRequest,EntryGroup> getEntryGroupSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetEntryGroupRequest,EntryGroup>

getEntrySettings()

public UnaryCallSettings<GetEntryRequest,Entry> getEntrySettings()

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

Returns
TypeDescription
UnaryCallSettings<GetEntryRequest,Entry>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
TypeDescription
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
TypeDescription
UnaryCallSettings<GetTagTemplateRequest,TagTemplate>

listEntriesSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListEntriesRequest,ListEntriesResponse,ListEntriesPagedResponse>

listEntryGroupsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListEntryGroupsRequest,ListEntryGroupsResponse,ListEntryGroupsPagedResponse>

listTagsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListTagsRequest,ListTagsResponse,ListTagsPagedResponse>

lookupEntrySettings()

public UnaryCallSettings<LookupEntryRequest,Entry> lookupEntrySettings()

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

Returns
TypeDescription
UnaryCallSettings<LookupEntryRequest,Entry>

modifyEntryContactsSettings()

public UnaryCallSettings<ModifyEntryContactsRequest,Contacts> modifyEntryContactsSettings()

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

Returns
TypeDescription
UnaryCallSettings<ModifyEntryContactsRequest,Contacts>

modifyEntryOverviewSettings()

public UnaryCallSettings<ModifyEntryOverviewRequest,EntryOverview> modifyEntryOverviewSettings()

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

Returns
TypeDescription
UnaryCallSettings<ModifyEntryOverviewRequest,EntryOverview>

renameTagTemplateFieldEnumValueSettings()

public UnaryCallSettings<RenameTagTemplateFieldEnumValueRequest,TagTemplateField> renameTagTemplateFieldEnumValueSettings()

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

Returns
TypeDescription
UnaryCallSettings<RenameTagTemplateFieldEnumValueRequest,TagTemplateField>

renameTagTemplateFieldSettings()

public UnaryCallSettings<RenameTagTemplateFieldRequest,TagTemplateField> renameTagTemplateFieldSettings()

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

Returns
TypeDescription
UnaryCallSettings<RenameTagTemplateFieldRequest,TagTemplateField>

searchCatalogSettings()

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

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

Returns
TypeDescription
PagedCallSettings<SearchCatalogRequest,SearchCatalogResponse,SearchCatalogPagedResponse>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
TypeDescription
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
TypeDescription
UnaryCallSettings<StarEntryRequest,StarEntryResponse>

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
TypeDescription
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
TypeDescription
DataCatalogStubSettings.Builder
Overrides

unstarEntrySettings()

public UnaryCallSettings<UnstarEntryRequest,UnstarEntryResponse> unstarEntrySettings()

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

Returns
TypeDescription
UnaryCallSettings<UnstarEntryRequest,UnstarEntryResponse>

updateEntryGroupSettings()

public UnaryCallSettings<UpdateEntryGroupRequest,EntryGroup> updateEntryGroupSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateEntryGroupRequest,EntryGroup>

updateEntrySettings()

public UnaryCallSettings<UpdateEntryRequest,Entry> updateEntrySettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateEntryRequest,Entry>

updateTagSettings()

public UnaryCallSettings<UpdateTagRequest,Tag> updateTagSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateTagRequest,Tag>

updateTagTemplateFieldSettings()

public UnaryCallSettings<UpdateTagTemplateFieldRequest,TagTemplateField> updateTagTemplateFieldSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateTagTemplateFieldRequest,TagTemplateField>

updateTagTemplateSettings()

public UnaryCallSettings<UpdateTagTemplateRequest,TagTemplate> updateTagTemplateSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateTagTemplateRequest,TagTemplate>