com.google.cloud.pubsub.v1.SubscriptionAdminSettings Maven / Gradle / Ivy
Show all versions of google-cloud-pubsub 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.pubsub.v1;
import static com.google.cloud.pubsub.v1.SubscriptionAdminClient.ListSnapshotsPagedResponse;
import static com.google.cloud.pubsub.v1.SubscriptionAdminClient.ListSubscriptionsPagedResponse;
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.StreamingCallSettings;
import com.google.api.gax.rpc.TransportChannelProvider;
import com.google.api.gax.rpc.UnaryCallSettings;
import com.google.cloud.pubsub.v1.stub.SubscriberStubSettings;
import com.google.iam.v1.GetIamPolicyRequest;
import com.google.iam.v1.Policy;
import com.google.iam.v1.SetIamPolicyRequest;
import com.google.iam.v1.TestIamPermissionsRequest;
import com.google.iam.v1.TestIamPermissionsResponse;
import com.google.protobuf.Empty;
import com.google.pubsub.v1.AcknowledgeRequest;
import com.google.pubsub.v1.CreateSnapshotRequest;
import com.google.pubsub.v1.DeleteSnapshotRequest;
import com.google.pubsub.v1.DeleteSubscriptionRequest;
import com.google.pubsub.v1.GetSnapshotRequest;
import com.google.pubsub.v1.GetSubscriptionRequest;
import com.google.pubsub.v1.ListSnapshotsRequest;
import com.google.pubsub.v1.ListSnapshotsResponse;
import com.google.pubsub.v1.ListSubscriptionsRequest;
import com.google.pubsub.v1.ListSubscriptionsResponse;
import com.google.pubsub.v1.ModifyAckDeadlineRequest;
import com.google.pubsub.v1.ModifyPushConfigRequest;
import com.google.pubsub.v1.PullRequest;
import com.google.pubsub.v1.PullResponse;
import com.google.pubsub.v1.SeekRequest;
import com.google.pubsub.v1.SeekResponse;
import com.google.pubsub.v1.Snapshot;
import com.google.pubsub.v1.StreamingPullRequest;
import com.google.pubsub.v1.StreamingPullResponse;
import com.google.pubsub.v1.Subscription;
import com.google.pubsub.v1.UpdateSnapshotRequest;
import com.google.pubsub.v1.UpdateSubscriptionRequest;
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 SubscriptionAdminClient}.
*
* The default instance has everything set to sensible defaults:
*
*
* - The default service address (pubsub.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 createSubscription:
*
*
{@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
* SubscriptionAdminSettings.Builder subscriptionAdminSettingsBuilder =
* SubscriptionAdminSettings.newBuilder();
* subscriptionAdminSettingsBuilder
* .createSubscriptionSettings()
* .setRetrySettings(
* subscriptionAdminSettingsBuilder
* .createSubscriptionSettings()
* .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());
* SubscriptionAdminSettings subscriptionAdminSettings = subscriptionAdminSettingsBuilder.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 SubscriptionAdminSettings extends ClientSettings {
/** Returns the object with the settings used for calls to createSubscription. */
public UnaryCallSettings createSubscriptionSettings() {
return ((SubscriberStubSettings) getStubSettings()).createSubscriptionSettings();
}
/** Returns the object with the settings used for calls to getSubscription. */
public UnaryCallSettings getSubscriptionSettings() {
return ((SubscriberStubSettings) getStubSettings()).getSubscriptionSettings();
}
/** Returns the object with the settings used for calls to updateSubscription. */
public UnaryCallSettings updateSubscriptionSettings() {
return ((SubscriberStubSettings) getStubSettings()).updateSubscriptionSettings();
}
/** Returns the object with the settings used for calls to listSubscriptions. */
public PagedCallSettings<
ListSubscriptionsRequest, ListSubscriptionsResponse, ListSubscriptionsPagedResponse>
listSubscriptionsSettings() {
return ((SubscriberStubSettings) getStubSettings()).listSubscriptionsSettings();
}
/** Returns the object with the settings used for calls to deleteSubscription. */
public UnaryCallSettings deleteSubscriptionSettings() {
return ((SubscriberStubSettings) getStubSettings()).deleteSubscriptionSettings();
}
/** Returns the object with the settings used for calls to modifyAckDeadline. */
public UnaryCallSettings modifyAckDeadlineSettings() {
return ((SubscriberStubSettings) getStubSettings()).modifyAckDeadlineSettings();
}
/** Returns the object with the settings used for calls to acknowledge. */
public UnaryCallSettings acknowledgeSettings() {
return ((SubscriberStubSettings) getStubSettings()).acknowledgeSettings();
}
/** Returns the object with the settings used for calls to pull. */
public UnaryCallSettings pullSettings() {
return ((SubscriberStubSettings) getStubSettings()).pullSettings();
}
/** Returns the object with the settings used for calls to streamingPull. */
public StreamingCallSettings
streamingPullSettings() {
return ((SubscriberStubSettings) getStubSettings()).streamingPullSettings();
}
/** Returns the object with the settings used for calls to modifyPushConfig. */
public UnaryCallSettings modifyPushConfigSettings() {
return ((SubscriberStubSettings) getStubSettings()).modifyPushConfigSettings();
}
/** Returns the object with the settings used for calls to getSnapshot. */
public UnaryCallSettings getSnapshotSettings() {
return ((SubscriberStubSettings) getStubSettings()).getSnapshotSettings();
}
/** Returns the object with the settings used for calls to listSnapshots. */
public PagedCallSettings
listSnapshotsSettings() {
return ((SubscriberStubSettings) getStubSettings()).listSnapshotsSettings();
}
/** Returns the object with the settings used for calls to createSnapshot. */
public UnaryCallSettings createSnapshotSettings() {
return ((SubscriberStubSettings) getStubSettings()).createSnapshotSettings();
}
/** Returns the object with the settings used for calls to updateSnapshot. */
public UnaryCallSettings updateSnapshotSettings() {
return ((SubscriberStubSettings) getStubSettings()).updateSnapshotSettings();
}
/** Returns the object with the settings used for calls to deleteSnapshot. */
public UnaryCallSettings deleteSnapshotSettings() {
return ((SubscriberStubSettings) getStubSettings()).deleteSnapshotSettings();
}
/** Returns the object with the settings used for calls to seek. */
public UnaryCallSettings seekSettings() {
return ((SubscriberStubSettings) getStubSettings()).seekSettings();
}
/** Returns the object with the settings used for calls to setIamPolicy. */
public UnaryCallSettings setIamPolicySettings() {
return ((SubscriberStubSettings) getStubSettings()).setIamPolicySettings();
}
/** Returns the object with the settings used for calls to getIamPolicy. */
public UnaryCallSettings getIamPolicySettings() {
return ((SubscriberStubSettings) getStubSettings()).getIamPolicySettings();
}
/** Returns the object with the settings used for calls to testIamPermissions. */
public UnaryCallSettings
testIamPermissionsSettings() {
return ((SubscriberStubSettings) getStubSettings()).testIamPermissionsSettings();
}
public static final SubscriptionAdminSettings create(SubscriberStubSettings stub)
throws IOException {
return new SubscriptionAdminSettings.Builder(stub.toBuilder()).build();
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return SubscriberStubSettings.defaultExecutorProviderBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return SubscriberStubSettings.getDefaultEndpoint();
}
/** Returns the default service scopes. */
public static List getDefaultServiceScopes() {
return SubscriberStubSettings.getDefaultServiceScopes();
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return SubscriberStubSettings.defaultCredentialsProviderBuilder();
}
/** Returns a builder for the default gRPC ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return SubscriberStubSettings.defaultGrpcTransportProviderBuilder();
}
/** Returns a builder for the default REST ChannelProvider for this service. */
@BetaApi
public static InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder() {
return SubscriberStubSettings.defaultHttpJsonTransportProviderBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return SubscriberStubSettings.defaultTransportChannelProvider();
}
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return SubscriberStubSettings.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 SubscriptionAdminSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
}
/** Builder for SubscriptionAdminSettings. */
public static class Builder extends ClientSettings.Builder {
protected Builder() throws IOException {
this(((ClientContext) null));
}
protected Builder(ClientContext clientContext) {
super(SubscriberStubSettings.newBuilder(clientContext));
}
protected Builder(SubscriptionAdminSettings settings) {
super(settings.getStubSettings().toBuilder());
}
protected Builder(SubscriberStubSettings.Builder stubSettings) {
super(stubSettings);
}
private static Builder createDefault() {
return new Builder(SubscriberStubSettings.newBuilder());
}
private static Builder createHttpJsonDefault() {
return new Builder(SubscriberStubSettings.newHttpJsonBuilder());
}
public SubscriberStubSettings.Builder getStubSettingsBuilder() {
return ((SubscriberStubSettings.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 createSubscription. */
public UnaryCallSettings.Builder createSubscriptionSettings() {
return getStubSettingsBuilder().createSubscriptionSettings();
}
/** Returns the builder for the settings used for calls to getSubscription. */
public UnaryCallSettings.Builder
getSubscriptionSettings() {
return getStubSettingsBuilder().getSubscriptionSettings();
}
/** Returns the builder for the settings used for calls to updateSubscription. */
public UnaryCallSettings.Builder
updateSubscriptionSettings() {
return getStubSettingsBuilder().updateSubscriptionSettings();
}
/** Returns the builder for the settings used for calls to listSubscriptions. */
public PagedCallSettings.Builder<
ListSubscriptionsRequest, ListSubscriptionsResponse, ListSubscriptionsPagedResponse>
listSubscriptionsSettings() {
return getStubSettingsBuilder().listSubscriptionsSettings();
}
/** Returns the builder for the settings used for calls to deleteSubscription. */
public UnaryCallSettings.Builder
deleteSubscriptionSettings() {
return getStubSettingsBuilder().deleteSubscriptionSettings();
}
/** Returns the builder for the settings used for calls to modifyAckDeadline. */
public UnaryCallSettings.Builder modifyAckDeadlineSettings() {
return getStubSettingsBuilder().modifyAckDeadlineSettings();
}
/** Returns the builder for the settings used for calls to acknowledge. */
public UnaryCallSettings.Builder acknowledgeSettings() {
return getStubSettingsBuilder().acknowledgeSettings();
}
/** Returns the builder for the settings used for calls to pull. */
public UnaryCallSettings.Builder pullSettings() {
return getStubSettingsBuilder().pullSettings();
}
/** Returns the builder for the settings used for calls to streamingPull. */
public StreamingCallSettings.Builder
streamingPullSettings() {
return getStubSettingsBuilder().streamingPullSettings();
}
/** Returns the builder for the settings used for calls to modifyPushConfig. */
public UnaryCallSettings.Builder modifyPushConfigSettings() {
return getStubSettingsBuilder().modifyPushConfigSettings();
}
/** Returns the builder for the settings used for calls to getSnapshot. */
public UnaryCallSettings.Builder getSnapshotSettings() {
return getStubSettingsBuilder().getSnapshotSettings();
}
/** Returns the builder for the settings used for calls to listSnapshots. */
public PagedCallSettings.Builder<
ListSnapshotsRequest, ListSnapshotsResponse, ListSnapshotsPagedResponse>
listSnapshotsSettings() {
return getStubSettingsBuilder().listSnapshotsSettings();
}
/** Returns the builder for the settings used for calls to createSnapshot. */
public UnaryCallSettings.Builder createSnapshotSettings() {
return getStubSettingsBuilder().createSnapshotSettings();
}
/** Returns the builder for the settings used for calls to updateSnapshot. */
public UnaryCallSettings.Builder updateSnapshotSettings() {
return getStubSettingsBuilder().updateSnapshotSettings();
}
/** Returns the builder for the settings used for calls to deleteSnapshot. */
public UnaryCallSettings.Builder deleteSnapshotSettings() {
return getStubSettingsBuilder().deleteSnapshotSettings();
}
/** Returns the builder for the settings used for calls to seek. */
public UnaryCallSettings.Builder seekSettings() {
return getStubSettingsBuilder().seekSettings();
}
/** Returns the builder for the settings used for calls to setIamPolicy. */
public UnaryCallSettings.Builder setIamPolicySettings() {
return getStubSettingsBuilder().setIamPolicySettings();
}
/** Returns the builder for the settings used for calls to getIamPolicy. */
public UnaryCallSettings.Builder getIamPolicySettings() {
return getStubSettingsBuilder().getIamPolicySettings();
}
/** Returns the builder for the settings used for calls to testIamPermissions. */
public UnaryCallSettings.Builder
testIamPermissionsSettings() {
return getStubSettingsBuilder().testIamPermissionsSettings();
}
@Override
public SubscriptionAdminSettings build() throws IOException {
return new SubscriptionAdminSettings(this);
}
}
}