Package com.google.cloud.batch.v1alpha
Class BatchServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<BatchServiceSettings>
com.google.cloud.batch.v1alpha.BatchServiceSettings
@BetaApi
@Generated("by gapic-generator-java")
public class BatchServiceSettings
extends ClientSettings<BatchServiceSettings>
Settings class to configure an instance of
BatchServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (batch.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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of createJob:
// 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
BatchServiceSettings.Builder batchServiceSettingsBuilder = BatchServiceSettings.newBuilder();
batchServiceSettingsBuilder
.createJobSettings()
.setRetrySettings(
batchServiceSettingsBuilder
.createJobSettings()
.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());
BatchServiceSettings batchServiceSettings = batchServiceSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) 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 deleteJob:
// 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
BatchServiceSettings.Builder batchServiceSettingsBuilder = BatchServiceSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
batchServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for BatchServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedBatchServiceSettings(BatchServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to cancelJob.Returns the object with the settings used for calls to cancelJob.static final BatchServiceSettingsReturns the object with the settings used for calls to createJob.Returns the object with the settings used for calls to createResourceAllowance.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteJobRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteJob.Returns the object with the settings used for calls to deleteJob.OperationCallSettings<DeleteResourceAllowanceRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteResourceAllowance.Returns the object with the settings used for calls to deleteResourceAllowance.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getJob.Returns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getResourceAllowance.Returns the object with the settings used for calls to getTask.Returns the object with the settings used for calls to listJobs.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, BatchServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListResourceAllowancesRequest,ListResourceAllowancesResponse, BatchServiceClient.ListResourceAllowancesPagedResponse> Returns the object with the settings used for calls to listResourceAllowances.Returns the object with the settings used for calls to listTasks.static BatchServiceSettings.BuilderReturns a new gRPC builder for this class.static BatchServiceSettings.BuildernewBuilder(ClientContext clientContext) Returns a new builder for this class.static BatchServiceSettings.BuilderReturns a new REST builder for this class.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateJob.Returns the object with the settings used for calls to updateResourceAllowance.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
BatchServiceSettings
- Throws:
IOException
-
-
Method Details
-
createJobSettings
Returns the object with the settings used for calls to createJob. -
getJobSettings
Returns the object with the settings used for calls to getJob. -
deleteJobSettings
Returns the object with the settings used for calls to deleteJob. -
deleteJobOperationSettings
public OperationCallSettings<DeleteJobRequest,com.google.protobuf.Empty, deleteJobOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteJob. -
cancelJobSettings
Returns the object with the settings used for calls to cancelJob. -
cancelJobOperationSettings
public OperationCallSettings<CancelJobRequest,CancelJobResponse, cancelJobOperationSettings()OperationMetadata> Returns the object with the settings used for calls to cancelJob. -
updateJobSettings
Returns the object with the settings used for calls to updateJob. -
listJobsSettings
public PagedCallSettings<ListJobsRequest,ListJobsResponse, listJobsSettings()BatchServiceClient.ListJobsPagedResponse> Returns the object with the settings used for calls to listJobs. -
getTaskSettings
Returns the object with the settings used for calls to getTask. -
listTasksSettings
public PagedCallSettings<ListTasksRequest,ListTasksResponse, listTasksSettings()BatchServiceClient.ListTasksPagedResponse> Returns the object with the settings used for calls to listTasks. -
createResourceAllowanceSettings
public UnaryCallSettings<CreateResourceAllowanceRequest,ResourceAllowance> createResourceAllowanceSettings()Returns the object with the settings used for calls to createResourceAllowance. -
getResourceAllowanceSettings
public UnaryCallSettings<GetResourceAllowanceRequest,ResourceAllowance> getResourceAllowanceSettings()Returns the object with the settings used for calls to getResourceAllowance. -
deleteResourceAllowanceSettings
public UnaryCallSettings<DeleteResourceAllowanceRequest,Operation> deleteResourceAllowanceSettings()Returns the object with the settings used for calls to deleteResourceAllowance. -
deleteResourceAllowanceOperationSettings
public OperationCallSettings<DeleteResourceAllowanceRequest,com.google.protobuf.Empty, deleteResourceAllowanceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteResourceAllowance. -
listResourceAllowancesSettings
public PagedCallSettings<ListResourceAllowancesRequest,ListResourceAllowancesResponse, listResourceAllowancesSettings()BatchServiceClient.ListResourceAllowancesPagedResponse> Returns the object with the settings used for calls to listResourceAllowances. -
updateResourceAllowanceSettings
public UnaryCallSettings<UpdateResourceAllowanceRequest,ResourceAllowance> updateResourceAllowanceSettings()Returns the object with the settings used for calls to updateResourceAllowance. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()BatchServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
create
- Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classClientSettings<BatchServiceSettings>
-