com.google.cloud.pubsub.v1.TopicAdminSettings Maven / Gradle / Ivy
/*
* Copyright 2019 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.TopicAdminClient.ListTopicSubscriptionsPagedResponse;
import static com.google.cloud.pubsub.v1.TopicAdminClient.ListTopicsPagedResponse;
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.BatchingCallSettings;
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.TransportChannelProvider;
import com.google.api.gax.rpc.UnaryCallSettings;
import com.google.cloud.pubsub.v1.stub.PublisherStubSettings;
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.DeleteTopicRequest;
import com.google.pubsub.v1.GetTopicRequest;
import com.google.pubsub.v1.ListTopicSubscriptionsRequest;
import com.google.pubsub.v1.ListTopicSubscriptionsResponse;
import com.google.pubsub.v1.ListTopicsRequest;
import com.google.pubsub.v1.ListTopicsResponse;
import com.google.pubsub.v1.PublishRequest;
import com.google.pubsub.v1.PublishResponse;
import com.google.pubsub.v1.Topic;
import com.google.pubsub.v1.UpdateTopicRequest;
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 TopicAdminClient}.
*
* 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 total timeout of createTopic to 30 seconds:
*
*
*
* TopicAdminSettings.Builder topicAdminSettingsBuilder =
* TopicAdminSettings.newBuilder();
* topicAdminSettingsBuilder.createTopicSettings().getRetrySettings().toBuilder()
* .setTotalTimeout(Duration.ofSeconds(30));
* TopicAdminSettings topicAdminSettings = topicAdminSettingsBuilder.build();
*
*
*/
@Generated("by gapic-generator")
public class TopicAdminSettings extends ClientSettings {
/** Returns the object with the settings used for calls to createTopic. */
public UnaryCallSettings createTopicSettings() {
return ((PublisherStubSettings) getStubSettings()).createTopicSettings();
}
/** Returns the object with the settings used for calls to updateTopic. */
public UnaryCallSettings updateTopicSettings() {
return ((PublisherStubSettings) getStubSettings()).updateTopicSettings();
}
/** Returns the object with the settings used for calls to publish. */
/* package-private */ BatchingCallSettings publishSettings() {
return ((PublisherStubSettings) getStubSettings()).publishSettings();
}
/** Returns the object with the settings used for calls to getTopic. */
public UnaryCallSettings getTopicSettings() {
return ((PublisherStubSettings) getStubSettings()).getTopicSettings();
}
/** Returns the object with the settings used for calls to listTopics. */
public PagedCallSettings
listTopicsSettings() {
return ((PublisherStubSettings) getStubSettings()).listTopicsSettings();
}
/** Returns the object with the settings used for calls to listTopicSubscriptions. */
public PagedCallSettings<
ListTopicSubscriptionsRequest,
ListTopicSubscriptionsResponse,
ListTopicSubscriptionsPagedResponse>
listTopicSubscriptionsSettings() {
return ((PublisherStubSettings) getStubSettings()).listTopicSubscriptionsSettings();
}
/** Returns the object with the settings used for calls to deleteTopic. */
public UnaryCallSettings deleteTopicSettings() {
return ((PublisherStubSettings) getStubSettings()).deleteTopicSettings();
}
/** Returns the object with the settings used for calls to setIamPolicy. */
public UnaryCallSettings setIamPolicySettings() {
return ((PublisherStubSettings) getStubSettings()).setIamPolicySettings();
}
/** Returns the object with the settings used for calls to getIamPolicy. */
public UnaryCallSettings getIamPolicySettings() {
return ((PublisherStubSettings) getStubSettings()).getIamPolicySettings();
}
/** Returns the object with the settings used for calls to testIamPermissions. */
public UnaryCallSettings
testIamPermissionsSettings() {
return ((PublisherStubSettings) getStubSettings()).testIamPermissionsSettings();
}
public static final TopicAdminSettings create(PublisherStubSettings stub) throws IOException {
return new TopicAdminSettings.Builder(stub.toBuilder()).build();
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return PublisherStubSettings.defaultExecutorProviderBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return PublisherStubSettings.getDefaultEndpoint();
}
/** Returns the default service scopes. */
public static List getDefaultServiceScopes() {
return PublisherStubSettings.getDefaultServiceScopes();
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return PublisherStubSettings.defaultCredentialsProviderBuilder();
}
/** Returns a builder for the default ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return PublisherStubSettings.defaultGrpcTransportProviderBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return PublisherStubSettings.defaultTransportChannelProvider();
}
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return PublisherStubSettings.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 TopicAdminSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
}
/** Builder for TopicAdminSettings. */
public static class Builder extends ClientSettings.Builder {
protected Builder() throws IOException {
this((ClientContext) null);
}
protected Builder(ClientContext clientContext) {
super(PublisherStubSettings.newBuilder(clientContext));
}
private static Builder createDefault() {
return new Builder(PublisherStubSettings.newBuilder());
}
protected Builder(TopicAdminSettings settings) {
super(settings.getStubSettings().toBuilder());
}
protected Builder(PublisherStubSettings.Builder stubSettings) {
super(stubSettings);
}
public PublisherStubSettings.Builder getStubSettingsBuilder() {
return ((PublisherStubSettings.Builder) getStubSettings());
}
// NEXT_MAJOR_VER: remove 'throws Exception'
/**
* 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) throws Exception {
super.applyToAllUnaryMethods(
getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater);
return this;
}
/** Returns the builder for the settings used for calls to createTopic. */
public UnaryCallSettings.Builder createTopicSettings() {
return getStubSettingsBuilder().createTopicSettings();
}
/** Returns the builder for the settings used for calls to updateTopic. */
public UnaryCallSettings.Builder updateTopicSettings() {
return getStubSettingsBuilder().updateTopicSettings();
}
/** Returns the builder for the settings used for calls to publish. */
/* package-private */ BatchingCallSettings.Builder
publishSettings() {
return getStubSettingsBuilder().publishSettings();
}
/** Returns the builder for the settings used for calls to getTopic. */
public UnaryCallSettings.Builder getTopicSettings() {
return getStubSettingsBuilder().getTopicSettings();
}
/** Returns the builder for the settings used for calls to listTopics. */
public PagedCallSettings.Builder
listTopicsSettings() {
return getStubSettingsBuilder().listTopicsSettings();
}
/** Returns the builder for the settings used for calls to listTopicSubscriptions. */
public PagedCallSettings.Builder<
ListTopicSubscriptionsRequest,
ListTopicSubscriptionsResponse,
ListTopicSubscriptionsPagedResponse>
listTopicSubscriptionsSettings() {
return getStubSettingsBuilder().listTopicSubscriptionsSettings();
}
/** Returns the builder for the settings used for calls to deleteTopic. */
public UnaryCallSettings.Builder deleteTopicSettings() {
return getStubSettingsBuilder().deleteTopicSettings();
}
/** 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 TopicAdminSettings build() throws IOException {
return new TopicAdminSettings(this);
}
}
}