com.google.cloud.batch.v1alpha.stub

Class BatchServiceStubSettings

java.lang.Object

com.google.api.gax.rpc.StubSettings<BatchServiceStubSettings>

com.google.cloud.batch.v1alpha.stub.BatchServiceStubSettings

@BetaApi
 @Generated(value="by gapic-generator-java")
public class BatchServiceStubSettings
extends com.google.api.gax.rpc.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 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
 BatchServiceStubSettings.Builder batchServiceSettingsBuilder =
     BatchServiceStubSettings.newBuilder();
 batchServiceSettingsBuilder
     .createJobSettings()
     .setRetrySettings(
         batchServiceSettingsBuilder
             .createJobSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 BatchServiceStubSettings batchServiceSettings = batchServiceSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BatchServiceStubSettings.Builder Builder for BatchServiceStubSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BatchServiceStubSettings(BatchServiceStubSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.UnaryCallSettings<CreateJobRequest,Job>	createJobSettings() Returns the object with the settings used for calls to createJob.
BatchServiceStub	createStub()
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultGrpcApiClientHeaderProviderBuilder()
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultHttpJsonApiClientHeaderProviderBuilder()
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.OperationCallSettings<DeleteJobRequest,com.google.protobuf.Empty,OperationMetadata>	deleteJobOperationSettings() Returns the object with the settings used for calls to deleteJob.
com.google.api.gax.rpc.UnaryCallSettings<DeleteJobRequest,com.google.longrunning.Operation>	deleteJobSettings() Returns the object with the settings used for calls to deleteJob.
static String	getDefaultEndpoint() Returns the default service endpoint.
static String	getDefaultMtlsEndpoint() Returns the default mTLS service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetJobRequest,Job>	getJobSettings() Returns the object with the settings used for calls to getJob.
com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>	getLocationSettings() Returns the object with the settings used for calls to getLocation.
String	getServiceName() Returns the default service name.
com.google.api.gax.rpc.UnaryCallSettings<GetTaskRequest,Task>	getTaskSettings() Returns the object with the settings used for calls to getTask.
com.google.api.gax.rpc.PagedCallSettings<ListJobsRequest,ListJobsResponse,BatchServiceClient.ListJobsPagedResponse>	listJobsSettings() Returns the object with the settings used for calls to listJobs.
com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,BatchServiceClient.ListLocationsPagedResponse>	listLocationsSettings() Returns the object with the settings used for calls to listLocations.
com.google.api.gax.rpc.PagedCallSettings<ListTasksRequest,ListTasksResponse,BatchServiceClient.ListTasksPagedResponse>	listTasksSettings() Returns the object with the settings used for calls to listTasks.
static BatchServiceStubSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static BatchServiceStubSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static BatchServiceStubSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
BatchServiceStubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

Methods inherited from class com.google.api.gax.rpc.StubSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BatchServiceStubSettings

protected BatchServiceStubSettings(BatchServiceStubSettings.Builder settingsBuilder)
                            throws IOException

Throws:

IOException

Method Detail

createJobSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateJobRequest,Job> createJobSettings()

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

getJobSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetJobRequest,Job> getJobSettings()

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

deleteJobSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteJobRequest,com.google.longrunning.Operation> deleteJobSettings()

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

deleteJobOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteJobRequest,com.google.protobuf.Empty,OperationMetadata> deleteJobOperationSettings()

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

listJobsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListJobsRequest,ListJobsResponse,BatchServiceClient.ListJobsPagedResponse> listJobsSettings()

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

getTaskSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetTaskRequest,Task> getTaskSettings()

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

listTasksSettings

public com.google.api.gax.rpc.PagedCallSettings<ListTasksRequest,ListTasksResponse,BatchServiceClient.ListTasksPagedResponse> listTasksSettings()

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

listLocationsSettings

public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,BatchServiceClient.ListLocationsPagedResponse> listLocationsSettings()

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

getLocationSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationSettings()

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

createStub

public BatchServiceStub createStub()
                            throws IOException

Throws:

IOException

getServiceName

public String getServiceName()

Returns the default service name.

Overrides:

getServiceName in class com.google.api.gax.rpc.StubSettings<BatchServiceStubSettings>

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultMtlsEndpoint

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultGrpcApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()

defaultHttpJsonApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static BatchServiceStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static BatchServiceStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static BatchServiceStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public BatchServiceStubSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.StubSettings<BatchServiceStubSettings>