Class DataplexServiceSettings (1.1.1)

public class DataplexServiceSettings extends ClientSettings<DataplexServiceSettings>

Settings class to configure an instance of DataplexServiceClient.

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 getLake to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 DataplexServiceSettings.Builder dataplexServiceSettingsBuilder =
     DataplexServiceSettings.newBuilder();
 dataplexServiceSettingsBuilder
     .getLakeSettings()
     .setRetrySettings(
         dataplexServiceSettingsBuilder
             .getLakeSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DataplexServiceSettings dataplexServiceSettings = dataplexServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > DataplexServiceSettings

Static Methods

create(DataplexServiceStubSettings stub)

public static final DataplexServiceSettings create(DataplexServiceStubSettings stub)
Parameter
NameDescription
stubDataplexServiceStubSettings
Returns
TypeDescription
DataplexServiceSettings
Exceptions
TypeDescription
IOException

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 gRPC ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST 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

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static DataplexServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
DataplexServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static DataplexServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
DataplexServiceSettings.Builder

newHttpJsonBuilder()

public static DataplexServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
DataplexServiceSettings.Builder

Constructors

DataplexServiceSettings(DataplexServiceSettings.Builder settingsBuilder)

protected DataplexServiceSettings(DataplexServiceSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderDataplexServiceSettings.Builder

Methods

cancelJobSettings()

public UnaryCallSettings<CancelJobRequest,Empty> cancelJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<CancelJobRequest,Empty>

createAssetOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateAssetRequest,Asset,OperationMetadata>

createAssetSettings()

public UnaryCallSettings<CreateAssetRequest,Operation> createAssetSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateAssetRequest,Operation>

createEnvironmentOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateEnvironmentRequest,Environment,OperationMetadata>

createEnvironmentSettings()

public UnaryCallSettings<CreateEnvironmentRequest,Operation> createEnvironmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateEnvironmentRequest,Operation>

createLakeOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateLakeRequest,Lake,OperationMetadata>

createLakeSettings()

public UnaryCallSettings<CreateLakeRequest,Operation> createLakeSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateLakeRequest,Operation>

createTaskOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateTaskRequest,Task,OperationMetadata>

createTaskSettings()

public UnaryCallSettings<CreateTaskRequest,Operation> createTaskSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateTaskRequest,Operation>

createZoneOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateZoneRequest,Zone,OperationMetadata>

createZoneSettings()

public UnaryCallSettings<CreateZoneRequest,Operation> createZoneSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateZoneRequest,Operation>

deleteAssetOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteAssetRequest,Empty,OperationMetadata>

deleteAssetSettings()

public UnaryCallSettings<DeleteAssetRequest,Operation> deleteAssetSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteAssetRequest,Operation>

deleteEnvironmentOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteEnvironmentRequest,Empty,OperationMetadata>

deleteEnvironmentSettings()

public UnaryCallSettings<DeleteEnvironmentRequest,Operation> deleteEnvironmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteEnvironmentRequest,Operation>

deleteLakeOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteLakeRequest,Empty,OperationMetadata>

deleteLakeSettings()

public UnaryCallSettings<DeleteLakeRequest,Operation> deleteLakeSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteLakeRequest,Operation>

deleteTaskOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteTaskRequest,Empty,OperationMetadata>

deleteTaskSettings()

public UnaryCallSettings<DeleteTaskRequest,Operation> deleteTaskSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteTaskRequest,Operation>

deleteZoneOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteZoneRequest,Empty,OperationMetadata>

deleteZoneSettings()

public UnaryCallSettings<DeleteZoneRequest,Operation> deleteZoneSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteZoneRequest,Operation>

getAssetSettings()

public UnaryCallSettings<GetAssetRequest,Asset> getAssetSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetAssetRequest,Asset>

getEnvironmentSettings()

public UnaryCallSettings<GetEnvironmentRequest,Environment> getEnvironmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetEnvironmentRequest,Environment>

getJobSettings()

public UnaryCallSettings<GetJobRequest,Job> getJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetJobRequest,Job>

getLakeSettings()

public UnaryCallSettings<GetLakeRequest,Lake> getLakeSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetLakeRequest,Lake>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

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

getTaskSettings()

public UnaryCallSettings<GetTaskRequest,Task> getTaskSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetTaskRequest,Task>

getZoneSettings()

public UnaryCallSettings<GetZoneRequest,Zone> getZoneSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetZoneRequest,Zone>

listAssetActionsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListAssetActionsRequest,ListActionsResponse,ListAssetActionsPagedResponse>

listAssetsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListAssetsRequest,ListAssetsResponse,ListAssetsPagedResponse>

listEnvironmentsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListEnvironmentsRequest,ListEnvironmentsResponse,ListEnvironmentsPagedResponse>

listJobsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListJobsRequest,ListJobsResponse,ListJobsPagedResponse>

listLakeActionsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListLakeActionsRequest,ListActionsResponse,ListLakeActionsPagedResponse>

listLakesSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListLakesRequest,ListLakesResponse,ListLakesPagedResponse>

listLocationsSettings()

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

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

Returns
TypeDescription
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
TypeDescription
PagedCallSettings<ListSessionsRequest,ListSessionsResponse,ListSessionsPagedResponse>

listTasksSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListTasksRequest,ListTasksResponse,ListTasksPagedResponse>

listZoneActionsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListZoneActionsRequest,ListActionsResponse,ListZoneActionsPagedResponse>

listZonesSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListZonesRequest,ListZonesResponse,ListZonesPagedResponse>

toBuilder()

public DataplexServiceSettings.Builder toBuilder()

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

Returns
TypeDescription
DataplexServiceSettings.Builder
Overrides

updateAssetOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateAssetRequest,Asset,OperationMetadata>

updateAssetSettings()

public UnaryCallSettings<UpdateAssetRequest,Operation> updateAssetSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateAssetRequest,Operation>

updateEnvironmentOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateEnvironmentRequest,Environment,OperationMetadata>

updateEnvironmentSettings()

public UnaryCallSettings<UpdateEnvironmentRequest,Operation> updateEnvironmentSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateEnvironmentRequest,Operation>

updateLakeOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateLakeRequest,Lake,OperationMetadata>

updateLakeSettings()

public UnaryCallSettings<UpdateLakeRequest,Operation> updateLakeSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateLakeRequest,Operation>

updateTaskOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateTaskRequest,Task,OperationMetadata>

updateTaskSettings()

public UnaryCallSettings<UpdateTaskRequest,Operation> updateTaskSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateTaskRequest,Operation>

updateZoneOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<UpdateZoneRequest,Zone,OperationMetadata>

updateZoneSettings()

public UnaryCallSettings<UpdateZoneRequest,Operation> updateZoneSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateZoneRequest,Operation>