com.google.cloud.dataproc.v1.stub

Class JobControllerStubSettings

java.lang.Object

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

com.google.cloud.dataproc.v1.stub.JobControllerStubSettings

@Generated(value="by gapic-generator-java")
public class JobControllerStubSettings
extends com.google.api.gax.rpc.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:

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.UnaryCallSettings<CancelJobRequest,Job>	cancelJobSettings() Returns the object with the settings used for calls to cancelJob.
JobControllerStub	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.UnaryCallSettings<DeleteJobRequest,com.google.protobuf.Empty>	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.
String	getEndpoint() Returns the endpoint set by the user or the the service's default endpoint.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<GetJobRequest,Job>	getJobSettings() Returns the object with the settings used for calls to getJob.
String	getServiceName() Returns the default service name.
com.google.api.gax.rpc.PagedCallSettings<ListJobsRequest,ListJobsResponse,JobControllerClient.ListJobsPagedResponse>	listJobsSettings() Returns the object with the settings used for calls to listJobs.
static JobControllerStubSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static JobControllerStubSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static JobControllerStubSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicySettings() Returns the object with the settings used for calls to setIamPolicy.
com.google.api.gax.rpc.OperationCallSettings<SubmitJobRequest,Job,JobMetadata>	submitJobAsOperationOperationSettings() Returns the object with the settings used for calls to submitJobAsOperation.
com.google.api.gax.rpc.UnaryCallSettings<SubmitJobRequest,com.google.longrunning.Operation>	submitJobAsOperationSettings() Returns the object with the settings used for calls to submitJobAs.
com.google.api.gax.rpc.UnaryCallSettings<SubmitJobRequest,Job>	submitJobSettings() Returns the object with the settings used for calls to submitJob.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsSettings() Returns the object with the settings used for calls to testIamPermissions.
JobControllerStubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.UnaryCallSettings<UpdateJobRequest,Job>	updateJobSettings() Returns the object with the settings used for calls to updateJob.

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

getBackgroundExecutorProvider, getClock, getCredentialsProvider, 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

JobControllerStubSettings

protected JobControllerStubSettings(JobControllerStubSettings.Builder settingsBuilder)
                             throws IOException

Throws:

IOException

Method Detail

submitJobSettings

public com.google.api.gax.rpc.UnaryCallSettings<SubmitJobRequest,Job> submitJobSettings()

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

submitJobAsOperationSettings

public com.google.api.gax.rpc.UnaryCallSettings<SubmitJobRequest,com.google.longrunning.Operation> submitJobAsOperationSettings()

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

submitJobAsOperationOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<SubmitJobRequest,Job,JobMetadata> submitJobAsOperationOperationSettings()

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

getJobSettings

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

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

listJobsSettings

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

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

updateJobSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateJobRequest,Job> updateJobSettings()

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

cancelJobSettings

public com.google.api.gax.rpc.UnaryCallSettings<CancelJobRequest,Job> cancelJobSettings()

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

deleteJobSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteJobRequest,com.google.protobuf.Empty> deleteJobSettings()

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

setIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()

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

getIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()

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

testIamPermissionsSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()

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

createStub

public JobControllerStub createStub()
                             throws IOException

Throws:

IOException

getEndpoint

public String getEndpoint()

Returns the endpoint set by the user or the the service's default endpoint.

Overrides:

getEndpoint in class com.google.api.gax.rpc.StubSettings<JobControllerStubSettings>

getServiceName

public String getServiceName()

Returns the default service name.

Overrides:

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

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

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

defaultHttpJsonApiClientHeaderProviderBuilder

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

defaultApiClientHeaderProviderBuilder

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

newBuilder

public static JobControllerStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static JobControllerStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public JobControllerStubSettings.Builder toBuilder()

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

Specified by:

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