Class DataCatalogSettings
- java.lang.Object
-
- com.google.api.gax.rpc.ClientSettings<DataCatalogSettings>
-
- com.google.cloud.datacatalog.v1beta1.DataCatalogSettings
-
@BetaApi @Generated("by gapic-generator-java") public class DataCatalogSettings extends com.google.api.gax.rpc.ClientSettings<DataCatalogSettings>
Settings class to configure an instance ofDataCatalogClient
.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();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DataCatalogSettings.Builder
Builder for DataCatalogSettings.
-
Constructor Summary
Constructors Modifier Constructor Description protected
DataCatalogSettings(DataCatalogSettings.Builder settingsBuilder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DataCatalogSettings
create(DataCatalogStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<CreateEntryGroupRequest,EntryGroup>
createEntryGroupSettings()
Returns the object with the settings used for calls to createEntryGroup.com.google.api.gax.rpc.UnaryCallSettings<CreateEntryRequest,Entry>
createEntrySettings()
Returns the object with the settings used for calls to createEntry.com.google.api.gax.rpc.UnaryCallSettings<CreateTagRequest,Tag>
createTagSettings()
Returns the object with the settings used for calls to createTag.com.google.api.gax.rpc.UnaryCallSettings<CreateTagTemplateFieldRequest,TagTemplateField>
createTagTemplateFieldSettings()
Returns the object with the settings used for calls to createTagTemplateField.com.google.api.gax.rpc.UnaryCallSettings<CreateTagTemplateRequest,TagTemplate>
createTagTemplateSettings()
Returns the object with the settings used for calls to createTagTemplate.static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder
defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder
defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.static com.google.api.gax.core.InstantiatingExecutorProvider.Builder
defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder
defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.static com.google.api.gax.rpc.TransportChannelProvider
defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<DeleteEntryGroupRequest,com.google.protobuf.Empty>
deleteEntryGroupSettings()
Returns the object with the settings used for calls to deleteEntryGroup.com.google.api.gax.rpc.UnaryCallSettings<DeleteEntryRequest,com.google.protobuf.Empty>
deleteEntrySettings()
Returns the object with the settings used for calls to deleteEntry.com.google.api.gax.rpc.UnaryCallSettings<DeleteTagRequest,com.google.protobuf.Empty>
deleteTagSettings()
Returns the object with the settings used for calls to deleteTag.com.google.api.gax.rpc.UnaryCallSettings<DeleteTagTemplateFieldRequest,com.google.protobuf.Empty>
deleteTagTemplateFieldSettings()
Returns the object with the settings used for calls to deleteTagTemplateField.com.google.api.gax.rpc.UnaryCallSettings<DeleteTagTemplateRequest,com.google.protobuf.Empty>
deleteTagTemplateSettings()
Returns the object with the settings used for calls to deleteTagTemplate.static String
getDefaultEndpoint()
Returns the default service endpoint.static List<String>
getDefaultServiceScopes()
Returns the default service scopes.com.google.api.gax.rpc.UnaryCallSettings<GetEntryGroupRequest,EntryGroup>
getEntryGroupSettings()
Returns the object with the settings used for calls to getEntryGroup.com.google.api.gax.rpc.UnaryCallSettings<GetEntryRequest,Entry>
getEntrySettings()
Returns the object with the settings used for calls to getEntry.com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>
getIamPolicySettings()
Returns the object with the settings used for calls to getIamPolicy.com.google.api.gax.rpc.UnaryCallSettings<GetTagTemplateRequest,TagTemplate>
getTagTemplateSettings()
Returns the object with the settings used for calls to getTagTemplate.com.google.api.gax.rpc.PagedCallSettings<ListEntriesRequest,ListEntriesResponse,DataCatalogClient.ListEntriesPagedResponse>
listEntriesSettings()
Returns the object with the settings used for calls to listEntries.com.google.api.gax.rpc.PagedCallSettings<ListEntryGroupsRequest,ListEntryGroupsResponse,DataCatalogClient.ListEntryGroupsPagedResponse>
listEntryGroupsSettings()
Returns the object with the settings used for calls to listEntryGroups.com.google.api.gax.rpc.PagedCallSettings<ListTagsRequest,ListTagsResponse,DataCatalogClient.ListTagsPagedResponse>
listTagsSettings()
Returns the object with the settings used for calls to listTags.com.google.api.gax.rpc.UnaryCallSettings<LookupEntryRequest,Entry>
lookupEntrySettings()
Returns the object with the settings used for calls to lookupEntry.static DataCatalogSettings.Builder
newBuilder()
Returns a new gRPC builder for this class.static DataCatalogSettings.Builder
newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.static DataCatalogSettings.Builder
newHttpJsonBuilder()
Returns a new REST builder for this class.com.google.api.gax.rpc.UnaryCallSettings<RenameTagTemplateFieldEnumValueRequest,TagTemplateField>
renameTagTemplateFieldEnumValueSettings()
Returns the object with the settings used for calls to renameTagTemplateFieldEnumValue.com.google.api.gax.rpc.UnaryCallSettings<RenameTagTemplateFieldRequest,TagTemplateField>
renameTagTemplateFieldSettings()
Returns the object with the settings used for calls to renameTagTemplateField.com.google.api.gax.rpc.PagedCallSettings<SearchCatalogRequest,SearchCatalogResponse,DataCatalogClient.SearchCatalogPagedResponse>
searchCatalogSettings()
Returns the object with the settings used for calls to searchCatalog.com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>
setIamPolicySettings()
Returns the object with the settings used for calls to setIamPolicy.com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>
testIamPermissionsSettings()
Returns the object with the settings used for calls to testIamPermissions.DataCatalogSettings.Builder
toBuilder()
Returns a builder containing all the values of this settings class.com.google.api.gax.rpc.UnaryCallSettings<UpdateEntryGroupRequest,EntryGroup>
updateEntryGroupSettings()
Returns the object with the settings used for calls to updateEntryGroup.com.google.api.gax.rpc.UnaryCallSettings<UpdateEntryRequest,Entry>
updateEntrySettings()
Returns the object with the settings used for calls to updateEntry.com.google.api.gax.rpc.UnaryCallSettings<UpdateTagRequest,Tag>
updateTagSettings()
Returns the object with the settings used for calls to updateTag.com.google.api.gax.rpc.UnaryCallSettings<UpdateTagTemplateFieldRequest,TagTemplateField>
updateTagTemplateFieldSettings()
Returns the object with the settings used for calls to updateTagTemplateField.com.google.api.gax.rpc.UnaryCallSettings<UpdateTagTemplateRequest,TagTemplate>
updateTagTemplateSettings()
Returns the object with the settings used for calls to updateTagTemplate.-
Methods inherited from class com.google.api.gax.rpc.ClientSettings
getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString
-
-
-
-
Constructor Detail
-
DataCatalogSettings
protected DataCatalogSettings(DataCatalogSettings.Builder settingsBuilder) throws IOException
- Throws:
IOException
-
-
Method Detail
-
searchCatalogSettings
public com.google.api.gax.rpc.PagedCallSettings<SearchCatalogRequest,SearchCatalogResponse,DataCatalogClient.SearchCatalogPagedResponse> searchCatalogSettings()
Returns the object with the settings used for calls to searchCatalog.
-
createEntryGroupSettings
public com.google.api.gax.rpc.UnaryCallSettings<CreateEntryGroupRequest,EntryGroup> createEntryGroupSettings()
Returns the object with the settings used for calls to createEntryGroup.
-
updateEntryGroupSettings
public com.google.api.gax.rpc.UnaryCallSettings<UpdateEntryGroupRequest,EntryGroup> updateEntryGroupSettings()
Returns the object with the settings used for calls to updateEntryGroup.
-
getEntryGroupSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetEntryGroupRequest,EntryGroup> getEntryGroupSettings()
Returns the object with the settings used for calls to getEntryGroup.
-
deleteEntryGroupSettings
public com.google.api.gax.rpc.UnaryCallSettings<DeleteEntryGroupRequest,com.google.protobuf.Empty> deleteEntryGroupSettings()
Returns the object with the settings used for calls to deleteEntryGroup.
-
listEntryGroupsSettings
public com.google.api.gax.rpc.PagedCallSettings<ListEntryGroupsRequest,ListEntryGroupsResponse,DataCatalogClient.ListEntryGroupsPagedResponse> listEntryGroupsSettings()
Returns the object with the settings used for calls to listEntryGroups.
-
createEntrySettings
public com.google.api.gax.rpc.UnaryCallSettings<CreateEntryRequest,Entry> createEntrySettings()
Returns the object with the settings used for calls to createEntry.
-
updateEntrySettings
public com.google.api.gax.rpc.UnaryCallSettings<UpdateEntryRequest,Entry> updateEntrySettings()
Returns the object with the settings used for calls to updateEntry.
-
deleteEntrySettings
public com.google.api.gax.rpc.UnaryCallSettings<DeleteEntryRequest,com.google.protobuf.Empty> deleteEntrySettings()
Returns the object with the settings used for calls to deleteEntry.
-
getEntrySettings
public com.google.api.gax.rpc.UnaryCallSettings<GetEntryRequest,Entry> getEntrySettings()
Returns the object with the settings used for calls to getEntry.
-
lookupEntrySettings
public com.google.api.gax.rpc.UnaryCallSettings<LookupEntryRequest,Entry> lookupEntrySettings()
Returns the object with the settings used for calls to lookupEntry.
-
listEntriesSettings
public com.google.api.gax.rpc.PagedCallSettings<ListEntriesRequest,ListEntriesResponse,DataCatalogClient.ListEntriesPagedResponse> listEntriesSettings()
Returns the object with the settings used for calls to listEntries.
-
createTagTemplateSettings
public com.google.api.gax.rpc.UnaryCallSettings<CreateTagTemplateRequest,TagTemplate> createTagTemplateSettings()
Returns the object with the settings used for calls to createTagTemplate.
-
getTagTemplateSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetTagTemplateRequest,TagTemplate> getTagTemplateSettings()
Returns the object with the settings used for calls to getTagTemplate.
-
updateTagTemplateSettings
public com.google.api.gax.rpc.UnaryCallSettings<UpdateTagTemplateRequest,TagTemplate> updateTagTemplateSettings()
Returns the object with the settings used for calls to updateTagTemplate.
-
deleteTagTemplateSettings
public com.google.api.gax.rpc.UnaryCallSettings<DeleteTagTemplateRequest,com.google.protobuf.Empty> deleteTagTemplateSettings()
Returns the object with the settings used for calls to deleteTagTemplate.
-
createTagTemplateFieldSettings
public com.google.api.gax.rpc.UnaryCallSettings<CreateTagTemplateFieldRequest,TagTemplateField> createTagTemplateFieldSettings()
Returns the object with the settings used for calls to createTagTemplateField.
-
updateTagTemplateFieldSettings
public com.google.api.gax.rpc.UnaryCallSettings<UpdateTagTemplateFieldRequest,TagTemplateField> updateTagTemplateFieldSettings()
Returns the object with the settings used for calls to updateTagTemplateField.
-
renameTagTemplateFieldSettings
public com.google.api.gax.rpc.UnaryCallSettings<RenameTagTemplateFieldRequest,TagTemplateField> renameTagTemplateFieldSettings()
Returns the object with the settings used for calls to renameTagTemplateField.
-
renameTagTemplateFieldEnumValueSettings
public com.google.api.gax.rpc.UnaryCallSettings<RenameTagTemplateFieldEnumValueRequest,TagTemplateField> renameTagTemplateFieldEnumValueSettings()
Returns the object with the settings used for calls to renameTagTemplateFieldEnumValue.
-
deleteTagTemplateFieldSettings
public com.google.api.gax.rpc.UnaryCallSettings<DeleteTagTemplateFieldRequest,com.google.protobuf.Empty> deleteTagTemplateFieldSettings()
Returns the object with the settings used for calls to deleteTagTemplateField.
-
createTagSettings
public com.google.api.gax.rpc.UnaryCallSettings<CreateTagRequest,Tag> createTagSettings()
Returns the object with the settings used for calls to createTag.
-
updateTagSettings
public com.google.api.gax.rpc.UnaryCallSettings<UpdateTagRequest,Tag> updateTagSettings()
Returns the object with the settings used for calls to updateTag.
-
deleteTagSettings
public com.google.api.gax.rpc.UnaryCallSettings<DeleteTagRequest,com.google.protobuf.Empty> deleteTagSettings()
Returns the object with the settings used for calls to deleteTag.
-
listTagsSettings
public com.google.api.gax.rpc.PagedCallSettings<ListTagsRequest,ListTagsResponse,DataCatalogClient.ListTagsPagedResponse> listTagsSettings()
Returns the object with the settings used for calls to listTags.
-
setIamPolicySettings
public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()
Returns the object with the settings used for calls to setIamPolicy.
-
getIamPolicySettings
public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()
Returns the object with the settings used for calls to getIamPolicy.
-
testIamPermissionsSettings
public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()
Returns the object with the settings used for calls to testIamPermissions.
-
create
public static final DataCatalogSettings create(DataCatalogStubSettings stub) throws IOException
- Throws:
IOException
-
defaultExecutorProviderBuilder
public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.
-
getDefaultEndpoint
public static String getDefaultEndpoint()
Returns the default service endpoint.
-
getDefaultServiceScopes
public static List<String> getDefaultServiceScopes()
Returns the default service scopes.
-
defaultCredentialsProviderBuilder
public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.
-
defaultGrpcTransportProviderBuilder
public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.
-
defaultHttpJsonTransportProviderBuilder
@BetaApi public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.
-
defaultTransportChannelProvider
public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()
-
defaultApiClientHeaderProviderBuilder
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.") public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
-
newBuilder
public static DataCatalogSettings.Builder newBuilder()
Returns a new gRPC builder for this class.
-
newHttpJsonBuilder
@BetaApi public static DataCatalogSettings.Builder newHttpJsonBuilder()
Returns a new REST builder for this class.
-
newBuilder
public static DataCatalogSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
-
toBuilder
public DataCatalogSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.- Specified by:
toBuilder
in classcom.google.api.gax.rpc.ClientSettings<DataCatalogSettings>
-
-