Class JobControllerStubSettings (2.3.1) 

public class JobControllerStubSettings extends StubSettings<JobControllerStubSettings>

Settings class to configure an instance of JobControllerStub.

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


 JobControllerStubSettings.Builder jobControllerSettingsBuilder =
     JobControllerStubSettings.newBuilder();
 jobControllerSettingsBuilder
     .submitJobSettings()
     .setRetrySettings(
         jobControllerSettingsBuilder
             .submitJobSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 JobControllerStubSettings jobControllerSettings = jobControllerSettingsBuilder.build();

Inheritance

java.lang.Object > StubSettings > JobControllerStubSettings

Constructors

JobControllerStubSettings(JobControllerStubSettings.Builder settingsBuilder)

protected JobControllerStubSettings(JobControllerStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderJobControllerStubSettings.Builder

Methods

cancelJobSettings()

public UnaryCallSettings<CancelJobRequest,Job> cancelJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<CancelJobRequest,Job>

createStub()

public JobControllerStub createStub()
Returns
TypeDescription
JobControllerStub
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 ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

deleteJobSettings()

public UnaryCallSettings<DeleteJobRequest,Empty> deleteJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteJobRequest,Empty>

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

getJobSettings()

public UnaryCallSettings<GetJobRequest,Job> getJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetJobRequest,Job>

listJobsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListJobsRequest,ListJobsResponse,ListJobsPagedResponse>

newBuilder()

public static JobControllerStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
JobControllerStubSettings.Builder

newBuilder(ClientContext clientContext)

public static JobControllerStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
JobControllerStubSettings.Builder

submitJobAsOperationOperationSettings()

public OperationCallSettings<SubmitJobRequest,Job,JobMetadata> submitJobAsOperationOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<SubmitJobRequest,Job,JobMetadata>

submitJobAsOperationSettings()

public UnaryCallSettings<SubmitJobRequest,Operation> submitJobAsOperationSettings()

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

Returns
TypeDescription
UnaryCallSettings<SubmitJobRequest,Operation>

submitJobSettings()

public UnaryCallSettings<SubmitJobRequest,Job> submitJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<SubmitJobRequest,Job>

toBuilder()

public JobControllerStubSettings.Builder toBuilder()

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

Returns
TypeDescription
JobControllerStubSettings.Builder
Overrides

updateJobSettings()

public UnaryCallSettings<UpdateJobRequest,Job> updateJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateJobRequest,Job>