com.google.cloud.datastream.v1alpha1.DatastreamSettings Maven / Gradle / Ivy
Show all versions of google-cloud-datastream 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.datastream.v1alpha1;
import static com.google.cloud.datastream.v1alpha1.DatastreamClient.FetchStaticIpsPagedResponse;
import static com.google.cloud.datastream.v1alpha1.DatastreamClient.ListConnectionProfilesPagedResponse;
import static com.google.cloud.datastream.v1alpha1.DatastreamClient.ListPrivateConnectionsPagedResponse;
import static com.google.cloud.datastream.v1alpha1.DatastreamClient.ListRoutesPagedResponse;
import static com.google.cloud.datastream.v1alpha1.DatastreamClient.ListStreamsPagedResponse;
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.datastream.v1alpha1.stub.DatastreamStubSettings;
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 DatastreamClient}.
*
* The default instance has everything set to sensible defaults:
*
*
* - The default service address (datastream.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 getConnectionProfile:
*
*
{@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
* DatastreamSettings.Builder datastreamSettingsBuilder = DatastreamSettings.newBuilder();
* datastreamSettingsBuilder
* .getConnectionProfileSettings()
* .setRetrySettings(
* datastreamSettingsBuilder
* .getConnectionProfileSettings()
* .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());
* DatastreamSettings datastreamSettings = datastreamSettingsBuilder.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 createConnectionProfile:
*
*
{@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
* DatastreamSettings.Builder datastreamSettingsBuilder = DatastreamSettings.newBuilder();
* TimedRetryAlgorithm timedRetryAlgorithm =
* OperationalTimedPollAlgorithm.create(
* RetrySettings.newBuilder()
* .setInitialRetryDelayDuration(Duration.ofMillis(500))
* .setRetryDelayMultiplier(1.5)
* .setMaxRetryDelayDuration(Duration.ofMillis(5000))
* .setTotalTimeoutDuration(Duration.ofHours(24))
* .build());
* datastreamSettingsBuilder
* .createClusterOperationSettings()
* .setPollingAlgorithm(timedRetryAlgorithm)
* .build();
* }
*/
@BetaApi
@Generated("by gapic-generator-java")
public class DatastreamSettings extends ClientSettings {
/** Returns the object with the settings used for calls to listConnectionProfiles. */
public PagedCallSettings<
ListConnectionProfilesRequest,
ListConnectionProfilesResponse,
ListConnectionProfilesPagedResponse>
listConnectionProfilesSettings() {
return ((DatastreamStubSettings) getStubSettings()).listConnectionProfilesSettings();
}
/** Returns the object with the settings used for calls to getConnectionProfile. */
public UnaryCallSettings
getConnectionProfileSettings() {
return ((DatastreamStubSettings) getStubSettings()).getConnectionProfileSettings();
}
/** Returns the object with the settings used for calls to createConnectionProfile. */
public UnaryCallSettings
createConnectionProfileSettings() {
return ((DatastreamStubSettings) getStubSettings()).createConnectionProfileSettings();
}
/** Returns the object with the settings used for calls to createConnectionProfile. */
public OperationCallSettings
createConnectionProfileOperationSettings() {
return ((DatastreamStubSettings) getStubSettings()).createConnectionProfileOperationSettings();
}
/** Returns the object with the settings used for calls to updateConnectionProfile. */
public UnaryCallSettings
updateConnectionProfileSettings() {
return ((DatastreamStubSettings) getStubSettings()).updateConnectionProfileSettings();
}
/** Returns the object with the settings used for calls to updateConnectionProfile. */
public OperationCallSettings
updateConnectionProfileOperationSettings() {
return ((DatastreamStubSettings) getStubSettings()).updateConnectionProfileOperationSettings();
}
/** Returns the object with the settings used for calls to deleteConnectionProfile. */
public UnaryCallSettings
deleteConnectionProfileSettings() {
return ((DatastreamStubSettings) getStubSettings()).deleteConnectionProfileSettings();
}
/** Returns the object with the settings used for calls to deleteConnectionProfile. */
public OperationCallSettings
deleteConnectionProfileOperationSettings() {
return ((DatastreamStubSettings) getStubSettings()).deleteConnectionProfileOperationSettings();
}
/** Returns the object with the settings used for calls to discoverConnectionProfile. */
public UnaryCallSettings
discoverConnectionProfileSettings() {
return ((DatastreamStubSettings) getStubSettings()).discoverConnectionProfileSettings();
}
/** Returns the object with the settings used for calls to listStreams. */
public PagedCallSettings
listStreamsSettings() {
return ((DatastreamStubSettings) getStubSettings()).listStreamsSettings();
}
/** Returns the object with the settings used for calls to getStream. */
public UnaryCallSettings getStreamSettings() {
return ((DatastreamStubSettings) getStubSettings()).getStreamSettings();
}
/** Returns the object with the settings used for calls to createStream. */
public UnaryCallSettings createStreamSettings() {
return ((DatastreamStubSettings) getStubSettings()).createStreamSettings();
}
/** Returns the object with the settings used for calls to createStream. */
public OperationCallSettings
createStreamOperationSettings() {
return ((DatastreamStubSettings) getStubSettings()).createStreamOperationSettings();
}
/** Returns the object with the settings used for calls to updateStream. */
public UnaryCallSettings updateStreamSettings() {
return ((DatastreamStubSettings) getStubSettings()).updateStreamSettings();
}
/** Returns the object with the settings used for calls to updateStream. */
public OperationCallSettings
updateStreamOperationSettings() {
return ((DatastreamStubSettings) getStubSettings()).updateStreamOperationSettings();
}
/** Returns the object with the settings used for calls to deleteStream. */
public UnaryCallSettings deleteStreamSettings() {
return ((DatastreamStubSettings) getStubSettings()).deleteStreamSettings();
}
/** Returns the object with the settings used for calls to deleteStream. */
public OperationCallSettings
deleteStreamOperationSettings() {
return ((DatastreamStubSettings) getStubSettings()).deleteStreamOperationSettings();
}
/** Returns the object with the settings used for calls to fetchErrors. */
public UnaryCallSettings fetchErrorsSettings() {
return ((DatastreamStubSettings) getStubSettings()).fetchErrorsSettings();
}
/** Returns the object with the settings used for calls to fetchErrors. */
public OperationCallSettings
fetchErrorsOperationSettings() {
return ((DatastreamStubSettings) getStubSettings()).fetchErrorsOperationSettings();
}
/** Returns the object with the settings used for calls to fetchStaticIps. */
public PagedCallSettings<
FetchStaticIpsRequest, FetchStaticIpsResponse, FetchStaticIpsPagedResponse>
fetchStaticIpsSettings() {
return ((DatastreamStubSettings) getStubSettings()).fetchStaticIpsSettings();
}
/** Returns the object with the settings used for calls to createPrivateConnection. */
public UnaryCallSettings
createPrivateConnectionSettings() {
return ((DatastreamStubSettings) getStubSettings()).createPrivateConnectionSettings();
}
/** Returns the object with the settings used for calls to createPrivateConnection. */
public OperationCallSettings
createPrivateConnectionOperationSettings() {
return ((DatastreamStubSettings) getStubSettings()).createPrivateConnectionOperationSettings();
}
/** Returns the object with the settings used for calls to getPrivateConnection. */
public UnaryCallSettings
getPrivateConnectionSettings() {
return ((DatastreamStubSettings) getStubSettings()).getPrivateConnectionSettings();
}
/** Returns the object with the settings used for calls to listPrivateConnections. */
public PagedCallSettings<
ListPrivateConnectionsRequest,
ListPrivateConnectionsResponse,
ListPrivateConnectionsPagedResponse>
listPrivateConnectionsSettings() {
return ((DatastreamStubSettings) getStubSettings()).listPrivateConnectionsSettings();
}
/** Returns the object with the settings used for calls to deletePrivateConnection. */
public UnaryCallSettings
deletePrivateConnectionSettings() {
return ((DatastreamStubSettings) getStubSettings()).deletePrivateConnectionSettings();
}
/** Returns the object with the settings used for calls to deletePrivateConnection. */
public OperationCallSettings
deletePrivateConnectionOperationSettings() {
return ((DatastreamStubSettings) getStubSettings()).deletePrivateConnectionOperationSettings();
}
/** Returns the object with the settings used for calls to createRoute. */
public UnaryCallSettings createRouteSettings() {
return ((DatastreamStubSettings) getStubSettings()).createRouteSettings();
}
/** Returns the object with the settings used for calls to createRoute. */
public OperationCallSettings
createRouteOperationSettings() {
return ((DatastreamStubSettings) getStubSettings()).createRouteOperationSettings();
}
/** Returns the object with the settings used for calls to getRoute. */
public UnaryCallSettings getRouteSettings() {
return ((DatastreamStubSettings) getStubSettings()).getRouteSettings();
}
/** Returns the object with the settings used for calls to listRoutes. */
public PagedCallSettings
listRoutesSettings() {
return ((DatastreamStubSettings) getStubSettings()).listRoutesSettings();
}
/** Returns the object with the settings used for calls to deleteRoute. */
public UnaryCallSettings deleteRouteSettings() {
return ((DatastreamStubSettings) getStubSettings()).deleteRouteSettings();
}
/** Returns the object with the settings used for calls to deleteRoute. */
public OperationCallSettings
deleteRouteOperationSettings() {
return ((DatastreamStubSettings) getStubSettings()).deleteRouteOperationSettings();
}
public static final DatastreamSettings create(DatastreamStubSettings stub) throws IOException {
return new DatastreamSettings.Builder(stub.toBuilder()).build();
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return DatastreamStubSettings.defaultExecutorProviderBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return DatastreamStubSettings.getDefaultEndpoint();
}
/** Returns the default service scopes. */
public static List getDefaultServiceScopes() {
return DatastreamStubSettings.getDefaultServiceScopes();
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return DatastreamStubSettings.defaultCredentialsProviderBuilder();
}
/** Returns a builder for the default gRPC ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return DatastreamStubSettings.defaultGrpcTransportProviderBuilder();
}
/** Returns a builder for the default REST ChannelProvider for this service. */
@BetaApi
public static InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder() {
return DatastreamStubSettings.defaultHttpJsonTransportProviderBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return DatastreamStubSettings.defaultTransportChannelProvider();
}
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return DatastreamStubSettings.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 DatastreamSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
}
/** Builder for DatastreamSettings. */
public static class Builder extends ClientSettings.Builder {
protected Builder() throws IOException {
this(((ClientContext) null));
}
protected Builder(ClientContext clientContext) {
super(DatastreamStubSettings.newBuilder(clientContext));
}
protected Builder(DatastreamSettings settings) {
super(settings.getStubSettings().toBuilder());
}
protected Builder(DatastreamStubSettings.Builder stubSettings) {
super(stubSettings);
}
private static Builder createDefault() {
return new Builder(DatastreamStubSettings.newBuilder());
}
private static Builder createHttpJsonDefault() {
return new Builder(DatastreamStubSettings.newHttpJsonBuilder());
}
public DatastreamStubSettings.Builder getStubSettingsBuilder() {
return ((DatastreamStubSettings.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 listConnectionProfiles. */
public PagedCallSettings.Builder<
ListConnectionProfilesRequest,
ListConnectionProfilesResponse,
ListConnectionProfilesPagedResponse>
listConnectionProfilesSettings() {
return getStubSettingsBuilder().listConnectionProfilesSettings();
}
/** Returns the builder for the settings used for calls to getConnectionProfile. */
public UnaryCallSettings.Builder
getConnectionProfileSettings() {
return getStubSettingsBuilder().getConnectionProfileSettings();
}
/** Returns the builder for the settings used for calls to createConnectionProfile. */
public UnaryCallSettings.Builder
createConnectionProfileSettings() {
return getStubSettingsBuilder().createConnectionProfileSettings();
}
/** Returns the builder for the settings used for calls to createConnectionProfile. */
public OperationCallSettings.Builder<
CreateConnectionProfileRequest, ConnectionProfile, OperationMetadata>
createConnectionProfileOperationSettings() {
return getStubSettingsBuilder().createConnectionProfileOperationSettings();
}
/** Returns the builder for the settings used for calls to updateConnectionProfile. */
public UnaryCallSettings.Builder
updateConnectionProfileSettings() {
return getStubSettingsBuilder().updateConnectionProfileSettings();
}
/** Returns the builder for the settings used for calls to updateConnectionProfile. */
public OperationCallSettings.Builder<
UpdateConnectionProfileRequest, ConnectionProfile, OperationMetadata>
updateConnectionProfileOperationSettings() {
return getStubSettingsBuilder().updateConnectionProfileOperationSettings();
}
/** Returns the builder for the settings used for calls to deleteConnectionProfile. */
public UnaryCallSettings.Builder
deleteConnectionProfileSettings() {
return getStubSettingsBuilder().deleteConnectionProfileSettings();
}
/** Returns the builder for the settings used for calls to deleteConnectionProfile. */
public OperationCallSettings.Builder
deleteConnectionProfileOperationSettings() {
return getStubSettingsBuilder().deleteConnectionProfileOperationSettings();
}
/** Returns the builder for the settings used for calls to discoverConnectionProfile. */
public UnaryCallSettings.Builder<
DiscoverConnectionProfileRequest, DiscoverConnectionProfileResponse>
discoverConnectionProfileSettings() {
return getStubSettingsBuilder().discoverConnectionProfileSettings();
}
/** Returns the builder for the settings used for calls to listStreams. */
public PagedCallSettings.Builder<
ListStreamsRequest, ListStreamsResponse, ListStreamsPagedResponse>
listStreamsSettings() {
return getStubSettingsBuilder().listStreamsSettings();
}
/** Returns the builder for the settings used for calls to getStream. */
public UnaryCallSettings.Builder getStreamSettings() {
return getStubSettingsBuilder().getStreamSettings();
}
/** Returns the builder for the settings used for calls to createStream. */
public UnaryCallSettings.Builder createStreamSettings() {
return getStubSettingsBuilder().createStreamSettings();
}
/** Returns the builder for the settings used for calls to createStream. */
public OperationCallSettings.Builder
createStreamOperationSettings() {
return getStubSettingsBuilder().createStreamOperationSettings();
}
/** Returns the builder for the settings used for calls to updateStream. */
public UnaryCallSettings.Builder updateStreamSettings() {
return getStubSettingsBuilder().updateStreamSettings();
}
/** Returns the builder for the settings used for calls to updateStream. */
public OperationCallSettings.Builder
updateStreamOperationSettings() {
return getStubSettingsBuilder().updateStreamOperationSettings();
}
/** Returns the builder for the settings used for calls to deleteStream. */
public UnaryCallSettings.Builder deleteStreamSettings() {
return getStubSettingsBuilder().deleteStreamSettings();
}
/** Returns the builder for the settings used for calls to deleteStream. */
public OperationCallSettings.Builder
deleteStreamOperationSettings() {
return getStubSettingsBuilder().deleteStreamOperationSettings();
}
/** Returns the builder for the settings used for calls to fetchErrors. */
public UnaryCallSettings.Builder fetchErrorsSettings() {
return getStubSettingsBuilder().fetchErrorsSettings();
}
/** Returns the builder for the settings used for calls to fetchErrors. */
public OperationCallSettings.Builder
fetchErrorsOperationSettings() {
return getStubSettingsBuilder().fetchErrorsOperationSettings();
}
/** Returns the builder for the settings used for calls to fetchStaticIps. */
public PagedCallSettings.Builder<
FetchStaticIpsRequest, FetchStaticIpsResponse, FetchStaticIpsPagedResponse>
fetchStaticIpsSettings() {
return getStubSettingsBuilder().fetchStaticIpsSettings();
}
/** Returns the builder for the settings used for calls to createPrivateConnection. */
public UnaryCallSettings.Builder
createPrivateConnectionSettings() {
return getStubSettingsBuilder().createPrivateConnectionSettings();
}
/** Returns the builder for the settings used for calls to createPrivateConnection. */
public OperationCallSettings.Builder<
CreatePrivateConnectionRequest, PrivateConnection, OperationMetadata>
createPrivateConnectionOperationSettings() {
return getStubSettingsBuilder().createPrivateConnectionOperationSettings();
}
/** Returns the builder for the settings used for calls to getPrivateConnection. */
public UnaryCallSettings.Builder
getPrivateConnectionSettings() {
return getStubSettingsBuilder().getPrivateConnectionSettings();
}
/** Returns the builder for the settings used for calls to listPrivateConnections. */
public PagedCallSettings.Builder<
ListPrivateConnectionsRequest,
ListPrivateConnectionsResponse,
ListPrivateConnectionsPagedResponse>
listPrivateConnectionsSettings() {
return getStubSettingsBuilder().listPrivateConnectionsSettings();
}
/** Returns the builder for the settings used for calls to deletePrivateConnection. */
public UnaryCallSettings.Builder
deletePrivateConnectionSettings() {
return getStubSettingsBuilder().deletePrivateConnectionSettings();
}
/** Returns the builder for the settings used for calls to deletePrivateConnection. */
public OperationCallSettings.Builder
deletePrivateConnectionOperationSettings() {
return getStubSettingsBuilder().deletePrivateConnectionOperationSettings();
}
/** Returns the builder for the settings used for calls to createRoute. */
public UnaryCallSettings.Builder createRouteSettings() {
return getStubSettingsBuilder().createRouteSettings();
}
/** Returns the builder for the settings used for calls to createRoute. */
public OperationCallSettings.Builder
createRouteOperationSettings() {
return getStubSettingsBuilder().createRouteOperationSettings();
}
/** Returns the builder for the settings used for calls to getRoute. */
public UnaryCallSettings.Builder getRouteSettings() {
return getStubSettingsBuilder().getRouteSettings();
}
/** Returns the builder for the settings used for calls to listRoutes. */
public PagedCallSettings.Builder
listRoutesSettings() {
return getStubSettingsBuilder().listRoutesSettings();
}
/** Returns the builder for the settings used for calls to deleteRoute. */
public UnaryCallSettings.Builder deleteRouteSettings() {
return getStubSettingsBuilder().deleteRouteSettings();
}
/** Returns the builder for the settings used for calls to deleteRoute. */
public OperationCallSettings.Builder
deleteRouteOperationSettings() {
return getStubSettingsBuilder().deleteRouteOperationSettings();
}
@Override
public DatastreamSettings build() throws IOException {
return new DatastreamSettings(this);
}
}
}