Class DataplexServiceStubSettings (1.50.0) 

public class DataplexServiceStubSettings extends StubSettings<DataplexServiceStubSettings>

Settings class to configure an instance of DataplexServiceStub.

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 RetrySettings of getLake:


 // 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
 DataplexServiceStubSettings.Builder dataplexServiceSettingsBuilder =
     DataplexServiceStubSettings.newBuilder();
 dataplexServiceSettingsBuilder
     .getLakeSettings()
     .setRetrySettings(
         dataplexServiceSettingsBuilder
             .getLakeSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 DataplexServiceStubSettings dataplexServiceSettings = dataplexServiceSettingsBuilder.build();

Please refer to the Client Side Retry Guide for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createLake:


 // 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
 DataplexServiceStubSettings.Builder dataplexServiceSettingsBuilder =
     DataplexServiceStubSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 dataplexServiceSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > StubSettings > DataplexServiceStubSettings

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

Returns a new gRPC builder for this class.

Returns
Type Description
DataplexServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static DataplexServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
DataplexServiceStubSettings.Builder

newHttpJsonBuilder()

public static DataplexServiceStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
DataplexServiceStubSettings.Builder

Constructors

DataplexServiceStubSettings(DataplexServiceStubSettings.Builder settingsBuilder)

protected DataplexServiceStubSettings(DataplexServiceStubSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder DataplexServiceStubSettings.Builder

Methods

cancelJobSettings()

public UnaryCallSettings<CancelJobRequest,Empty> cancelJobSettings()

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

Returns
Type Description
UnaryCallSettings<CancelJobRequest,Empty>

createAssetOperationSettings()

public OperationCallSettings<CreateAssetRequest,Asset,OperationMetadata> createAssetOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateAssetRequest,Asset,OperationMetadata>

createAssetSettings()

public UnaryCallSettings<CreateAssetRequest,Operation> createAssetSettings()

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

Returns
Type Description
UnaryCallSettings<CreateAssetRequest,Operation>

createEnvironmentOperationSettings()

public OperationCallSettings<CreateEnvironmentRequest,Environment,OperationMetadata> createEnvironmentOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateEnvironmentRequest,Environment,OperationMetadata>

createEnvironmentSettings()

public UnaryCallSettings<CreateEnvironmentRequest,Operation> createEnvironmentSettings()

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

Returns
Type Description
UnaryCallSettings<CreateEnvironmentRequest,Operation>

createLakeOperationSettings()

public OperationCallSettings<CreateLakeRequest,Lake,OperationMetadata> createLakeOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateLakeRequest,Lake,OperationMetadata>

createLakeSettings()

public UnaryCallSettings<CreateLakeRequest,Operation> createLakeSettings()

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

Returns
Type Description
UnaryCallSettings<CreateLakeRequest,Operation>

createStub()

public DataplexServiceStub createStub()
Returns
Type Description
DataplexServiceStub
Exceptions
Type Description
IOException

createTaskOperationSettings()

public OperationCallSettings<CreateTaskRequest,Task,OperationMetadata> createTaskOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateTaskRequest,Task,OperationMetadata>

createTaskSettings()

public UnaryCallSettings<CreateTaskRequest,Operation> createTaskSettings()

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

Returns
Type Description
UnaryCallSettings<CreateTaskRequest,Operation>

createZoneOperationSettings()

public OperationCallSettings<CreateZoneRequest,Zone,OperationMetadata> createZoneOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateZoneRequest,Zone,OperationMetadata>

createZoneSettings()

public UnaryCallSettings<CreateZoneRequest,Operation> createZoneSettings()

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

Returns
Type Description
UnaryCallSettings<CreateZoneRequest,Operation>

deleteAssetOperationSettings()

public OperationCallSettings<DeleteAssetRequest,Empty,OperationMetadata> deleteAssetOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteAssetRequest,Empty,OperationMetadata>

deleteAssetSettings()

public UnaryCallSettings<DeleteAssetRequest,Operation> deleteAssetSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteAssetRequest,Operation>

deleteEnvironmentOperationSettings()

public OperationCallSettings<DeleteEnvironmentRequest,Empty,OperationMetadata> deleteEnvironmentOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteEnvironmentRequest,Empty,OperationMetadata>

deleteEnvironmentSettings()

public UnaryCallSettings<DeleteEnvironmentRequest,Operation> deleteEnvironmentSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteEnvironmentRequest,Operation>

deleteLakeOperationSettings()

public OperationCallSettings<DeleteLakeRequest,Empty,OperationMetadata> deleteLakeOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteLakeRequest,Empty,OperationMetadata>

deleteLakeSettings()

public UnaryCallSettings<DeleteLakeRequest,Operation> deleteLakeSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteLakeRequest,Operation>

deleteTaskOperationSettings()

public OperationCallSettings<DeleteTaskRequest,Empty,OperationMetadata> deleteTaskOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteTaskRequest,Empty,OperationMetadata>

deleteTaskSettings()

public UnaryCallSettings<DeleteTaskRequest,Operation> deleteTaskSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteTaskRequest,Operation>

deleteZoneOperationSettings()

public OperationCallSettings<DeleteZoneRequest,Empty,OperationMetadata> deleteZoneOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteZoneRequest,Empty,OperationMetadata>

deleteZoneSettings()

public UnaryCallSettings<DeleteZoneRequest,Operation> deleteZoneSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteZoneRequest,Operation>

getAssetSettings()

public UnaryCallSettings<GetAssetRequest,Asset> getAssetSettings()

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

Returns
Type Description
UnaryCallSettings<GetAssetRequest,Asset>

getEnvironmentSettings()

public UnaryCallSettings<GetEnvironmentRequest,Environment> getEnvironmentSettings()

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

Returns
Type Description
UnaryCallSettings<GetEnvironmentRequest,Environment>

getJobSettings()

public UnaryCallSettings<GetJobRequest,Job> getJobSettings()

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

Returns
Type Description
UnaryCallSettings<GetJobRequest,Job>

getLakeSettings()

public UnaryCallSettings<GetLakeRequest,Lake> getLakeSettings()

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

Returns
Type Description
UnaryCallSettings<GetLakeRequest,Lake>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

getTaskSettings()

public UnaryCallSettings<GetTaskRequest,Task> getTaskSettings()

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

Returns
Type Description
UnaryCallSettings<GetTaskRequest,Task>

getZoneSettings()

public UnaryCallSettings<GetZoneRequest,Zone> getZoneSettings()

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

Returns
Type Description
UnaryCallSettings<GetZoneRequest,Zone>

listAssetActionsSettings()

public PagedCallSettings<ListAssetActionsRequest,ListActionsResponse,DataplexServiceClient.ListAssetActionsPagedResponse> listAssetActionsSettings()

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

Returns
Type Description
PagedCallSettings<ListAssetActionsRequest,ListActionsResponse,ListAssetActionsPagedResponse>

listAssetsSettings()

public PagedCallSettings<ListAssetsRequest,ListAssetsResponse,DataplexServiceClient.ListAssetsPagedResponse> listAssetsSettings()

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

Returns
Type Description
PagedCallSettings<ListAssetsRequest,ListAssetsResponse,ListAssetsPagedResponse>

listEnvironmentsSettings()

public PagedCallSettings<ListEnvironmentsRequest,ListEnvironmentsResponse,DataplexServiceClient.ListEnvironmentsPagedResponse> listEnvironmentsSettings()

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

Returns
Type Description
PagedCallSettings<ListEnvironmentsRequest,ListEnvironmentsResponse,ListEnvironmentsPagedResponse>

listJobsSettings()

public PagedCallSettings<ListJobsRequest,ListJobsResponse,DataplexServiceClient.ListJobsPagedResponse> listJobsSettings()

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

Returns
Type Description
PagedCallSettings<ListJobsRequest,ListJobsResponse,ListJobsPagedResponse>

listLakeActionsSettings()

public PagedCallSettings<ListLakeActionsRequest,ListActionsResponse,DataplexServiceClient.ListLakeActionsPagedResponse> listLakeActionsSettings()

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

Returns
Type Description
PagedCallSettings<ListLakeActionsRequest,ListActionsResponse,ListLakeActionsPagedResponse>

listLakesSettings()

public PagedCallSettings<ListLakesRequest,ListLakesResponse,DataplexServiceClient.ListLakesPagedResponse> listLakesSettings()

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

Returns
Type Description
PagedCallSettings<ListLakesRequest,ListLakesResponse,ListLakesPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,DataplexServiceClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
Type Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

listSessionsSettings()

public PagedCallSettings<ListSessionsRequest,ListSessionsResponse,DataplexServiceClient.ListSessionsPagedResponse> listSessionsSettings()

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

Returns
Type Description
PagedCallSettings<ListSessionsRequest,ListSessionsResponse,ListSessionsPagedResponse>

listTasksSettings()

public PagedCallSettings<ListTasksRequest,ListTasksResponse,DataplexServiceClient.ListTasksPagedResponse> listTasksSettings()

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

Returns
Type Description
PagedCallSettings<ListTasksRequest,ListTasksResponse,ListTasksPagedResponse>

listZoneActionsSettings()

public PagedCallSettings<ListZoneActionsRequest,ListActionsResponse,DataplexServiceClient.ListZoneActionsPagedResponse> listZoneActionsSettings()

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

Returns
Type Description
PagedCallSettings<ListZoneActionsRequest,ListActionsResponse,ListZoneActionsPagedResponse>

listZonesSettings()

public PagedCallSettings<ListZonesRequest,ListZonesResponse,DataplexServiceClient.ListZonesPagedResponse> listZonesSettings()

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

Returns
Type Description
PagedCallSettings<ListZonesRequest,ListZonesResponse,ListZonesPagedResponse>

runTaskSettings()

public UnaryCallSettings<RunTaskRequest,RunTaskResponse> runTaskSettings()

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

Returns
Type Description
UnaryCallSettings<RunTaskRequest,RunTaskResponse>

toBuilder()

public DataplexServiceStubSettings.Builder toBuilder()

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

Returns
Type Description
DataplexServiceStubSettings.Builder
Overrides

updateAssetOperationSettings()

public OperationCallSettings<UpdateAssetRequest,Asset,OperationMetadata> updateAssetOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateAssetRequest,Asset,OperationMetadata>

updateAssetSettings()

public UnaryCallSettings<UpdateAssetRequest,Operation> updateAssetSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateAssetRequest,Operation>

updateEnvironmentOperationSettings()

public OperationCallSettings<UpdateEnvironmentRequest,Environment,OperationMetadata> updateEnvironmentOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateEnvironmentRequest,Environment,OperationMetadata>

updateEnvironmentSettings()

public UnaryCallSettings<UpdateEnvironmentRequest,Operation> updateEnvironmentSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateEnvironmentRequest,Operation>

updateLakeOperationSettings()

public OperationCallSettings<UpdateLakeRequest,Lake,OperationMetadata> updateLakeOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateLakeRequest,Lake,OperationMetadata>

updateLakeSettings()

public UnaryCallSettings<UpdateLakeRequest,Operation> updateLakeSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateLakeRequest,Operation>

updateTaskOperationSettings()

public OperationCallSettings<UpdateTaskRequest,Task,OperationMetadata> updateTaskOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateTaskRequest,Task,OperationMetadata>

updateTaskSettings()

public UnaryCallSettings<UpdateTaskRequest,Operation> updateTaskSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateTaskRequest,Operation>

updateZoneOperationSettings()

public OperationCallSettings<UpdateZoneRequest,Zone,OperationMetadata> updateZoneOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateZoneRequest,Zone,OperationMetadata>

updateZoneSettings()

public UnaryCallSettings<UpdateZoneRequest,Operation> updateZoneSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateZoneRequest,Operation>