public class BatchServiceStubSettings extends StubSettings<BatchServiceStubSettings>Settings class to configure an instance of BatchServiceStub.
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 total timeout of createJob to 30 seconds:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
BatchServiceStubSettings.Builder batchServiceSettingsBuilder =
BatchServiceStubSettings.newBuilder();
batchServiceSettingsBuilder
.createJobSettings()
.setRetrySettings(
batchServiceSettingsBuilder
.createJobSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
BatchServiceStubSettings batchServiceSettings = batchServiceSettingsBuilder.build();
Static Methods
defaultApiClientHeaderProviderBuilder()
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()| Type | Description |
| Builder |
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()Returns a builder for the default credentials for this service.
| Type | Description |
| Builder |
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()Returns a builder for the default ExecutorProvider for this service.
| Type | Description |
| Builder |
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()Returns a builder for the default ChannelProvider for this service.
| Type | Description |
| Builder |
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()| Type | Description |
| TransportChannelProvider |
getDefaultEndpoint()
public static String getDefaultEndpoint()Returns the default service endpoint.
| Type | Description |
| String |
getDefaultMtlsEndpoint()
public static String getDefaultMtlsEndpoint()Returns the default mTLS service endpoint.
| Type | Description |
| String |
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()Returns the default service scopes.
| Type | Description |
| List<String> |
newBuilder()
public static BatchServiceStubSettings.Builder newBuilder()Returns a new builder for this class.
| Type | Description |
| BatchServiceStubSettings.Builder |
newBuilder(ClientContext clientContext)
public static BatchServiceStubSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Name | Description |
| clientContext | ClientContext |
| Type | Description |
| BatchServiceStubSettings.Builder |
Constructors
BatchServiceStubSettings(BatchServiceStubSettings.Builder settingsBuilder)
protected BatchServiceStubSettings(BatchServiceStubSettings.Builder settingsBuilder)| Name | Description |
| settingsBuilder | BatchServiceStubSettings.Builder |
Methods
createJobSettings()
public UnaryCallSettings<CreateJobRequest,Job> createJobSettings()Returns the object with the settings used for calls to createJob.
| Type | Description |
| UnaryCallSettings<CreateJobRequest,Job> |
createStub()
public BatchServiceStub createStub()| Type | Description |
| BatchServiceStub |
| Type | Description |
| IOException |
deleteJobOperationSettings()
public OperationCallSettings<DeleteJobRequest,Empty,OperationMetadata> deleteJobOperationSettings()Returns the object with the settings used for calls to deleteJob.
| Type | Description |
| OperationCallSettings<DeleteJobRequest,Empty,OperationMetadata> |
deleteJobSettings()
public UnaryCallSettings<DeleteJobRequest,Operation> deleteJobSettings()Returns the object with the settings used for calls to deleteJob.
| Type | Description |
| UnaryCallSettings<DeleteJobRequest,Operation> |
getJobSettings()
public UnaryCallSettings<GetJobRequest,Job> getJobSettings()Returns the object with the settings used for calls to getJob.
| Type | Description |
| UnaryCallSettings<GetJobRequest,Job> |
getTaskSettings()
public UnaryCallSettings<GetTaskRequest,Task> getTaskSettings()Returns the object with the settings used for calls to getTask.
| Type | Description |
| UnaryCallSettings<GetTaskRequest,Task> |
listJobsSettings()
public PagedCallSettings<ListJobsRequest,ListJobsResponse,BatchServiceClient.ListJobsPagedResponse> listJobsSettings()Returns the object with the settings used for calls to listJobs.
| Type | Description |
| PagedCallSettings<ListJobsRequest,ListJobsResponse,ListJobsPagedResponse> |
listTasksSettings()
public PagedCallSettings<ListTasksRequest,ListTasksResponse,BatchServiceClient.ListTasksPagedResponse> listTasksSettings()Returns the object with the settings used for calls to listTasks.
| Type | Description |
| PagedCallSettings<ListTasksRequest,ListTasksResponse,ListTasksPagedResponse> |
toBuilder()
public BatchServiceStubSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Type | Description |
| BatchServiceStubSettings.Builder |