Package com.google.cloud.scheduler.v1beta1

Class CloudSchedulerSettings

  • @BetaApi
@Generated("by gapic-generator-java")
public class CloudSchedulerSettings
extends com.google.api.gax.rpc.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();

    • Method Detail

      • getJobSettings

        public com.google.api.gax.rpc.UnaryCallSettings<GetJobRequest,​Job> getJobSettings()
        Returns the object with the settings used for calls to getJob.

      • createJobSettings

        public com.google.api.gax.rpc.UnaryCallSettings<CreateJobRequest,​Job> createJobSettings()
        Returns the object with the settings used for calls to createJob.

      • updateJobSettings

        public com.google.api.gax.rpc.UnaryCallSettings<UpdateJobRequest,​Job> updateJobSettings()
        Returns the object with the settings used for calls to updateJob.

      • deleteJobSettings

        public com.google.api.gax.rpc.UnaryCallSettings<DeleteJobRequest,​com.google.protobuf.Empty> deleteJobSettings()
        Returns the object with the settings used for calls to deleteJob.

      • pauseJobSettings

        public com.google.api.gax.rpc.UnaryCallSettings<PauseJobRequest,​Job> pauseJobSettings()
        Returns the object with the settings used for calls to pauseJob.

      • resumeJobSettings

        public com.google.api.gax.rpc.UnaryCallSettings<ResumeJobRequest,​Job> resumeJobSettings()
        Returns the object with the settings used for calls to resumeJob.

      • runJobSettings

        public com.google.api.gax.rpc.UnaryCallSettings<RunJobRequest,​Job> runJobSettings()
        Returns the object with the settings used for calls to runJob.

      • listLocationsSettings

        public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,​com.google.cloud.location.ListLocationsResponse,​CloudSchedulerClient.ListLocationsPagedResponse> listLocationsSettings()
        Returns the object with the settings used for calls to listLocations.

      • getLocationSettings

        public com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,​com.google.cloud.location.Location> getLocationSettings()
        Returns the object with the settings used for calls to getLocation.

      • 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

        @BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

      • newBuilder

        public static CloudSchedulerSettings.Builder newBuilder​(com.google.api.gax.rpc.ClientContext clientContext)
        Returns a new builder for this class.