com.google.cloud.scheduler.v1.CloudSchedulerSettings Maven / Gradle / Ivy
Show all versions of google-cloud-scheduler Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.scheduler.v1;
import static com.google.cloud.scheduler.v1.CloudSchedulerClient.ListJobsPagedResponse;
import static com.google.cloud.scheduler.v1.CloudSchedulerClient.ListLocationsPagedResponse;
import com.google.api.core.ApiFunction;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.GoogleCredentialsProvider;
import com.google.api.gax.core.InstantiatingExecutorProvider;
import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider;
import com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider;
import com.google.api.gax.rpc.ApiClientHeaderProvider;
import com.google.api.gax.rpc.ClientContext;
import com.google.api.gax.rpc.ClientSettings;
import com.google.api.gax.rpc.PagedCallSettings;
import com.google.api.gax.rpc.TransportChannelProvider;
import com.google.api.gax.rpc.UnaryCallSettings;
import com.google.cloud.location.GetLocationRequest;
import com.google.cloud.location.ListLocationsRequest;
import com.google.cloud.location.ListLocationsResponse;
import com.google.cloud.location.Location;
import com.google.cloud.scheduler.v1.stub.CloudSchedulerStubSettings;
import com.google.protobuf.Empty;
import java.io.IOException;
import java.util.List;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Settings class to configure an instance of {@link 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:
*
*
{@code
* // 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();
* }
*/
@Generated("by gapic-generator-java")
public class CloudSchedulerSettings extends ClientSettings {
/** Returns the object with the settings used for calls to listJobs. */
public PagedCallSettings
listJobsSettings() {
return ((CloudSchedulerStubSettings) getStubSettings()).listJobsSettings();
}
/** Returns the object with the settings used for calls to getJob. */
public UnaryCallSettings getJobSettings() {
return ((CloudSchedulerStubSettings) getStubSettings()).getJobSettings();
}
/** Returns the object with the settings used for calls to createJob. */
public UnaryCallSettings createJobSettings() {
return ((CloudSchedulerStubSettings) getStubSettings()).createJobSettings();
}
/** Returns the object with the settings used for calls to updateJob. */
public UnaryCallSettings updateJobSettings() {
return ((CloudSchedulerStubSettings) getStubSettings()).updateJobSettings();
}
/** Returns the object with the settings used for calls to deleteJob. */
public UnaryCallSettings deleteJobSettings() {
return ((CloudSchedulerStubSettings) getStubSettings()).deleteJobSettings();
}
/** Returns the object with the settings used for calls to pauseJob. */
public UnaryCallSettings pauseJobSettings() {
return ((CloudSchedulerStubSettings) getStubSettings()).pauseJobSettings();
}
/** Returns the object with the settings used for calls to resumeJob. */
public UnaryCallSettings resumeJobSettings() {
return ((CloudSchedulerStubSettings) getStubSettings()).resumeJobSettings();
}
/** Returns the object with the settings used for calls to runJob. */
public UnaryCallSettings runJobSettings() {
return ((CloudSchedulerStubSettings) getStubSettings()).runJobSettings();
}
/** Returns the object with the settings used for calls to listLocations. */
public PagedCallSettings
listLocationsSettings() {
return ((CloudSchedulerStubSettings) getStubSettings()).listLocationsSettings();
}
/** Returns the object with the settings used for calls to getLocation. */
public UnaryCallSettings getLocationSettings() {
return ((CloudSchedulerStubSettings) getStubSettings()).getLocationSettings();
}
public static final CloudSchedulerSettings create(CloudSchedulerStubSettings stub)
throws IOException {
return new CloudSchedulerSettings.Builder(stub.toBuilder()).build();
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return CloudSchedulerStubSettings.defaultExecutorProviderBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return CloudSchedulerStubSettings.getDefaultEndpoint();
}
/** Returns the default service scopes. */
public static List getDefaultServiceScopes() {
return CloudSchedulerStubSettings.getDefaultServiceScopes();
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return CloudSchedulerStubSettings.defaultCredentialsProviderBuilder();
}
/** Returns a builder for the default gRPC ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return CloudSchedulerStubSettings.defaultGrpcTransportProviderBuilder();
}
/** Returns a builder for the default REST ChannelProvider for this service. */
@BetaApi
public static InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder() {
return CloudSchedulerStubSettings.defaultHttpJsonTransportProviderBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return CloudSchedulerStubSettings.defaultTransportChannelProvider();
}
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return CloudSchedulerStubSettings.defaultApiClientHeaderProviderBuilder();
}
/** Returns a new gRPC builder for this class. */
public static Builder newBuilder() {
return Builder.createDefault();
}
/** Returns a new REST builder for this class. */
public static Builder newHttpJsonBuilder() {
return Builder.createHttpJsonDefault();
}
/** Returns a new builder for this class. */
public static Builder newBuilder(ClientContext clientContext) {
return new Builder(clientContext);
}
/** Returns a builder containing all the values of this settings class. */
public Builder toBuilder() {
return new Builder(this);
}
protected CloudSchedulerSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
}
/** Builder for CloudSchedulerSettings. */
public static class Builder extends ClientSettings.Builder {
protected Builder() throws IOException {
this(((ClientContext) null));
}
protected Builder(ClientContext clientContext) {
super(CloudSchedulerStubSettings.newBuilder(clientContext));
}
protected Builder(CloudSchedulerSettings settings) {
super(settings.getStubSettings().toBuilder());
}
protected Builder(CloudSchedulerStubSettings.Builder stubSettings) {
super(stubSettings);
}
private static Builder createDefault() {
return new Builder(CloudSchedulerStubSettings.newBuilder());
}
private static Builder createHttpJsonDefault() {
return new Builder(CloudSchedulerStubSettings.newHttpJsonBuilder());
}
public CloudSchedulerStubSettings.Builder getStubSettingsBuilder() {
return ((CloudSchedulerStubSettings.Builder) getStubSettings());
}
/**
* Applies the given settings updater function to all of the unary API methods in this service.
*
* Note: This method does not support applying settings to streaming methods.
*/
public Builder applyToAllUnaryMethods(
ApiFunction, Void> settingsUpdater) {
super.applyToAllUnaryMethods(
getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater);
return this;
}
/** Returns the builder for the settings used for calls to listJobs. */
public PagedCallSettings.Builder
listJobsSettings() {
return getStubSettingsBuilder().listJobsSettings();
}
/** Returns the builder for the settings used for calls to getJob. */
public UnaryCallSettings.Builder getJobSettings() {
return getStubSettingsBuilder().getJobSettings();
}
/** Returns the builder for the settings used for calls to createJob. */
public UnaryCallSettings.Builder createJobSettings() {
return getStubSettingsBuilder().createJobSettings();
}
/** Returns the builder for the settings used for calls to updateJob. */
public UnaryCallSettings.Builder updateJobSettings() {
return getStubSettingsBuilder().updateJobSettings();
}
/** Returns the builder for the settings used for calls to deleteJob. */
public UnaryCallSettings.Builder deleteJobSettings() {
return getStubSettingsBuilder().deleteJobSettings();
}
/** Returns the builder for the settings used for calls to pauseJob. */
public UnaryCallSettings.Builder pauseJobSettings() {
return getStubSettingsBuilder().pauseJobSettings();
}
/** Returns the builder for the settings used for calls to resumeJob. */
public UnaryCallSettings.Builder resumeJobSettings() {
return getStubSettingsBuilder().resumeJobSettings();
}
/** Returns the builder for the settings used for calls to runJob. */
public UnaryCallSettings.Builder runJobSettings() {
return getStubSettingsBuilder().runJobSettings();
}
/** Returns the builder for the settings used for calls to listLocations. */
public PagedCallSettings.Builder<
ListLocationsRequest, ListLocationsResponse, ListLocationsPagedResponse>
listLocationsSettings() {
return getStubSettingsBuilder().listLocationsSettings();
}
/** Returns the builder for the settings used for calls to getLocation. */
public UnaryCallSettings.Builder getLocationSettings() {
return getStubSettingsBuilder().getLocationSettings();
}
@Override
public CloudSchedulerSettings build() throws IOException {
return new CloudSchedulerSettings(this);
}
}
}