Package com.google.cloud.talent.v4
Class JobServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<JobServiceSettings>
com.google.cloud.talent.v4.JobServiceSettings
@Generated("by gapic-generator-java")
public class JobServiceSettings
extends ClientSettings<JobServiceSettings>
Settings class to configure an instance of
JobServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (jobs.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 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
JobServiceSettings.Builder jobServiceSettingsBuilder = JobServiceSettings.newBuilder();
jobServiceSettingsBuilder
.createJobSettings()
.setRetrySettings(
jobServiceSettingsBuilder
.createJobSettings()
.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());
JobServiceSettings jobServiceSettings = jobServiceSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) 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 batchCreateJobs:
// 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
JobServiceSettings.Builder jobServiceSettingsBuilder = JobServiceSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
jobServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for JobServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedJobServiceSettings(JobServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to batchCreateJobs.Returns the object with the settings used for calls to batchCreateJobs.Returns the object with the settings used for calls to batchDeleteJobs.Returns the object with the settings used for calls to batchDeleteJobs.Returns the object with the settings used for calls to batchUpdateJobs.Returns the object with the settings used for calls to batchUpdateJobs.static final JobServiceSettingscreate(JobServiceStubSettings stub) Returns the object with the settings used for calls to createJob.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderUnaryCallSettings<DeleteJobRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteJob.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getJob.Returns the object with the settings used for calls to listJobs.static JobServiceSettings.BuilderReturns a new gRPC builder for this class.static JobServiceSettings.BuildernewBuilder(ClientContext clientContext) Returns a new builder for this class.static JobServiceSettings.BuilderReturns a new REST builder for this class.Returns the object with the settings used for calls to searchJobsForAlert.Returns the object with the settings used for calls to searchJobs.Returns a builder containing all the values of this settings class.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
-
Constructor Details
-
JobServiceSettings
- Throws:
IOException
-
-
Method Details
-
createJobSettings
Returns the object with the settings used for calls to createJob. -
batchCreateJobsSettings
Returns the object with the settings used for calls to batchCreateJobs. -
batchCreateJobsOperationSettings
public OperationCallSettings<BatchCreateJobsRequest,BatchCreateJobsResponse, batchCreateJobsOperationSettings()BatchOperationMetadata> Returns the object with the settings used for calls to batchCreateJobs. -
getJobSettings
Returns the object with the settings used for calls to getJob. -
updateJobSettings
Returns the object with the settings used for calls to updateJob. -
batchUpdateJobsSettings
Returns the object with the settings used for calls to batchUpdateJobs. -
batchUpdateJobsOperationSettings
public OperationCallSettings<BatchUpdateJobsRequest,BatchUpdateJobsResponse, batchUpdateJobsOperationSettings()BatchOperationMetadata> Returns the object with the settings used for calls to batchUpdateJobs. -
deleteJobSettings
Returns the object with the settings used for calls to deleteJob. -
batchDeleteJobsSettings
Returns the object with the settings used for calls to batchDeleteJobs. -
batchDeleteJobsOperationSettings
public OperationCallSettings<BatchDeleteJobsRequest,BatchDeleteJobsResponse, batchDeleteJobsOperationSettings()BatchOperationMetadata> Returns the object with the settings used for calls to batchDeleteJobs. -
listJobsSettings
public PagedCallSettings<ListJobsRequest,ListJobsResponse, listJobsSettings()JobServiceClient.ListJobsPagedResponse> Returns the object with the settings used for calls to listJobs. -
searchJobsSettings
Returns the object with the settings used for calls to searchJobs. -
searchJobsForAlertSettings
Returns the object with the settings used for calls to searchJobsForAlert. -
create
- Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
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
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classClientSettings<JobServiceSettings>
-