ReservationsSettings.java
/*
* Copyright 2022 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.compute.v1;
import static com.google.cloud.compute.v1.ReservationsClient.AggregatedListPagedResponse;
import static com.google.cloud.compute.v1.ReservationsClient.ListPagedResponse;
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.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.OperationCallSettings;
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.compute.v1.stub.ReservationsStubSettings;
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 ReservationsClient}.
*
* <p>The default instance has everything set to sensible defaults:
*
* <ul>
* <li>The default service address (compute.googleapis.com) and default port (443) are used.
* <li>Credentials are acquired automatically through Application Default Credentials.
* <li>Retries are configured for idempotent methods but not for non-idempotent methods.
* </ul>
*
* <p>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.
*
* <p>For example, to set the total timeout of get to 30 seconds:
*
* <pre>{@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
* ReservationsSettings.Builder reservationsSettingsBuilder = ReservationsSettings.newBuilder();
* reservationsSettingsBuilder
* .getSettings()
* .setRetrySettings(
* reservationsSettingsBuilder.getSettings().getRetrySettings().toBuilder()
* .setTotalTimeout(Duration.ofSeconds(30))
* .build());
* ReservationsSettings reservationsSettings = reservationsSettingsBuilder.build();
* }</pre>
*/
@Generated("by gapic-generator-java")
public class ReservationsSettings extends ClientSettings<ReservationsSettings> {
/** Returns the object with the settings used for calls to aggregatedList. */
public PagedCallSettings<
AggregatedListReservationsRequest, ReservationAggregatedList, AggregatedListPagedResponse>
aggregatedListSettings() {
return ((ReservationsStubSettings) getStubSettings()).aggregatedListSettings();
}
/** Returns the object with the settings used for calls to delete. */
public UnaryCallSettings<DeleteReservationRequest, Operation> deleteSettings() {
return ((ReservationsStubSettings) getStubSettings()).deleteSettings();
}
/** Returns the object with the settings used for calls to delete. */
public OperationCallSettings<DeleteReservationRequest, Operation, Operation>
deleteOperationSettings() {
return ((ReservationsStubSettings) getStubSettings()).deleteOperationSettings();
}
/** Returns the object with the settings used for calls to get. */
public UnaryCallSettings<GetReservationRequest, Reservation> getSettings() {
return ((ReservationsStubSettings) getStubSettings()).getSettings();
}
/** Returns the object with the settings used for calls to getIamPolicy. */
public UnaryCallSettings<GetIamPolicyReservationRequest, Policy> getIamPolicySettings() {
return ((ReservationsStubSettings) getStubSettings()).getIamPolicySettings();
}
/** Returns the object with the settings used for calls to insert. */
public UnaryCallSettings<InsertReservationRequest, Operation> insertSettings() {
return ((ReservationsStubSettings) getStubSettings()).insertSettings();
}
/** Returns the object with the settings used for calls to insert. */
public OperationCallSettings<InsertReservationRequest, Operation, Operation>
insertOperationSettings() {
return ((ReservationsStubSettings) getStubSettings()).insertOperationSettings();
}
/** Returns the object with the settings used for calls to list. */
public PagedCallSettings<ListReservationsRequest, ReservationList, ListPagedResponse>
listSettings() {
return ((ReservationsStubSettings) getStubSettings()).listSettings();
}
/** Returns the object with the settings used for calls to resize. */
public UnaryCallSettings<ResizeReservationRequest, Operation> resizeSettings() {
return ((ReservationsStubSettings) getStubSettings()).resizeSettings();
}
/** Returns the object with the settings used for calls to resize. */
public OperationCallSettings<ResizeReservationRequest, Operation, Operation>
resizeOperationSettings() {
return ((ReservationsStubSettings) getStubSettings()).resizeOperationSettings();
}
/** Returns the object with the settings used for calls to setIamPolicy. */
public UnaryCallSettings<SetIamPolicyReservationRequest, Policy> setIamPolicySettings() {
return ((ReservationsStubSettings) getStubSettings()).setIamPolicySettings();
}
/** Returns the object with the settings used for calls to testIamPermissions. */
public UnaryCallSettings<TestIamPermissionsReservationRequest, TestPermissionsResponse>
testIamPermissionsSettings() {
return ((ReservationsStubSettings) getStubSettings()).testIamPermissionsSettings();
}
/** Returns the object with the settings used for calls to update. */
public UnaryCallSettings<UpdateReservationRequest, Operation> updateSettings() {
return ((ReservationsStubSettings) getStubSettings()).updateSettings();
}
/** Returns the object with the settings used for calls to update. */
public OperationCallSettings<UpdateReservationRequest, Operation, Operation>
updateOperationSettings() {
return ((ReservationsStubSettings) getStubSettings()).updateOperationSettings();
}
public static final ReservationsSettings create(ReservationsStubSettings stub)
throws IOException {
return new ReservationsSettings.Builder(stub.toBuilder()).build();
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return ReservationsStubSettings.defaultExecutorProviderBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return ReservationsStubSettings.getDefaultEndpoint();
}
/** Returns the default service scopes. */
public static List<String> getDefaultServiceScopes() {
return ReservationsStubSettings.getDefaultServiceScopes();
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return ReservationsStubSettings.defaultCredentialsProviderBuilder();
}
/** Returns a builder for the default ChannelProvider for this service. */
public static InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder() {
return ReservationsStubSettings.defaultHttpJsonTransportProviderBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return ReservationsStubSettings.defaultTransportChannelProvider();
}
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return ReservationsStubSettings.defaultApiClientHeaderProviderBuilder();
}
/** Returns a new builder for this class. */
public static Builder newBuilder() {
return Builder.createDefault();
}
/** 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 ReservationsSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
}
/** Builder for ReservationsSettings. */
public static class Builder extends ClientSettings.Builder<ReservationsSettings, Builder> {
protected Builder() throws IOException {
this(((ClientContext) null));
}
protected Builder(ClientContext clientContext) {
super(ReservationsStubSettings.newBuilder(clientContext));
}
protected Builder(ReservationsSettings settings) {
super(settings.getStubSettings().toBuilder());
}
protected Builder(ReservationsStubSettings.Builder stubSettings) {
super(stubSettings);
}
private static Builder createDefault() {
return new Builder(ReservationsStubSettings.newBuilder());
}
public ReservationsStubSettings.Builder getStubSettingsBuilder() {
return ((ReservationsStubSettings.Builder) getStubSettings());
}
/**
* Applies the given settings updater function to all of the unary API methods in this service.
*
* <p>Note: This method does not support applying settings to streaming methods.
*/
public Builder applyToAllUnaryMethods(
ApiFunction<UnaryCallSettings.Builder<?, ?>, Void> settingsUpdater) {
super.applyToAllUnaryMethods(
getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater);
return this;
}
/** Returns the builder for the settings used for calls to aggregatedList. */
public PagedCallSettings.Builder<
AggregatedListReservationsRequest,
ReservationAggregatedList,
AggregatedListPagedResponse>
aggregatedListSettings() {
return getStubSettingsBuilder().aggregatedListSettings();
}
/** Returns the builder for the settings used for calls to delete. */
public UnaryCallSettings.Builder<DeleteReservationRequest, Operation> deleteSettings() {
return getStubSettingsBuilder().deleteSettings();
}
/** Returns the builder for the settings used for calls to delete. */
public OperationCallSettings.Builder<DeleteReservationRequest, Operation, Operation>
deleteOperationSettings() {
return getStubSettingsBuilder().deleteOperationSettings();
}
/** Returns the builder for the settings used for calls to get. */
public UnaryCallSettings.Builder<GetReservationRequest, Reservation> getSettings() {
return getStubSettingsBuilder().getSettings();
}
/** Returns the builder for the settings used for calls to getIamPolicy. */
public UnaryCallSettings.Builder<GetIamPolicyReservationRequest, Policy>
getIamPolicySettings() {
return getStubSettingsBuilder().getIamPolicySettings();
}
/** Returns the builder for the settings used for calls to insert. */
public UnaryCallSettings.Builder<InsertReservationRequest, Operation> insertSettings() {
return getStubSettingsBuilder().insertSettings();
}
/** Returns the builder for the settings used for calls to insert. */
public OperationCallSettings.Builder<InsertReservationRequest, Operation, Operation>
insertOperationSettings() {
return getStubSettingsBuilder().insertOperationSettings();
}
/** Returns the builder for the settings used for calls to list. */
public PagedCallSettings.Builder<ListReservationsRequest, ReservationList, ListPagedResponse>
listSettings() {
return getStubSettingsBuilder().listSettings();
}
/** Returns the builder for the settings used for calls to resize. */
public UnaryCallSettings.Builder<ResizeReservationRequest, Operation> resizeSettings() {
return getStubSettingsBuilder().resizeSettings();
}
/** Returns the builder for the settings used for calls to resize. */
public OperationCallSettings.Builder<ResizeReservationRequest, Operation, Operation>
resizeOperationSettings() {
return getStubSettingsBuilder().resizeOperationSettings();
}
/** Returns the builder for the settings used for calls to setIamPolicy. */
public UnaryCallSettings.Builder<SetIamPolicyReservationRequest, Policy>
setIamPolicySettings() {
return getStubSettingsBuilder().setIamPolicySettings();
}
/** Returns the builder for the settings used for calls to testIamPermissions. */
public UnaryCallSettings.Builder<TestIamPermissionsReservationRequest, TestPermissionsResponse>
testIamPermissionsSettings() {
return getStubSettingsBuilder().testIamPermissionsSettings();
}
/** Returns the builder for the settings used for calls to update. */
public UnaryCallSettings.Builder<UpdateReservationRequest, Operation> updateSettings() {
return getStubSettingsBuilder().updateSettings();
}
/** Returns the builder for the settings used for calls to update. */
public OperationCallSettings.Builder<UpdateReservationRequest, Operation, Operation>
updateOperationSettings() {
return getStubSettingsBuilder().updateOperationSettings();
}
@Override
public ReservationsSettings build() throws IOException {
return new ReservationsSettings(this);
}
}
}