Class CloudSchedulerStubSettings (2.3.3)

public class CloudSchedulerStubSettings extends StubSettings<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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 CloudSchedulerStubSettings.Builder cloudSchedulerSettingsBuilder =
     CloudSchedulerStubSettings.newBuilder();
 cloudSchedulerSettingsBuilder
     .getJobSettings()
     .setRetrySettings(
         cloudSchedulerSettingsBuilder
             .getJobSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CloudSchedulerStubSettings cloudSchedulerSettings = cloudSchedulerSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > CloudSchedulerStubSettings

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static CloudSchedulerStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
CloudSchedulerStubSettings.Builder

newBuilder(ClientContext clientContext)

public static CloudSchedulerStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
CloudSchedulerStubSettings.Builder

newHttpJsonBuilder()

public static CloudSchedulerStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
CloudSchedulerStubSettings.Builder

Constructors

CloudSchedulerStubSettings(CloudSchedulerStubSettings.Builder settingsBuilder)

protected CloudSchedulerStubSettings(CloudSchedulerStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderCloudSchedulerStubSettings.Builder

Methods

createJobSettings()

public UnaryCallSettings<CreateJobRequest,Job> createJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateJobRequest,Job>

createStub()

public CloudSchedulerStub createStub()
Returns
TypeDescription
CloudSchedulerStub
Exceptions
TypeDescription
IOException

deleteJobSettings()

public UnaryCallSettings<DeleteJobRequest,Empty> deleteJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteJobRequest,Empty>

getJobSettings()

public UnaryCallSettings<GetJobRequest,Job> getJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetJobRequest,Job>

listJobsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListJobsRequest,ListJobsResponse,ListJobsPagedResponse>

pauseJobSettings()

public UnaryCallSettings<PauseJobRequest,Job> pauseJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<PauseJobRequest,Job>

resumeJobSettings()

public UnaryCallSettings<ResumeJobRequest,Job> resumeJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<ResumeJobRequest,Job>

runJobSettings()

public UnaryCallSettings<RunJobRequest,Job> runJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<RunJobRequest,Job>

toBuilder()

public CloudSchedulerStubSettings.Builder toBuilder()

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

Returns
TypeDescription
CloudSchedulerStubSettings.Builder
Overrides

updateJobSettings()

public UnaryCallSettings<UpdateJobRequest,Job> updateJobSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateJobRequest,Job>