Class JobControllerSettings (2.3.1) 

public class JobControllerSettings extends ClientSettings<JobControllerSettings>

Settings class to configure an instance of JobControllerClient.

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:


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

Inheritance

java.lang.Object > ClientSettings > JobControllerSettings

Constructors

JobControllerSettings(JobControllerSettings.Builder settingsBuilder)

protected JobControllerSettings(JobControllerSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderJobControllerSettings.Builder

Methods

cancelJobSettings()

public UnaryCallSettings<CancelJobRequest,Job> cancelJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<CancelJobRequest,Job>

create(JobControllerStubSettings stub)

public static final JobControllerSettings create(JobControllerStubSettings stub)
Parameter
NameDescription
stubJobControllerStubSettings
Returns
TypeDescription
JobControllerSettings
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

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 JobControllerSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
JobControllerSettings.Builder

newBuilder(ClientContext clientContext)

public static JobControllerSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
JobControllerSettings.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 JobControllerSettings.Builder toBuilder()

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

Returns
TypeDescription
JobControllerSettings.Builder
Overrides

updateJobSettings()

public UnaryCallSettings<UpdateJobRequest,Job> updateJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateJobRequest,Job>