com.google.cloud.bigquery.reservation.v1.ReservationServiceSettings Maven / Gradle / Ivy
Show all versions of google-cloud-bigqueryreservation 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.bigquery.reservation.v1;
import static com.google.cloud.bigquery.reservation.v1.ReservationServiceClient.ListAssignmentsPagedResponse;
import static com.google.cloud.bigquery.reservation.v1.ReservationServiceClient.ListCapacityCommitmentsPagedResponse;
import static com.google.cloud.bigquery.reservation.v1.ReservationServiceClient.ListReservationsPagedResponse;
import static com.google.cloud.bigquery.reservation.v1.ReservationServiceClient.SearchAllAssignmentsPagedResponse;
import static com.google.cloud.bigquery.reservation.v1.ReservationServiceClient.SearchAssignmentsPagedResponse;
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.bigquery.reservation.v1.stub.ReservationServiceStubSettings;
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 ReservationServiceClient}.
*
* The default instance has everything set to sensible defaults:
*
*
* - The default service address (bigqueryreservation.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
* [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings)
* of createReservation:
*
*
{@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
* ReservationServiceSettings.Builder reservationServiceSettingsBuilder =
* ReservationServiceSettings.newBuilder();
* reservationServiceSettingsBuilder
* .createReservationSettings()
* .setRetrySettings(
* reservationServiceSettingsBuilder
* .createReservationSettings()
* .getRetrySettings()
* .toBuilder()
* .setInitialRetryDelayDuration(Duration.ofSeconds(1))
* .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
* .setMaxAttempts(5)
* .setMaxRetryDelayDuration(Duration.ofSeconds(30))
* .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
* .setRetryDelayMultiplier(1.3)
* .setRpcTimeoutMultiplier(1.5)
* .setTotalTimeoutDuration(Duration.ofSeconds(300))
* .build());
* ReservationServiceSettings reservationServiceSettings =
* reservationServiceSettingsBuilder.build();
* }
*
* Please refer to the [Client Side Retry
* Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) for
* additional support in setting retries.
*/
@Generated("by gapic-generator-java")
public class ReservationServiceSettings extends ClientSettings {
/** Returns the object with the settings used for calls to createReservation. */
public UnaryCallSettings createReservationSettings() {
return ((ReservationServiceStubSettings) getStubSettings()).createReservationSettings();
}
/** Returns the object with the settings used for calls to listReservations. */
public PagedCallSettings<
ListReservationsRequest, ListReservationsResponse, ListReservationsPagedResponse>
listReservationsSettings() {
return ((ReservationServiceStubSettings) getStubSettings()).listReservationsSettings();
}
/** Returns the object with the settings used for calls to getReservation. */
public UnaryCallSettings getReservationSettings() {
return ((ReservationServiceStubSettings) getStubSettings()).getReservationSettings();
}
/** Returns the object with the settings used for calls to deleteReservation. */
public UnaryCallSettings deleteReservationSettings() {
return ((ReservationServiceStubSettings) getStubSettings()).deleteReservationSettings();
}
/** Returns the object with the settings used for calls to updateReservation. */
public UnaryCallSettings updateReservationSettings() {
return ((ReservationServiceStubSettings) getStubSettings()).updateReservationSettings();
}
/** Returns the object with the settings used for calls to createCapacityCommitment. */
public UnaryCallSettings
createCapacityCommitmentSettings() {
return ((ReservationServiceStubSettings) getStubSettings()).createCapacityCommitmentSettings();
}
/** Returns the object with the settings used for calls to listCapacityCommitments. */
public PagedCallSettings<
ListCapacityCommitmentsRequest,
ListCapacityCommitmentsResponse,
ListCapacityCommitmentsPagedResponse>
listCapacityCommitmentsSettings() {
return ((ReservationServiceStubSettings) getStubSettings()).listCapacityCommitmentsSettings();
}
/** Returns the object with the settings used for calls to getCapacityCommitment. */
public UnaryCallSettings
getCapacityCommitmentSettings() {
return ((ReservationServiceStubSettings) getStubSettings()).getCapacityCommitmentSettings();
}
/** Returns the object with the settings used for calls to deleteCapacityCommitment. */
public UnaryCallSettings
deleteCapacityCommitmentSettings() {
return ((ReservationServiceStubSettings) getStubSettings()).deleteCapacityCommitmentSettings();
}
/** Returns the object with the settings used for calls to updateCapacityCommitment. */
public UnaryCallSettings
updateCapacityCommitmentSettings() {
return ((ReservationServiceStubSettings) getStubSettings()).updateCapacityCommitmentSettings();
}
/** Returns the object with the settings used for calls to splitCapacityCommitment. */
public UnaryCallSettings
splitCapacityCommitmentSettings() {
return ((ReservationServiceStubSettings) getStubSettings()).splitCapacityCommitmentSettings();
}
/** Returns the object with the settings used for calls to mergeCapacityCommitments. */
public UnaryCallSettings
mergeCapacityCommitmentsSettings() {
return ((ReservationServiceStubSettings) getStubSettings()).mergeCapacityCommitmentsSettings();
}
/** Returns the object with the settings used for calls to createAssignment. */
public UnaryCallSettings createAssignmentSettings() {
return ((ReservationServiceStubSettings) getStubSettings()).createAssignmentSettings();
}
/** Returns the object with the settings used for calls to listAssignments. */
public PagedCallSettings<
ListAssignmentsRequest, ListAssignmentsResponse, ListAssignmentsPagedResponse>
listAssignmentsSettings() {
return ((ReservationServiceStubSettings) getStubSettings()).listAssignmentsSettings();
}
/** Returns the object with the settings used for calls to deleteAssignment. */
public UnaryCallSettings deleteAssignmentSettings() {
return ((ReservationServiceStubSettings) getStubSettings()).deleteAssignmentSettings();
}
/**
* Returns the object with the settings used for calls to searchAssignments.
*
* @deprecated This method is deprecated and will be removed in the next major version update.
*/
@Deprecated
public PagedCallSettings<
SearchAssignmentsRequest, SearchAssignmentsResponse, SearchAssignmentsPagedResponse>
searchAssignmentsSettings() {
return ((ReservationServiceStubSettings) getStubSettings()).searchAssignmentsSettings();
}
/** Returns the object with the settings used for calls to searchAllAssignments. */
public PagedCallSettings<
SearchAllAssignmentsRequest,
SearchAllAssignmentsResponse,
SearchAllAssignmentsPagedResponse>
searchAllAssignmentsSettings() {
return ((ReservationServiceStubSettings) getStubSettings()).searchAllAssignmentsSettings();
}
/** Returns the object with the settings used for calls to moveAssignment. */
public UnaryCallSettings moveAssignmentSettings() {
return ((ReservationServiceStubSettings) getStubSettings()).moveAssignmentSettings();
}
/** Returns the object with the settings used for calls to updateAssignment. */
public UnaryCallSettings updateAssignmentSettings() {
return ((ReservationServiceStubSettings) getStubSettings()).updateAssignmentSettings();
}
/** Returns the object with the settings used for calls to getBiReservation. */
public UnaryCallSettings getBiReservationSettings() {
return ((ReservationServiceStubSettings) getStubSettings()).getBiReservationSettings();
}
/** Returns the object with the settings used for calls to updateBiReservation. */
public UnaryCallSettings
updateBiReservationSettings() {
return ((ReservationServiceStubSettings) getStubSettings()).updateBiReservationSettings();
}
public static final ReservationServiceSettings create(ReservationServiceStubSettings stub)
throws IOException {
return new ReservationServiceSettings.Builder(stub.toBuilder()).build();
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return ReservationServiceStubSettings.defaultExecutorProviderBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return ReservationServiceStubSettings.getDefaultEndpoint();
}
/** Returns the default service scopes. */
public static List getDefaultServiceScopes() {
return ReservationServiceStubSettings.getDefaultServiceScopes();
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return ReservationServiceStubSettings.defaultCredentialsProviderBuilder();
}
/** Returns a builder for the default gRPC ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return ReservationServiceStubSettings.defaultGrpcTransportProviderBuilder();
}
/** Returns a builder for the default REST ChannelProvider for this service. */
@BetaApi
public static InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder() {
return ReservationServiceStubSettings.defaultHttpJsonTransportProviderBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return ReservationServiceStubSettings.defaultTransportChannelProvider();
}
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return ReservationServiceStubSettings.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 ReservationServiceSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
}
/** Builder for ReservationServiceSettings. */
public static class Builder extends ClientSettings.Builder {
protected Builder() throws IOException {
this(((ClientContext) null));
}
protected Builder(ClientContext clientContext) {
super(ReservationServiceStubSettings.newBuilder(clientContext));
}
protected Builder(ReservationServiceSettings settings) {
super(settings.getStubSettings().toBuilder());
}
protected Builder(ReservationServiceStubSettings.Builder stubSettings) {
super(stubSettings);
}
private static Builder createDefault() {
return new Builder(ReservationServiceStubSettings.newBuilder());
}
private static Builder createHttpJsonDefault() {
return new Builder(ReservationServiceStubSettings.newHttpJsonBuilder());
}
public ReservationServiceStubSettings.Builder getStubSettingsBuilder() {
return ((ReservationServiceStubSettings.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 createReservation. */
public UnaryCallSettings.Builder
createReservationSettings() {
return getStubSettingsBuilder().createReservationSettings();
}
/** Returns the builder for the settings used for calls to listReservations. */
public PagedCallSettings.Builder<
ListReservationsRequest, ListReservationsResponse, ListReservationsPagedResponse>
listReservationsSettings() {
return getStubSettingsBuilder().listReservationsSettings();
}
/** Returns the builder for the settings used for calls to getReservation. */
public UnaryCallSettings.Builder getReservationSettings() {
return getStubSettingsBuilder().getReservationSettings();
}
/** Returns the builder for the settings used for calls to deleteReservation. */
public UnaryCallSettings.Builder deleteReservationSettings() {
return getStubSettingsBuilder().deleteReservationSettings();
}
/** Returns the builder for the settings used for calls to updateReservation. */
public UnaryCallSettings.Builder
updateReservationSettings() {
return getStubSettingsBuilder().updateReservationSettings();
}
/** Returns the builder for the settings used for calls to createCapacityCommitment. */
public UnaryCallSettings.Builder
createCapacityCommitmentSettings() {
return getStubSettingsBuilder().createCapacityCommitmentSettings();
}
/** Returns the builder for the settings used for calls to listCapacityCommitments. */
public PagedCallSettings.Builder<
ListCapacityCommitmentsRequest,
ListCapacityCommitmentsResponse,
ListCapacityCommitmentsPagedResponse>
listCapacityCommitmentsSettings() {
return getStubSettingsBuilder().listCapacityCommitmentsSettings();
}
/** Returns the builder for the settings used for calls to getCapacityCommitment. */
public UnaryCallSettings.Builder
getCapacityCommitmentSettings() {
return getStubSettingsBuilder().getCapacityCommitmentSettings();
}
/** Returns the builder for the settings used for calls to deleteCapacityCommitment. */
public UnaryCallSettings.Builder
deleteCapacityCommitmentSettings() {
return getStubSettingsBuilder().deleteCapacityCommitmentSettings();
}
/** Returns the builder for the settings used for calls to updateCapacityCommitment. */
public UnaryCallSettings.Builder
updateCapacityCommitmentSettings() {
return getStubSettingsBuilder().updateCapacityCommitmentSettings();
}
/** Returns the builder for the settings used for calls to splitCapacityCommitment. */
public UnaryCallSettings.Builder<
SplitCapacityCommitmentRequest, SplitCapacityCommitmentResponse>
splitCapacityCommitmentSettings() {
return getStubSettingsBuilder().splitCapacityCommitmentSettings();
}
/** Returns the builder for the settings used for calls to mergeCapacityCommitments. */
public UnaryCallSettings.Builder
mergeCapacityCommitmentsSettings() {
return getStubSettingsBuilder().mergeCapacityCommitmentsSettings();
}
/** Returns the builder for the settings used for calls to createAssignment. */
public UnaryCallSettings.Builder
createAssignmentSettings() {
return getStubSettingsBuilder().createAssignmentSettings();
}
/** Returns the builder for the settings used for calls to listAssignments. */
public PagedCallSettings.Builder<
ListAssignmentsRequest, ListAssignmentsResponse, ListAssignmentsPagedResponse>
listAssignmentsSettings() {
return getStubSettingsBuilder().listAssignmentsSettings();
}
/** Returns the builder for the settings used for calls to deleteAssignment. */
public UnaryCallSettings.Builder deleteAssignmentSettings() {
return getStubSettingsBuilder().deleteAssignmentSettings();
}
/**
* Returns the builder for the settings used for calls to searchAssignments.
*
* @deprecated This method is deprecated and will be removed in the next major version update.
*/
@Deprecated
public PagedCallSettings.Builder<
SearchAssignmentsRequest, SearchAssignmentsResponse, SearchAssignmentsPagedResponse>
searchAssignmentsSettings() {
return getStubSettingsBuilder().searchAssignmentsSettings();
}
/** Returns the builder for the settings used for calls to searchAllAssignments. */
public PagedCallSettings.Builder<
SearchAllAssignmentsRequest,
SearchAllAssignmentsResponse,
SearchAllAssignmentsPagedResponse>
searchAllAssignmentsSettings() {
return getStubSettingsBuilder().searchAllAssignmentsSettings();
}
/** Returns the builder for the settings used for calls to moveAssignment. */
public UnaryCallSettings.Builder moveAssignmentSettings() {
return getStubSettingsBuilder().moveAssignmentSettings();
}
/** Returns the builder for the settings used for calls to updateAssignment. */
public UnaryCallSettings.Builder
updateAssignmentSettings() {
return getStubSettingsBuilder().updateAssignmentSettings();
}
/** Returns the builder for the settings used for calls to getBiReservation. */
public UnaryCallSettings.Builder
getBiReservationSettings() {
return getStubSettingsBuilder().getBiReservationSettings();
}
/** Returns the builder for the settings used for calls to updateBiReservation. */
public UnaryCallSettings.Builder
updateBiReservationSettings() {
return getStubSettingsBuilder().updateBiReservationSettings();
}
@Override
public ReservationServiceSettings build() throws IOException {
return new ReservationServiceSettings(this);
}
}
}