com.google.cloud.dataplex.v1

Class CatalogServiceSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<CatalogServiceSettings>

com.google.cloud.dataplex.v1.CatalogServiceSettings

@Generated(value="by gapic-generator-java")
public class CatalogServiceSettings
extends com.google.api.gax.rpc.ClientSettings<CatalogServiceSettings>

Settings class to configure an instance of CatalogServiceClient.

The default instance has everything set to sensible defaults:

• The default service address (dataplex.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 getEntryType 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
 CatalogServiceSettings.Builder catalogServiceSettingsBuilder =
     CatalogServiceSettings.newBuilder();
 catalogServiceSettingsBuilder
     .getEntryTypeSettings()
     .setRetrySettings(
         catalogServiceSettingsBuilder
             .getEntryTypeSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CatalogServiceSettings catalogServiceSettings = catalogServiceSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CatalogServiceSettings.Builder Builder for CatalogServiceSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CatalogServiceSettings(CatalogServiceSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
static CatalogServiceSettings	create(CatalogServiceStubSettings stub)
com.google.api.gax.rpc.OperationCallSettings<CreateAspectTypeRequest,AspectType,OperationMetadata>	createAspectTypeOperationSettings() Returns the object with the settings used for calls to createAspectType.
com.google.api.gax.rpc.UnaryCallSettings<CreateAspectTypeRequest,com.google.longrunning.Operation>	createAspectTypeSettings() Returns the object with the settings used for calls to createAspectType.
com.google.api.gax.rpc.OperationCallSettings<CreateEntryGroupRequest,EntryGroup,OperationMetadata>	createEntryGroupOperationSettings() Returns the object with the settings used for calls to createEntryGroup.
com.google.api.gax.rpc.UnaryCallSettings<CreateEntryGroupRequest,com.google.longrunning.Operation>	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.OperationCallSettings<CreateEntryTypeRequest,EntryType,OperationMetadata>	createEntryTypeOperationSettings() Returns the object with the settings used for calls to createEntryType.
com.google.api.gax.rpc.UnaryCallSettings<CreateEntryTypeRequest,com.google.longrunning.Operation>	createEntryTypeSettings() Returns the object with the settings used for calls to createEntryType.
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.OperationCallSettings<DeleteAspectTypeRequest,com.google.protobuf.Empty,OperationMetadata>	deleteAspectTypeOperationSettings() Returns the object with the settings used for calls to deleteAspectType.
com.google.api.gax.rpc.UnaryCallSettings<DeleteAspectTypeRequest,com.google.longrunning.Operation>	deleteAspectTypeSettings() Returns the object with the settings used for calls to deleteAspectType.
com.google.api.gax.rpc.OperationCallSettings<DeleteEntryGroupRequest,com.google.protobuf.Empty,OperationMetadata>	deleteEntryGroupOperationSettings() Returns the object with the settings used for calls to deleteEntryGroup.
com.google.api.gax.rpc.UnaryCallSettings<DeleteEntryGroupRequest,com.google.longrunning.Operation>	deleteEntryGroupSettings() Returns the object with the settings used for calls to deleteEntryGroup.
com.google.api.gax.rpc.UnaryCallSettings<DeleteEntryRequest,Entry>	deleteEntrySettings() Returns the object with the settings used for calls to deleteEntry.
com.google.api.gax.rpc.OperationCallSettings<DeleteEntryTypeRequest,com.google.protobuf.Empty,OperationMetadata>	deleteEntryTypeOperationSettings() Returns the object with the settings used for calls to deleteEntryType.
com.google.api.gax.rpc.UnaryCallSettings<DeleteEntryTypeRequest,com.google.longrunning.Operation>	deleteEntryTypeSettings() Returns the object with the settings used for calls to deleteEntryType.
com.google.api.gax.rpc.UnaryCallSettings<GetAspectTypeRequest,AspectType>	getAspectTypeSettings() Returns the object with the settings used for calls to getAspectType.
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<GetEntryTypeRequest,EntryType>	getEntryTypeSettings() Returns the object with the settings used for calls to getEntryType.
com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>	getLocationSettings() Returns the object with the settings used for calls to getLocation.
com.google.api.gax.rpc.PagedCallSettings<ListAspectTypesRequest,ListAspectTypesResponse,CatalogServiceClient.ListAspectTypesPagedResponse>	listAspectTypesSettings() Returns the object with the settings used for calls to listAspectTypes.
com.google.api.gax.rpc.PagedCallSettings<ListEntriesRequest,ListEntriesResponse,CatalogServiceClient.ListEntriesPagedResponse>	listEntriesSettings() Returns the object with the settings used for calls to listEntries.
com.google.api.gax.rpc.PagedCallSettings<ListEntryGroupsRequest,ListEntryGroupsResponse,CatalogServiceClient.ListEntryGroupsPagedResponse>	listEntryGroupsSettings() Returns the object with the settings used for calls to listEntryGroups.
com.google.api.gax.rpc.PagedCallSettings<ListEntryTypesRequest,ListEntryTypesResponse,CatalogServiceClient.ListEntryTypesPagedResponse>	listEntryTypesSettings() Returns the object with the settings used for calls to listEntryTypes.
com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,CatalogServiceClient.ListLocationsPagedResponse>	listLocationsSettings() Returns the object with the settings used for calls to listLocations.
com.google.api.gax.rpc.UnaryCallSettings<LookupEntryRequest,Entry>	lookupEntrySettings() Returns the object with the settings used for calls to lookupEntry.
static CatalogServiceSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static CatalogServiceSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static CatalogServiceSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.PagedCallSettings<SearchEntriesRequest,SearchEntriesResponse,CatalogServiceClient.SearchEntriesPagedResponse>	searchEntriesSettings() Returns the object with the settings used for calls to searchEntries.
CatalogServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UpdateAspectTypeRequest,AspectType,OperationMetadata>	updateAspectTypeOperationSettings() Returns the object with the settings used for calls to updateAspectType.
com.google.api.gax.rpc.UnaryCallSettings<UpdateAspectTypeRequest,com.google.longrunning.Operation>	updateAspectTypeSettings() Returns the object with the settings used for calls to updateAspectType.
com.google.api.gax.rpc.OperationCallSettings<UpdateEntryGroupRequest,EntryGroup,OperationMetadata>	updateEntryGroupOperationSettings() Returns the object with the settings used for calls to updateEntryGroup.
com.google.api.gax.rpc.UnaryCallSettings<UpdateEntryGroupRequest,com.google.longrunning.Operation>	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.OperationCallSettings<UpdateEntryTypeRequest,EntryType,OperationMetadata>	updateEntryTypeOperationSettings() Returns the object with the settings used for calls to updateEntryType.
com.google.api.gax.rpc.UnaryCallSettings<UpdateEntryTypeRequest,com.google.longrunning.Operation>	updateEntryTypeSettings() Returns the object with the settings used for calls to updateEntryType.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CatalogServiceSettings

protected CatalogServiceSettings(CatalogServiceSettings.Builder settingsBuilder)
                          throws IOException

Throws:

IOException

Method Detail

createEntryTypeSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateEntryTypeRequest,com.google.longrunning.Operation> createEntryTypeSettings()

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

createEntryTypeOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateEntryTypeRequest,EntryType,OperationMetadata> createEntryTypeOperationSettings()

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

updateEntryTypeSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateEntryTypeRequest,com.google.longrunning.Operation> updateEntryTypeSettings()

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

updateEntryTypeOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateEntryTypeRequest,EntryType,OperationMetadata> updateEntryTypeOperationSettings()

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

deleteEntryTypeSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteEntryTypeRequest,com.google.longrunning.Operation> deleteEntryTypeSettings()

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

deleteEntryTypeOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteEntryTypeRequest,com.google.protobuf.Empty,OperationMetadata> deleteEntryTypeOperationSettings()

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

listEntryTypesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListEntryTypesRequest,ListEntryTypesResponse,CatalogServiceClient.ListEntryTypesPagedResponse> listEntryTypesSettings()

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

getEntryTypeSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetEntryTypeRequest,EntryType> getEntryTypeSettings()

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

createAspectTypeSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateAspectTypeRequest,com.google.longrunning.Operation> createAspectTypeSettings()

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

createAspectTypeOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateAspectTypeRequest,AspectType,OperationMetadata> createAspectTypeOperationSettings()

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

updateAspectTypeSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateAspectTypeRequest,com.google.longrunning.Operation> updateAspectTypeSettings()

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

updateAspectTypeOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateAspectTypeRequest,AspectType,OperationMetadata> updateAspectTypeOperationSettings()

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

deleteAspectTypeSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteAspectTypeRequest,com.google.longrunning.Operation> deleteAspectTypeSettings()

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

deleteAspectTypeOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteAspectTypeRequest,com.google.protobuf.Empty,OperationMetadata> deleteAspectTypeOperationSettings()

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

listAspectTypesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListAspectTypesRequest,ListAspectTypesResponse,CatalogServiceClient.ListAspectTypesPagedResponse> listAspectTypesSettings()

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

getAspectTypeSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetAspectTypeRequest,AspectType> getAspectTypeSettings()

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

createEntryGroupSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateEntryGroupRequest,com.google.longrunning.Operation> createEntryGroupSettings()

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

createEntryGroupOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateEntryGroupRequest,EntryGroup,OperationMetadata> createEntryGroupOperationSettings()

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

updateEntryGroupSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateEntryGroupRequest,com.google.longrunning.Operation> updateEntryGroupSettings()

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

updateEntryGroupOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateEntryGroupRequest,EntryGroup,OperationMetadata> updateEntryGroupOperationSettings()

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

deleteEntryGroupSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteEntryGroupRequest,com.google.longrunning.Operation> deleteEntryGroupSettings()

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

deleteEntryGroupOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteEntryGroupRequest,com.google.protobuf.Empty,OperationMetadata> deleteEntryGroupOperationSettings()

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

listEntryGroupsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListEntryGroupsRequest,ListEntryGroupsResponse,CatalogServiceClient.ListEntryGroupsPagedResponse> listEntryGroupsSettings()

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

getEntryGroupSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetEntryGroupRequest,EntryGroup> getEntryGroupSettings()

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

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,Entry> deleteEntrySettings()

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

listEntriesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListEntriesRequest,ListEntriesResponse,CatalogServiceClient.ListEntriesPagedResponse> listEntriesSettings()

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

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.

searchEntriesSettings

public com.google.api.gax.rpc.PagedCallSettings<SearchEntriesRequest,SearchEntriesResponse,CatalogServiceClient.SearchEntriesPagedResponse> searchEntriesSettings()

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

listLocationsSettings

public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,CatalogServiceClient.ListLocationsPagedResponse> listLocationsSettings()

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

getLocationSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationSettings()

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

create

public static final CatalogServiceSettings create(CatalogServiceStubSettings 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

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static CatalogServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static CatalogServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static CatalogServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public CatalogServiceSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<CatalogServiceSettings>