com.google.cloud.gkemulticloud.v1.AzureClustersSettings Maven / Gradle / Ivy
Show all versions of google-cloud-gke-multi-cloud 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.gkemulticloud.v1;
import static com.google.cloud.gkemulticloud.v1.AzureClustersClient.ListAzureClientsPagedResponse;
import static com.google.cloud.gkemulticloud.v1.AzureClustersClient.ListAzureClustersPagedResponse;
import static com.google.cloud.gkemulticloud.v1.AzureClustersClient.ListAzureNodePoolsPagedResponse;
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.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.gkemulticloud.v1.stub.AzureClustersStubSettings;
import com.google.longrunning.Operation;
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 AzureClustersClient}.
*
* The default instance has everything set to sensible defaults:
*
*
* - The default service address (gkemulticloud.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 getAzureClient:
*
*
{@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
* AzureClustersSettings.Builder azureClustersSettingsBuilder = AzureClustersSettings.newBuilder();
* azureClustersSettingsBuilder
* .getAzureClientSettings()
* .setRetrySettings(
* azureClustersSettingsBuilder
* .getAzureClientSettings()
* .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());
* AzureClustersSettings azureClustersSettings = azureClustersSettingsBuilder.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.
*
* To configure the RetrySettings of a Long Running Operation method, create an
* OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to
* configure the RetrySettings for createAzureClient:
*
*
{@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
* AzureClustersSettings.Builder azureClustersSettingsBuilder = AzureClustersSettings.newBuilder();
* TimedRetryAlgorithm timedRetryAlgorithm =
* OperationalTimedPollAlgorithm.create(
* RetrySettings.newBuilder()
* .setInitialRetryDelayDuration(Duration.ofMillis(500))
* .setRetryDelayMultiplier(1.5)
* .setMaxRetryDelay(Duration.ofMillis(5000))
* .setTotalTimeoutDuration(Duration.ofHours(24))
* .build());
* azureClustersSettingsBuilder
* .createClusterOperationSettings()
* .setPollingAlgorithm(timedRetryAlgorithm)
* .build();
* }
*/
@Generated("by gapic-generator-java")
public class AzureClustersSettings extends ClientSettings {
/** Returns the object with the settings used for calls to createAzureClient. */
public UnaryCallSettings createAzureClientSettings() {
return ((AzureClustersStubSettings) getStubSettings()).createAzureClientSettings();
}
/** Returns the object with the settings used for calls to createAzureClient. */
public OperationCallSettings
createAzureClientOperationSettings() {
return ((AzureClustersStubSettings) getStubSettings()).createAzureClientOperationSettings();
}
/** Returns the object with the settings used for calls to getAzureClient. */
public UnaryCallSettings getAzureClientSettings() {
return ((AzureClustersStubSettings) getStubSettings()).getAzureClientSettings();
}
/** Returns the object with the settings used for calls to listAzureClients. */
public PagedCallSettings<
ListAzureClientsRequest, ListAzureClientsResponse, ListAzureClientsPagedResponse>
listAzureClientsSettings() {
return ((AzureClustersStubSettings) getStubSettings()).listAzureClientsSettings();
}
/** Returns the object with the settings used for calls to deleteAzureClient. */
public UnaryCallSettings deleteAzureClientSettings() {
return ((AzureClustersStubSettings) getStubSettings()).deleteAzureClientSettings();
}
/** Returns the object with the settings used for calls to deleteAzureClient. */
public OperationCallSettings
deleteAzureClientOperationSettings() {
return ((AzureClustersStubSettings) getStubSettings()).deleteAzureClientOperationSettings();
}
/** Returns the object with the settings used for calls to createAzureCluster. */
public UnaryCallSettings createAzureClusterSettings() {
return ((AzureClustersStubSettings) getStubSettings()).createAzureClusterSettings();
}
/** Returns the object with the settings used for calls to createAzureCluster. */
public OperationCallSettings
createAzureClusterOperationSettings() {
return ((AzureClustersStubSettings) getStubSettings()).createAzureClusterOperationSettings();
}
/** Returns the object with the settings used for calls to updateAzureCluster. */
public UnaryCallSettings updateAzureClusterSettings() {
return ((AzureClustersStubSettings) getStubSettings()).updateAzureClusterSettings();
}
/** Returns the object with the settings used for calls to updateAzureCluster. */
public OperationCallSettings
updateAzureClusterOperationSettings() {
return ((AzureClustersStubSettings) getStubSettings()).updateAzureClusterOperationSettings();
}
/** Returns the object with the settings used for calls to getAzureCluster. */
public UnaryCallSettings getAzureClusterSettings() {
return ((AzureClustersStubSettings) getStubSettings()).getAzureClusterSettings();
}
/** Returns the object with the settings used for calls to listAzureClusters. */
public PagedCallSettings<
ListAzureClustersRequest, ListAzureClustersResponse, ListAzureClustersPagedResponse>
listAzureClustersSettings() {
return ((AzureClustersStubSettings) getStubSettings()).listAzureClustersSettings();
}
/** Returns the object with the settings used for calls to deleteAzureCluster. */
public UnaryCallSettings deleteAzureClusterSettings() {
return ((AzureClustersStubSettings) getStubSettings()).deleteAzureClusterSettings();
}
/** Returns the object with the settings used for calls to deleteAzureCluster. */
public OperationCallSettings
deleteAzureClusterOperationSettings() {
return ((AzureClustersStubSettings) getStubSettings()).deleteAzureClusterOperationSettings();
}
/** Returns the object with the settings used for calls to generateAzureClusterAgentToken. */
public UnaryCallSettings<
GenerateAzureClusterAgentTokenRequest, GenerateAzureClusterAgentTokenResponse>
generateAzureClusterAgentTokenSettings() {
return ((AzureClustersStubSettings) getStubSettings()).generateAzureClusterAgentTokenSettings();
}
/** Returns the object with the settings used for calls to generateAzureAccessToken. */
public UnaryCallSettings
generateAzureAccessTokenSettings() {
return ((AzureClustersStubSettings) getStubSettings()).generateAzureAccessTokenSettings();
}
/** Returns the object with the settings used for calls to createAzureNodePool. */
public UnaryCallSettings createAzureNodePoolSettings() {
return ((AzureClustersStubSettings) getStubSettings()).createAzureNodePoolSettings();
}
/** Returns the object with the settings used for calls to createAzureNodePool. */
public OperationCallSettings
createAzureNodePoolOperationSettings() {
return ((AzureClustersStubSettings) getStubSettings()).createAzureNodePoolOperationSettings();
}
/** Returns the object with the settings used for calls to updateAzureNodePool. */
public UnaryCallSettings updateAzureNodePoolSettings() {
return ((AzureClustersStubSettings) getStubSettings()).updateAzureNodePoolSettings();
}
/** Returns the object with the settings used for calls to updateAzureNodePool. */
public OperationCallSettings
updateAzureNodePoolOperationSettings() {
return ((AzureClustersStubSettings) getStubSettings()).updateAzureNodePoolOperationSettings();
}
/** Returns the object with the settings used for calls to getAzureNodePool. */
public UnaryCallSettings getAzureNodePoolSettings() {
return ((AzureClustersStubSettings) getStubSettings()).getAzureNodePoolSettings();
}
/** Returns the object with the settings used for calls to listAzureNodePools. */
public PagedCallSettings<
ListAzureNodePoolsRequest, ListAzureNodePoolsResponse, ListAzureNodePoolsPagedResponse>
listAzureNodePoolsSettings() {
return ((AzureClustersStubSettings) getStubSettings()).listAzureNodePoolsSettings();
}
/** Returns the object with the settings used for calls to deleteAzureNodePool. */
public UnaryCallSettings deleteAzureNodePoolSettings() {
return ((AzureClustersStubSettings) getStubSettings()).deleteAzureNodePoolSettings();
}
/** Returns the object with the settings used for calls to deleteAzureNodePool. */
public OperationCallSettings
deleteAzureNodePoolOperationSettings() {
return ((AzureClustersStubSettings) getStubSettings()).deleteAzureNodePoolOperationSettings();
}
/** Returns the object with the settings used for calls to getAzureOpenIdConfig. */
public UnaryCallSettings
getAzureOpenIdConfigSettings() {
return ((AzureClustersStubSettings) getStubSettings()).getAzureOpenIdConfigSettings();
}
/** Returns the object with the settings used for calls to getAzureJsonWebKeys. */
public UnaryCallSettings
getAzureJsonWebKeysSettings() {
return ((AzureClustersStubSettings) getStubSettings()).getAzureJsonWebKeysSettings();
}
/** Returns the object with the settings used for calls to getAzureServerConfig. */
public UnaryCallSettings
getAzureServerConfigSettings() {
return ((AzureClustersStubSettings) getStubSettings()).getAzureServerConfigSettings();
}
public static final AzureClustersSettings create(AzureClustersStubSettings stub)
throws IOException {
return new AzureClustersSettings.Builder(stub.toBuilder()).build();
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return AzureClustersStubSettings.defaultExecutorProviderBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return AzureClustersStubSettings.getDefaultEndpoint();
}
/** Returns the default service scopes. */
public static List getDefaultServiceScopes() {
return AzureClustersStubSettings.getDefaultServiceScopes();
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return AzureClustersStubSettings.defaultCredentialsProviderBuilder();
}
/** Returns a builder for the default gRPC ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return AzureClustersStubSettings.defaultGrpcTransportProviderBuilder();
}
/** Returns a builder for the default REST ChannelProvider for this service. */
@BetaApi
public static InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder() {
return AzureClustersStubSettings.defaultHttpJsonTransportProviderBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return AzureClustersStubSettings.defaultTransportChannelProvider();
}
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return AzureClustersStubSettings.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 AzureClustersSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
}
/** Builder for AzureClustersSettings. */
public static class Builder extends ClientSettings.Builder {
protected Builder() throws IOException {
this(((ClientContext) null));
}
protected Builder(ClientContext clientContext) {
super(AzureClustersStubSettings.newBuilder(clientContext));
}
protected Builder(AzureClustersSettings settings) {
super(settings.getStubSettings().toBuilder());
}
protected Builder(AzureClustersStubSettings.Builder stubSettings) {
super(stubSettings);
}
private static Builder createDefault() {
return new Builder(AzureClustersStubSettings.newBuilder());
}
private static Builder createHttpJsonDefault() {
return new Builder(AzureClustersStubSettings.newHttpJsonBuilder());
}
public AzureClustersStubSettings.Builder getStubSettingsBuilder() {
return ((AzureClustersStubSettings.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 createAzureClient. */
public UnaryCallSettings.Builder
createAzureClientSettings() {
return getStubSettingsBuilder().createAzureClientSettings();
}
/** Returns the builder for the settings used for calls to createAzureClient. */
public OperationCallSettings.Builder
createAzureClientOperationSettings() {
return getStubSettingsBuilder().createAzureClientOperationSettings();
}
/** Returns the builder for the settings used for calls to getAzureClient. */
public UnaryCallSettings.Builder getAzureClientSettings() {
return getStubSettingsBuilder().getAzureClientSettings();
}
/** Returns the builder for the settings used for calls to listAzureClients. */
public PagedCallSettings.Builder<
ListAzureClientsRequest, ListAzureClientsResponse, ListAzureClientsPagedResponse>
listAzureClientsSettings() {
return getStubSettingsBuilder().listAzureClientsSettings();
}
/** Returns the builder for the settings used for calls to deleteAzureClient. */
public UnaryCallSettings.Builder
deleteAzureClientSettings() {
return getStubSettingsBuilder().deleteAzureClientSettings();
}
/** Returns the builder for the settings used for calls to deleteAzureClient. */
public OperationCallSettings.Builder
deleteAzureClientOperationSettings() {
return getStubSettingsBuilder().deleteAzureClientOperationSettings();
}
/** Returns the builder for the settings used for calls to createAzureCluster. */
public UnaryCallSettings.Builder
createAzureClusterSettings() {
return getStubSettingsBuilder().createAzureClusterSettings();
}
/** Returns the builder for the settings used for calls to createAzureCluster. */
public OperationCallSettings.Builder
createAzureClusterOperationSettings() {
return getStubSettingsBuilder().createAzureClusterOperationSettings();
}
/** Returns the builder for the settings used for calls to updateAzureCluster. */
public UnaryCallSettings.Builder
updateAzureClusterSettings() {
return getStubSettingsBuilder().updateAzureClusterSettings();
}
/** Returns the builder for the settings used for calls to updateAzureCluster. */
public OperationCallSettings.Builder
updateAzureClusterOperationSettings() {
return getStubSettingsBuilder().updateAzureClusterOperationSettings();
}
/** Returns the builder for the settings used for calls to getAzureCluster. */
public UnaryCallSettings.Builder
getAzureClusterSettings() {
return getStubSettingsBuilder().getAzureClusterSettings();
}
/** Returns the builder for the settings used for calls to listAzureClusters. */
public PagedCallSettings.Builder<
ListAzureClustersRequest, ListAzureClustersResponse, ListAzureClustersPagedResponse>
listAzureClustersSettings() {
return getStubSettingsBuilder().listAzureClustersSettings();
}
/** Returns the builder for the settings used for calls to deleteAzureCluster. */
public UnaryCallSettings.Builder
deleteAzureClusterSettings() {
return getStubSettingsBuilder().deleteAzureClusterSettings();
}
/** Returns the builder for the settings used for calls to deleteAzureCluster. */
public OperationCallSettings.Builder
deleteAzureClusterOperationSettings() {
return getStubSettingsBuilder().deleteAzureClusterOperationSettings();
}
/** Returns the builder for the settings used for calls to generateAzureClusterAgentToken. */
public UnaryCallSettings.Builder<
GenerateAzureClusterAgentTokenRequest, GenerateAzureClusterAgentTokenResponse>
generateAzureClusterAgentTokenSettings() {
return getStubSettingsBuilder().generateAzureClusterAgentTokenSettings();
}
/** Returns the builder for the settings used for calls to generateAzureAccessToken. */
public UnaryCallSettings.Builder<
GenerateAzureAccessTokenRequest, GenerateAzureAccessTokenResponse>
generateAzureAccessTokenSettings() {
return getStubSettingsBuilder().generateAzureAccessTokenSettings();
}
/** Returns the builder for the settings used for calls to createAzureNodePool. */
public UnaryCallSettings.Builder
createAzureNodePoolSettings() {
return getStubSettingsBuilder().createAzureNodePoolSettings();
}
/** Returns the builder for the settings used for calls to createAzureNodePool. */
public OperationCallSettings.Builder<
CreateAzureNodePoolRequest, AzureNodePool, OperationMetadata>
createAzureNodePoolOperationSettings() {
return getStubSettingsBuilder().createAzureNodePoolOperationSettings();
}
/** Returns the builder for the settings used for calls to updateAzureNodePool. */
public UnaryCallSettings.Builder
updateAzureNodePoolSettings() {
return getStubSettingsBuilder().updateAzureNodePoolSettings();
}
/** Returns the builder for the settings used for calls to updateAzureNodePool. */
public OperationCallSettings.Builder<
UpdateAzureNodePoolRequest, AzureNodePool, OperationMetadata>
updateAzureNodePoolOperationSettings() {
return getStubSettingsBuilder().updateAzureNodePoolOperationSettings();
}
/** Returns the builder for the settings used for calls to getAzureNodePool. */
public UnaryCallSettings.Builder
getAzureNodePoolSettings() {
return getStubSettingsBuilder().getAzureNodePoolSettings();
}
/** Returns the builder for the settings used for calls to listAzureNodePools. */
public PagedCallSettings.Builder<
ListAzureNodePoolsRequest, ListAzureNodePoolsResponse, ListAzureNodePoolsPagedResponse>
listAzureNodePoolsSettings() {
return getStubSettingsBuilder().listAzureNodePoolsSettings();
}
/** Returns the builder for the settings used for calls to deleteAzureNodePool. */
public UnaryCallSettings.Builder
deleteAzureNodePoolSettings() {
return getStubSettingsBuilder().deleteAzureNodePoolSettings();
}
/** Returns the builder for the settings used for calls to deleteAzureNodePool. */
public OperationCallSettings.Builder
deleteAzureNodePoolOperationSettings() {
return getStubSettingsBuilder().deleteAzureNodePoolOperationSettings();
}
/** Returns the builder for the settings used for calls to getAzureOpenIdConfig. */
public UnaryCallSettings.Builder
getAzureOpenIdConfigSettings() {
return getStubSettingsBuilder().getAzureOpenIdConfigSettings();
}
/** Returns the builder for the settings used for calls to getAzureJsonWebKeys. */
public UnaryCallSettings.Builder
getAzureJsonWebKeysSettings() {
return getStubSettingsBuilder().getAzureJsonWebKeysSettings();
}
/** Returns the builder for the settings used for calls to getAzureServerConfig. */
public UnaryCallSettings.Builder
getAzureServerConfigSettings() {
return getStubSettingsBuilder().getAzureServerConfigSettings();
}
@Override
public AzureClustersSettings build() throws IOException {
return new AzureClustersSettings(this);
}
}
}