Class BatchControllerStubSettings (2.3.1) 

public class BatchControllerStubSettings extends StubSettings<BatchControllerStubSettings>

Settings class to configure an instance of BatchControllerStub.

The default instance has everything set to sensible defaults:

  • The default service address (dataproc.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 getBatch to 30 seconds:


 BatchControllerStubSettings.Builder batchControllerSettingsBuilder =
     BatchControllerStubSettings.newBuilder();
 batchControllerSettingsBuilder
     .getBatchSettings()
     .setRetrySettings(
         batchControllerSettingsBuilder
             .getBatchSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 BatchControllerStubSettings batchControllerSettings = batchControllerSettingsBuilder.build();

Inheritance

java.lang.Object > StubSettings > BatchControllerStubSettings

Constructors

BatchControllerStubSettings(BatchControllerStubSettings.Builder settingsBuilder)

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

Methods

createBatchOperationSettings()

public OperationCallSettings<CreateBatchRequest,Batch,BatchOperationMetadata> createBatchOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateBatchRequest,Batch,BatchOperationMetadata>

createBatchSettings()

public UnaryCallSettings<CreateBatchRequest,Operation> createBatchSettings()

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

Returns
Type Description
UnaryCallSettings<CreateBatchRequest,Operation>

createStub()

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

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

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

deleteBatchSettings()

public UnaryCallSettings<DeleteBatchRequest,Empty> deleteBatchSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteBatchRequest,Empty>

getBatchSettings()

public UnaryCallSettings<GetBatchRequest,Batch> getBatchSettings()

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

Returns
Type Description
UnaryCallSettings<GetBatchRequest,Batch>

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>

listBatchesSettings()

public PagedCallSettings<ListBatchesRequest,ListBatchesResponse,BatchControllerClient.ListBatchesPagedResponse> listBatchesSettings()

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

Returns
Type Description
PagedCallSettings<ListBatchesRequest,ListBatchesResponse,ListBatchesPagedResponse>

newBuilder()

public static BatchControllerStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type Description
BatchControllerStubSettings.Builder

newBuilder(ClientContext clientContext)

public static BatchControllerStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
BatchControllerStubSettings.Builder

toBuilder()

public BatchControllerStubSettings.Builder toBuilder()

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

Returns
Type Description
BatchControllerStubSettings.Builder
Overrides