com.google.cloud.scheduler.v1

Class CloudSchedulerSettings

java.lang.Object

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

com.google.cloud.scheduler.v1.CloudSchedulerSettings

@Generated(value="by gapic-generator-java")
public class CloudSchedulerSettings
extends ClientSettings<CloudSchedulerSettings>

Settings class to configure an instance of CloudSchedulerClient.

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
 CloudSchedulerSettings.Builder cloudSchedulerSettingsBuilder =
     CloudSchedulerSettings.newBuilder();
 cloudSchedulerSettingsBuilder
     .getJobSettings()
     .setRetrySettings(
         cloudSchedulerSettingsBuilder.getJobSettings().getRetrySettings().toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CloudSchedulerSettings cloudSchedulerSettings = cloudSchedulerSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static CloudSchedulerSettings	create(CloudSchedulerStubSettings stub)
UnaryCallSettings<CreateJobRequest,Job>	createJobSettings() Returns the object with the settings used for calls to createJob.
static ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default gRPC ChannelProvider for this service.
static InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
UnaryCallSettings<DeleteJobRequest,Empty>	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.
UnaryCallSettings<GetJobRequest,Job>	getJobSettings() Returns the object with the settings used for calls to getJob.
PagedCallSettings<ListJobsRequest,ListJobsResponse,CloudSchedulerClient.ListJobsPagedResponse>	listJobsSettings() Returns the object with the settings used for calls to listJobs.
static CloudSchedulerSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static CloudSchedulerSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
static CloudSchedulerSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
UnaryCallSettings<PauseJobRequest,Job>	pauseJobSettings() Returns the object with the settings used for calls to pauseJob.
UnaryCallSettings<ResumeJobRequest,Job>	resumeJobSettings() Returns the object with the settings used for calls to resumeJob.
UnaryCallSettings<RunJobRequest,Job>	runJobSettings() Returns the object with the settings used for calls to runJob.
CloudSchedulerSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
UnaryCallSettings<UpdateJobRequest,Job>	updateJobSettings() Returns the object with the settings used for calls to updateJob.

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

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CloudSchedulerSettings

protected CloudSchedulerSettings(CloudSchedulerSettings.Builder settingsBuilder)
                          throws IOException

Throws:

IOException

Method Detail

listJobsSettings

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

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

getJobSettings

public UnaryCallSettings<GetJobRequest,Job> getJobSettings()

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

createJobSettings

public UnaryCallSettings<CreateJobRequest,Job> createJobSettings()

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

updateJobSettings

public UnaryCallSettings<UpdateJobRequest,Job> updateJobSettings()

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

deleteJobSettings

public UnaryCallSettings<DeleteJobRequest,Empty> deleteJobSettings()

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

pauseJobSettings

public UnaryCallSettings<PauseJobRequest,Job> pauseJobSettings()

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

resumeJobSettings

public UnaryCallSettings<ResumeJobRequest,Job> resumeJobSettings()

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

runJobSettings

public UnaryCallSettings<RunJobRequest,Job> runJobSettings()

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

create

public static final CloudSchedulerSettings create(CloudSchedulerStubSettings stub)
                                           throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static 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 GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static InstantiatingGrpcChannelProvider.Builder 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

public static TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static CloudSchedulerSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

@BetaApi
public static CloudSchedulerSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static CloudSchedulerSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public CloudSchedulerSettings.Builder toBuilder()

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

Specified by:

toBuilder in class ClientSettings<CloudSchedulerSettings>