Class CloudSchedulerStubSettings (2.12.0)

publicclass CloudSchedulerStubSettingsextendsStubSettings<CloudSchedulerStubSettings>

Settings class to configure an instance of CloudSchedulerStub.

The default instance has everything set to sensible defaults:

  • The default service address (cloudscheduler.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 getJob 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
CloudSchedulerStubSettings.BuildercloudSchedulerSettingsBuilder=
CloudSchedulerStubSettings.newBuilder();
cloudSchedulerSettingsBuilder
.getJobSettings()
.setRetrySettings(
cloudSchedulerSettingsBuilder
.getJobSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
CloudSchedulerStubSettingscloudSchedulerSettings=cloudSchedulerSettingsBuilder.build();

Inheritance

java.lang.Object > StubSettings > CloudSchedulerStubSettings

Static Methods

defaultApiClientHeaderProviderBuilder()

publicstaticApiClientHeaderProvider.BuilderdefaultApiClientHeaderProviderBuilder()
Returns
Type Description

defaultCredentialsProviderBuilder()

publicstaticGoogleCredentialsProvider.BuilderdefaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description

defaultExecutorProviderBuilder()

publicstaticInstantiatingExecutorProvider.BuilderdefaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description

defaultGrpcApiClientHeaderProviderBuilder()

publicstaticApiClientHeaderProvider.BuilderdefaultGrpcApiClientHeaderProviderBuilder()
Returns
Type Description

defaultGrpcTransportProviderBuilder()

publicstaticInstantiatingGrpcChannelProvider.BuilderdefaultGrpcTransportProviderBuilder()

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

Returns
Type Description

defaultHttpJsonApiClientHeaderProviderBuilder()

publicstaticApiClientHeaderProvider.BuilderdefaultHttpJsonApiClientHeaderProviderBuilder()
Returns
Type Description

defaultHttpJsonTransportProviderBuilder()

publicstaticInstantiatingHttpJsonChannelProvider.BuilderdefaultHttpJsonTransportProviderBuilder()

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

Returns
Type Description

defaultTransportChannelProvider()

publicstaticTransportChannelProviderdefaultTransportChannelProvider()
Returns
Type Description

getDefaultEndpoint()

publicstaticStringgetDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description

getDefaultMtlsEndpoint()

publicstaticStringgetDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
Type Description

getDefaultServiceScopes()

publicstaticList<String>getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description

newBuilder()

publicstaticCloudSchedulerStubSettings.BuildernewBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description

newBuilder(ClientContext clientContext)

publicstaticCloudSchedulerStubSettings.BuildernewBuilder(ClientContextclientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description

newHttpJsonBuilder()

publicstaticCloudSchedulerStubSettings.BuildernewHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description

Constructors

CloudSchedulerStubSettings(CloudSchedulerStubSettings.Builder settingsBuilder)

protectedCloudSchedulerStubSettings(CloudSchedulerStubSettings.BuildersettingsBuilder)
Parameter
Name Description

Methods

createJobSettings()

publicUnaryCallSettings<CreateJobRequest,Job>createJobSettings()

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

Returns
Type Description

createStub()

publicCloudSchedulerStubcreateStub()
Returns
Type Description
Exceptions
Type Description

deleteJobSettings()

publicUnaryCallSettings<DeleteJobRequest,Empty>deleteJobSettings()

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

Returns
Type Description

getJobSettings()

publicUnaryCallSettings<GetJobRequest,Job>getJobSettings()

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

Returns
Type Description

listJobsSettings()

publicPagedCallSettings<ListJobsRequest,ListJobsResponse,CloudSchedulerClient.ListJobsPagedResponse>listJobsSettings()

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

Returns
Type Description

pauseJobSettings()

publicUnaryCallSettings<PauseJobRequest,Job>pauseJobSettings()

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

Returns
Type Description

resumeJobSettings()

publicUnaryCallSettings<ResumeJobRequest,Job>resumeJobSettings()

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

Returns
Type Description

runJobSettings()

publicUnaryCallSettings<RunJobRequest,Job>runJobSettings()

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

Returns
Type Description

toBuilder()

publicCloudSchedulerStubSettings.BuildertoBuilder()

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

Returns
Type Description
Overrides

updateJobSettings()

publicUnaryCallSettings<UpdateJobRequest,Job>updateJobSettings()

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

Returns
Type Description

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.