com.google.cloud.dataproc.v1

Class JobControllerSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<JobControllerSettings>

com.google.cloud.dataproc.v1.JobControllerSettings

@Generated(value="by gapic-generator-java")
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:

 // 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
 JobControllerSettings.Builder jobControllerSettingsBuilder = JobControllerSettings.newBuilder();
 jobControllerSettingsBuilder
     .submitJobSettings()
     .setRetrySettings(
         jobControllerSettingsBuilder.submitJobSettings().getRetrySettings().toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 JobControllerSettings jobControllerSettings = jobControllerSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
UnaryCallSettings<CancelJobRequest,Job>	cancelJobSettings() Returns the object with the settings used for calls to cancelJob.
static JobControllerSettings	create(JobControllerStubSettings stub)
static ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
UnaryCallSettings<DeleteJobRequest,Empty>	deleteJobSettings() Returns the object with the settings used for calls to deleteJob.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
UnaryCallSettings<GetJobRequest,Job>	getJobSettings() Returns the object with the settings used for calls to getJob.
PagedCallSettings<ListJobsRequest,ListJobsResponse,JobControllerClient.ListJobsPagedResponse>	listJobsSettings() Returns the object with the settings used for calls to listJobs.
static JobControllerSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static JobControllerSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
static JobControllerSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
OperationCallSettings<SubmitJobRequest,Job,JobMetadata>	submitJobAsOperationOperationSettings() Returns the object with the settings used for calls to submitJobAsOperation.
UnaryCallSettings<SubmitJobRequest,Operation>	submitJobAsOperationSettings() Returns the object with the settings used for calls to submitJobAs.
UnaryCallSettings<SubmitJobRequest,Job>	submitJobSettings() Returns the object with the settings used for calls to submitJob.
JobControllerSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
UnaryCallSettings<UpdateJobRequest,Job>	updateJobSettings() Returns the object with the settings used for calls to updateJob.

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

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

JobControllerSettings

protected JobControllerSettings(JobControllerSettings.Builder settingsBuilder)
                         throws IOException

Throws:

IOException

Method Detail

submitJobSettings

public UnaryCallSettings<SubmitJobRequest,Job> submitJobSettings()

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

submitJobAsOperationSettings

public UnaryCallSettings<SubmitJobRequest,Operation> submitJobAsOperationSettings()

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

submitJobAsOperationOperationSettings

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

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

getJobSettings

public UnaryCallSettings<GetJobRequest,Job> getJobSettings()

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

listJobsSettings

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

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

updateJobSettings

public UnaryCallSettings<UpdateJobRequest,Job> updateJobSettings()

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

cancelJobSettings

public UnaryCallSettings<CancelJobRequest,Job> cancelJobSettings()

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

deleteJobSettings

public UnaryCallSettings<DeleteJobRequest,Empty> deleteJobSettings()

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

create

public static final JobControllerSettings create(JobControllerStubSettings stub)
                                          throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

defaultTransportChannelProvider

public static TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static JobControllerSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

@BetaApi
public static JobControllerSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static JobControllerSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public JobControllerSettings.Builder toBuilder()

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

Specified by:

toBuilder in class ClientSettings<JobControllerSettings>