Class JobsStubSettings (0.52.0) 

public class JobsStubSettings extends StubSettings<JobsStubSettings>

Settings class to configure an instance of JobsStub.

The default instance has everything set to sensible defaults:

  • The default service address (run.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 RetrySettings of getJob:


 // 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
 JobsStubSettings.Builder jobsSettingsBuilder = JobsStubSettings.newBuilder();
 jobsSettingsBuilder
     .getJobSettings()
     .setRetrySettings(
         jobsSettingsBuilder
             .getJobSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 JobsStubSettings jobsSettings = jobsSettingsBuilder.build();

Please refer to the Client Side Retry Guide for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createJob:


 // 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
 JobsStubSettings.Builder jobsSettingsBuilder = JobsStubSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 jobsSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > StubSettings > JobsStubSettings

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
Type Description
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns
Type Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static JobsStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
JobsStubSettings.Builder

newBuilder(ClientContext clientContext)

public static JobsStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
JobsStubSettings.Builder

newHttpJsonBuilder()

public static JobsStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
JobsStubSettings.Builder

Constructors

JobsStubSettings(JobsStubSettings.Builder settingsBuilder)

protected JobsStubSettings(JobsStubSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder JobsStubSettings.Builder

Methods

createJobOperationSettings()

public OperationCallSettings<CreateJobRequest,Job,Job> createJobOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateJobRequest,Job,Job>

createJobSettings()

public UnaryCallSettings<CreateJobRequest,Operation> createJobSettings()

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

Returns
Type Description
UnaryCallSettings<CreateJobRequest,Operation>

createStub()

public JobsStub createStub()
Returns
Type Description
JobsStub
Exceptions
Type Description
IOException

deleteJobOperationSettings()

public OperationCallSettings<DeleteJobRequest,Job,Job> deleteJobOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteJobRequest,Job,Job>

deleteJobSettings()

public UnaryCallSettings<DeleteJobRequest,Operation> deleteJobSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteJobRequest,Operation>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
Type Description
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getJobSettings()

public UnaryCallSettings<GetJobRequest,Job> getJobSettings()

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

Returns
Type Description
UnaryCallSettings<GetJobRequest,Job>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

listJobsSettings()

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

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

Returns
Type Description
PagedCallSettings<ListJobsRequest,ListJobsResponse,ListJobsPagedResponse>

runJobOperationSettings()

public OperationCallSettings<RunJobRequest,Execution,Execution> runJobOperationSettings()

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

Returns
Type Description
OperationCallSettings<RunJobRequest,Execution,Execution>

runJobSettings()

public UnaryCallSettings<RunJobRequest,Operation> runJobSettings()

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

Returns
Type Description
UnaryCallSettings<RunJobRequest,Operation>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
Type Description
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public JobsStubSettings.Builder toBuilder()

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

Returns
Type Description
JobsStubSettings.Builder
Overrides

updateJobOperationSettings()

public OperationCallSettings<UpdateJobRequest,Job,Job> updateJobOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateJobRequest,Job,Job>

updateJobSettings()

public UnaryCallSettings<UpdateJobRequest,Operation> updateJobSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateJobRequest,Operation>