com.google.cloud.run.v2

Class JobsSettings

java.lang.Object

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

com.google.cloud.run.v2.JobsSettings

@Generated(value="by gapic-generator-java")
public class JobsSettings
extends com.google.api.gax.rpc.ClientSettings<JobsSettings>

Settings class to configure an instance of JobsClient.

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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.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
 JobsSettings.Builder jobsSettingsBuilder = JobsSettings.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());
 JobsSettings jobsSettings = jobsSettingsBuilder.build();
 

Please refer to the [Client Side Retry Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) 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
 JobsSettings.Builder jobsSettingsBuilder = JobsSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 jobsSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static JobsSettings	create(JobsStubSettings stub)
com.google.api.gax.rpc.OperationCallSettings<CreateJobRequest,Job,Job>	createJobOperationSettings() Returns the object with the settings used for calls to createJob.
com.google.api.gax.rpc.UnaryCallSettings<CreateJobRequest,com.google.longrunning.Operation>	createJobSettings() Returns the object with the settings used for calls to createJob.
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.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
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.OperationCallSettings<DeleteJobRequest,Job,Job>	deleteJobOperationSettings() Returns the object with the settings used for calls to deleteJob.
com.google.api.gax.rpc.UnaryCallSettings<DeleteJobRequest,com.google.longrunning.Operation>	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.
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.
com.google.api.gax.rpc.PagedCallSettings<ListJobsRequest,ListJobsResponse,JobsClient.ListJobsPagedResponse>	listJobsSettings() Returns the object with the settings used for calls to listJobs.
static JobsSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static JobsSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static JobsSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.OperationCallSettings<RunJobRequest,Execution,Execution>	runJobOperationSettings() Returns the object with the settings used for calls to runJob.
com.google.api.gax.rpc.UnaryCallSettings<RunJobRequest,com.google.longrunning.Operation>	runJobSettings() Returns the object with the settings used for calls to runJob.
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.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsSettings() Returns the object with the settings used for calls to testIamPermissions.
JobsSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UpdateJobRequest,Job,Job>	updateJobOperationSettings() Returns the object with the settings used for calls to updateJob.
com.google.api.gax.rpc.UnaryCallSettings<UpdateJobRequest,com.google.longrunning.Operation>	updateJobSettings() Returns the object with the settings used for calls to updateJob.

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

getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

JobsSettings

protected JobsSettings(JobsSettings.Builder settingsBuilder)
                throws IOException

Throws:

IOException

Method Detail

createJobSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateJobRequest,com.google.longrunning.Operation> createJobSettings()

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

createJobOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateJobRequest,Job,Job> createJobOperationSettings()

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

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,JobsClient.ListJobsPagedResponse> listJobsSettings()

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

updateJobSettings

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

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

updateJobOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateJobRequest,Job,Job> updateJobOperationSettings()

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

deleteJobSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteJobRequest,com.google.longrunning.Operation> deleteJobSettings()

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

deleteJobOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<DeleteJobRequest,Job,Job> deleteJobOperationSettings()

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

runJobSettings

public com.google.api.gax.rpc.UnaryCallSettings<RunJobRequest,com.google.longrunning.Operation> runJobSettings()

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

runJobOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<RunJobRequest,Execution,Execution> runJobOperationSettings()

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

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.

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.

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.

create

public static final JobsSettings create(JobsStubSettings stub)
                                 throws IOException

Throws:

IOException

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.

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()

defaultApiClientHeaderProviderBuilder

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

newBuilder

public static JobsSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static JobsSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public JobsSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<JobsSettings>