com.google.cloud.networkconnectivity.v1alpha1.HubServiceSettings Maven / Gradle / Ivy
Show all versions of google-cloud-networkconnectivity 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.networkconnectivity.v1alpha1;
import static com.google.cloud.networkconnectivity.v1alpha1.HubServiceClient.ListHubsPagedResponse;
import static com.google.cloud.networkconnectivity.v1alpha1.HubServiceClient.ListSpokesPagedResponse;
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.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.networkconnectivity.v1alpha1.stub.HubServiceStubSettings;
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 HubServiceClient}.
*
* The default instance has everything set to sensible defaults:
*
*
* - The default service address (networkconnectivity.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 getHub:
*
*
{@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
* HubServiceSettings.Builder hubServiceSettingsBuilder = HubServiceSettings.newBuilder();
* hubServiceSettingsBuilder
* .getHubSettings()
* .setRetrySettings(
* hubServiceSettingsBuilder
* .getHubSettings()
* .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());
* HubServiceSettings hubServiceSettings = hubServiceSettingsBuilder.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 createHub:
*
*
{@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
* HubServiceSettings.Builder hubServiceSettingsBuilder = HubServiceSettings.newBuilder();
* TimedRetryAlgorithm timedRetryAlgorithm =
* OperationalTimedPollAlgorithm.create(
* RetrySettings.newBuilder()
* .setInitialRetryDelayDuration(Duration.ofMillis(500))
* .setRetryDelayMultiplier(1.5)
* .setMaxRetryDelayDuration(Duration.ofMillis(5000))
* .setTotalTimeoutDuration(Duration.ofHours(24))
* .build());
* hubServiceSettingsBuilder
* .createClusterOperationSettings()
* .setPollingAlgorithm(timedRetryAlgorithm)
* .build();
* }
*/
@BetaApi
@Generated("by gapic-generator-java")
public class HubServiceSettings extends ClientSettings {
/** Returns the object with the settings used for calls to listHubs. */
public PagedCallSettings
listHubsSettings() {
return ((HubServiceStubSettings) getStubSettings()).listHubsSettings();
}
/** Returns the object with the settings used for calls to getHub. */
public UnaryCallSettings getHubSettings() {
return ((HubServiceStubSettings) getStubSettings()).getHubSettings();
}
/** Returns the object with the settings used for calls to createHub. */
public UnaryCallSettings createHubSettings() {
return ((HubServiceStubSettings) getStubSettings()).createHubSettings();
}
/** Returns the object with the settings used for calls to createHub. */
public OperationCallSettings
createHubOperationSettings() {
return ((HubServiceStubSettings) getStubSettings()).createHubOperationSettings();
}
/** Returns the object with the settings used for calls to updateHub. */
public UnaryCallSettings updateHubSettings() {
return ((HubServiceStubSettings) getStubSettings()).updateHubSettings();
}
/** Returns the object with the settings used for calls to updateHub. */
public OperationCallSettings
updateHubOperationSettings() {
return ((HubServiceStubSettings) getStubSettings()).updateHubOperationSettings();
}
/** Returns the object with the settings used for calls to deleteHub. */
public UnaryCallSettings deleteHubSettings() {
return ((HubServiceStubSettings) getStubSettings()).deleteHubSettings();
}
/** Returns the object with the settings used for calls to deleteHub. */
public OperationCallSettings
deleteHubOperationSettings() {
return ((HubServiceStubSettings) getStubSettings()).deleteHubOperationSettings();
}
/** Returns the object with the settings used for calls to listSpokes. */
public PagedCallSettings
listSpokesSettings() {
return ((HubServiceStubSettings) getStubSettings()).listSpokesSettings();
}
/** Returns the object with the settings used for calls to getSpoke. */
public UnaryCallSettings getSpokeSettings() {
return ((HubServiceStubSettings) getStubSettings()).getSpokeSettings();
}
/** Returns the object with the settings used for calls to createSpoke. */
public UnaryCallSettings createSpokeSettings() {
return ((HubServiceStubSettings) getStubSettings()).createSpokeSettings();
}
/** Returns the object with the settings used for calls to createSpoke. */
public OperationCallSettings
createSpokeOperationSettings() {
return ((HubServiceStubSettings) getStubSettings()).createSpokeOperationSettings();
}
/** Returns the object with the settings used for calls to updateSpoke. */
public UnaryCallSettings updateSpokeSettings() {
return ((HubServiceStubSettings) getStubSettings()).updateSpokeSettings();
}
/** Returns the object with the settings used for calls to updateSpoke. */
public OperationCallSettings
updateSpokeOperationSettings() {
return ((HubServiceStubSettings) getStubSettings()).updateSpokeOperationSettings();
}
/** Returns the object with the settings used for calls to deleteSpoke. */
public UnaryCallSettings deleteSpokeSettings() {
return ((HubServiceStubSettings) getStubSettings()).deleteSpokeSettings();
}
/** Returns the object with the settings used for calls to deleteSpoke. */
public OperationCallSettings
deleteSpokeOperationSettings() {
return ((HubServiceStubSettings) getStubSettings()).deleteSpokeOperationSettings();
}
public static final HubServiceSettings create(HubServiceStubSettings stub) throws IOException {
return new HubServiceSettings.Builder(stub.toBuilder()).build();
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return HubServiceStubSettings.defaultExecutorProviderBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return HubServiceStubSettings.getDefaultEndpoint();
}
/** Returns the default service scopes. */
public static List getDefaultServiceScopes() {
return HubServiceStubSettings.getDefaultServiceScopes();
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return HubServiceStubSettings.defaultCredentialsProviderBuilder();
}
/** Returns a builder for the default ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return HubServiceStubSettings.defaultGrpcTransportProviderBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return HubServiceStubSettings.defaultTransportChannelProvider();
}
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return HubServiceStubSettings.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 HubServiceSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
}
/** Builder for HubServiceSettings. */
public static class Builder extends ClientSettings.Builder {
protected Builder() throws IOException {
this(((ClientContext) null));
}
protected Builder(ClientContext clientContext) {
super(HubServiceStubSettings.newBuilder(clientContext));
}
protected Builder(HubServiceSettings settings) {
super(settings.getStubSettings().toBuilder());
}
protected Builder(HubServiceStubSettings.Builder stubSettings) {
super(stubSettings);
}
private static Builder createDefault() {
return new Builder(HubServiceStubSettings.newBuilder());
}
public HubServiceStubSettings.Builder getStubSettingsBuilder() {
return ((HubServiceStubSettings.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 listHubs. */
public PagedCallSettings.Builder
listHubsSettings() {
return getStubSettingsBuilder().listHubsSettings();
}
/** Returns the builder for the settings used for calls to getHub. */
public UnaryCallSettings.Builder getHubSettings() {
return getStubSettingsBuilder().getHubSettings();
}
/** Returns the builder for the settings used for calls to createHub. */
public UnaryCallSettings.Builder createHubSettings() {
return getStubSettingsBuilder().createHubSettings();
}
/** Returns the builder for the settings used for calls to createHub. */
public OperationCallSettings.Builder
createHubOperationSettings() {
return getStubSettingsBuilder().createHubOperationSettings();
}
/** Returns the builder for the settings used for calls to updateHub. */
public UnaryCallSettings.Builder updateHubSettings() {
return getStubSettingsBuilder().updateHubSettings();
}
/** Returns the builder for the settings used for calls to updateHub. */
public OperationCallSettings.Builder
updateHubOperationSettings() {
return getStubSettingsBuilder().updateHubOperationSettings();
}
/** Returns the builder for the settings used for calls to deleteHub. */
public UnaryCallSettings.Builder deleteHubSettings() {
return getStubSettingsBuilder().deleteHubSettings();
}
/** Returns the builder for the settings used for calls to deleteHub. */
public OperationCallSettings.Builder
deleteHubOperationSettings() {
return getStubSettingsBuilder().deleteHubOperationSettings();
}
/** Returns the builder for the settings used for calls to listSpokes. */
public PagedCallSettings.Builder
listSpokesSettings() {
return getStubSettingsBuilder().listSpokesSettings();
}
/** Returns the builder for the settings used for calls to getSpoke. */
public UnaryCallSettings.Builder getSpokeSettings() {
return getStubSettingsBuilder().getSpokeSettings();
}
/** Returns the builder for the settings used for calls to createSpoke. */
public UnaryCallSettings.Builder createSpokeSettings() {
return getStubSettingsBuilder().createSpokeSettings();
}
/** Returns the builder for the settings used for calls to createSpoke. */
public OperationCallSettings.Builder
createSpokeOperationSettings() {
return getStubSettingsBuilder().createSpokeOperationSettings();
}
/** Returns the builder for the settings used for calls to updateSpoke. */
public UnaryCallSettings.Builder updateSpokeSettings() {
return getStubSettingsBuilder().updateSpokeSettings();
}
/** Returns the builder for the settings used for calls to updateSpoke. */
public OperationCallSettings.Builder
updateSpokeOperationSettings() {
return getStubSettingsBuilder().updateSpokeOperationSettings();
}
/** Returns the builder for the settings used for calls to deleteSpoke. */
public UnaryCallSettings.Builder deleteSpokeSettings() {
return getStubSettingsBuilder().deleteSpokeSettings();
}
/** Returns the builder for the settings used for calls to deleteSpoke. */
public OperationCallSettings.Builder
deleteSpokeOperationSettings() {
return getStubSettingsBuilder().deleteSpokeOperationSettings();
}
@Override
public HubServiceSettings build() throws IOException {
return new HubServiceSettings(this);
}
}
}