com.google.cloud.pubsub.v1.stub

Class SubscriberStubSettings

java.lang.Object

com.google.api.gax.rpc.StubSettings<SubscriberStubSettings>

com.google.cloud.pubsub.v1.stub.SubscriberStubSettings

@Generated(value="by gapic-generator")
public class SubscriberStubSettings
extends StubSettings<SubscriberStubSettings>

Settings class to configure an instance of SubscriberStub.

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 createSubscription to 30 seconds:

 
 SubscriberStubSettings.Builder subscriptionAdminSettingsBuilder =
     SubscriberStubSettings.newBuilder();
 subscriptionAdminSettingsBuilder.createSubscriptionSettings().getRetrySettings().toBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 SubscriberStubSettings subscriptionAdminSettings = subscriptionAdminSettingsBuilder.build();
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubscriberStubSettings.Builder Builder for SubscriberStubSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SubscriberStubSettings(SubscriberStubSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
UnaryCallSettings<com.google.pubsub.v1.AcknowledgeRequest,Empty>	acknowledgeSettings() Returns the object with the settings used for calls to acknowledge.
UnaryCallSettings<com.google.pubsub.v1.CreateSnapshotRequest,com.google.pubsub.v1.Snapshot>	createSnapshotSettings() Returns the object with the settings used for calls to createSnapshot.
SubscriberStub	createStub()
UnaryCallSettings<com.google.pubsub.v1.Subscription,com.google.pubsub.v1.Subscription>	createSubscriptionSettings() Returns the object with the settings used for calls to createSubscription.
static ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
UnaryCallSettings<com.google.pubsub.v1.DeleteSnapshotRequest,Empty>	deleteSnapshotSettings() Returns the object with the settings used for calls to deleteSnapshot.
UnaryCallSettings<com.google.pubsub.v1.DeleteSubscriptionRequest,Empty>	deleteSubscriptionSettings() Returns the object with the settings used for calls to deleteSubscription.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
UnaryCallSettings<com.google.pubsub.v1.GetSubscriptionRequest,com.google.pubsub.v1.Subscription>	getSubscriptionSettings() Returns the object with the settings used for calls to getSubscription.
PagedCallSettings<com.google.pubsub.v1.ListSnapshotsRequest,com.google.pubsub.v1.ListSnapshotsResponse,SubscriptionAdminClient.ListSnapshotsPagedResponse>	listSnapshotsSettings() Returns the object with the settings used for calls to listSnapshots.
PagedCallSettings<com.google.pubsub.v1.ListSubscriptionsRequest,com.google.pubsub.v1.ListSubscriptionsResponse,SubscriptionAdminClient.ListSubscriptionsPagedResponse>	listSubscriptionsSettings() Returns the object with the settings used for calls to listSubscriptions.
UnaryCallSettings<com.google.pubsub.v1.ModifyAckDeadlineRequest,Empty>	modifyAckDeadlineSettings() Returns the object with the settings used for calls to modifyAckDeadline.
UnaryCallSettings<com.google.pubsub.v1.ModifyPushConfigRequest,Empty>	modifyPushConfigSettings() Returns the object with the settings used for calls to modifyPushConfig.
static SubscriberStubSettings.Builder	newBuilder() Returns a new builder for this class.
static SubscriberStubSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
UnaryCallSettings<com.google.pubsub.v1.PullRequest,com.google.pubsub.v1.PullResponse>	pullSettings() Returns the object with the settings used for calls to pull.
UnaryCallSettings<com.google.pubsub.v1.SeekRequest,com.google.pubsub.v1.SeekResponse>	seekSettings() Returns the object with the settings used for calls to seek.
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicySettings() Returns the object with the settings used for calls to setIamPolicy.
StreamingCallSettings<com.google.pubsub.v1.StreamingPullRequest,com.google.pubsub.v1.StreamingPullResponse>	streamingPullSettings() Returns the object with the settings used for calls to streamingPull.
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsSettings() Returns the object with the settings used for calls to testIamPermissions.
SubscriberStubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
UnaryCallSettings<com.google.pubsub.v1.UpdateSnapshotRequest,com.google.pubsub.v1.Snapshot>	updateSnapshotSettings() Returns the object with the settings used for calls to updateSnapshot.
UnaryCallSettings<com.google.pubsub.v1.UpdateSubscriptionRequest,com.google.pubsub.v1.Subscription>	updateSubscriptionSettings() Returns the object with the settings used for calls to updateSubscription.

Methods inherited from class com.google.api.gax.rpc.StubSettings

getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getStreamWatchdogCheckInterval, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SubscriberStubSettings

protected SubscriberStubSettings(SubscriberStubSettings.Builder settingsBuilder)
                          throws IOException

Throws:

IOException

Method Detail

createSubscriptionSettings

public UnaryCallSettings<com.google.pubsub.v1.Subscription,com.google.pubsub.v1.Subscription> createSubscriptionSettings()

Returns the object with the settings used for calls to createSubscription.

getSubscriptionSettings

public UnaryCallSettings<com.google.pubsub.v1.GetSubscriptionRequest,com.google.pubsub.v1.Subscription> getSubscriptionSettings()

Returns the object with the settings used for calls to getSubscription.

updateSubscriptionSettings

public UnaryCallSettings<com.google.pubsub.v1.UpdateSubscriptionRequest,com.google.pubsub.v1.Subscription> updateSubscriptionSettings()

Returns the object with the settings used for calls to updateSubscription.

listSubscriptionsSettings

public PagedCallSettings<com.google.pubsub.v1.ListSubscriptionsRequest,com.google.pubsub.v1.ListSubscriptionsResponse,SubscriptionAdminClient.ListSubscriptionsPagedResponse> listSubscriptionsSettings()

Returns the object with the settings used for calls to listSubscriptions.

deleteSubscriptionSettings

public UnaryCallSettings<com.google.pubsub.v1.DeleteSubscriptionRequest,Empty> deleteSubscriptionSettings()

Returns the object with the settings used for calls to deleteSubscription.

modifyAckDeadlineSettings

public UnaryCallSettings<com.google.pubsub.v1.ModifyAckDeadlineRequest,Empty> modifyAckDeadlineSettings()

Returns the object with the settings used for calls to modifyAckDeadline.

acknowledgeSettings

public UnaryCallSettings<com.google.pubsub.v1.AcknowledgeRequest,Empty> acknowledgeSettings()

Returns the object with the settings used for calls to acknowledge.

pullSettings

public UnaryCallSettings<com.google.pubsub.v1.PullRequest,com.google.pubsub.v1.PullResponse> pullSettings()

Returns the object with the settings used for calls to pull.

streamingPullSettings

public StreamingCallSettings<com.google.pubsub.v1.StreamingPullRequest,com.google.pubsub.v1.StreamingPullResponse> streamingPullSettings()

Returns the object with the settings used for calls to streamingPull.

modifyPushConfigSettings

public UnaryCallSettings<com.google.pubsub.v1.ModifyPushConfigRequest,Empty> modifyPushConfigSettings()

Returns the object with the settings used for calls to modifyPushConfig.

listSnapshotsSettings

public PagedCallSettings<com.google.pubsub.v1.ListSnapshotsRequest,com.google.pubsub.v1.ListSnapshotsResponse,SubscriptionAdminClient.ListSnapshotsPagedResponse> listSnapshotsSettings()

Returns the object with the settings used for calls to listSnapshots.

createSnapshotSettings

public UnaryCallSettings<com.google.pubsub.v1.CreateSnapshotRequest,com.google.pubsub.v1.Snapshot> createSnapshotSettings()

Returns the object with the settings used for calls to createSnapshot.

updateSnapshotSettings

public UnaryCallSettings<com.google.pubsub.v1.UpdateSnapshotRequest,com.google.pubsub.v1.Snapshot> updateSnapshotSettings()

Returns the object with the settings used for calls to updateSnapshot.

deleteSnapshotSettings

public UnaryCallSettings<com.google.pubsub.v1.DeleteSnapshotRequest,Empty> deleteSnapshotSettings()

Returns the object with the settings used for calls to deleteSnapshot.

seekSettings

public UnaryCallSettings<com.google.pubsub.v1.SeekRequest,com.google.pubsub.v1.SeekResponse> seekSettings()

Returns the object with the settings used for calls to seek.

setIamPolicySettings

public UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()

Returns the object with the settings used for calls to setIamPolicy.

getIamPolicySettings

public UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()

Returns the object with the settings used for calls to getIamPolicy.

testIamPermissionsSettings

public UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()

Returns the object with the settings used for calls to testIamPermissions.

createStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public SubscriberStub createStub()
                                                                                                                        throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static SubscriberStubSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static SubscriberStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public SubscriberStubSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Specified by:

toBuilder in class StubSettings<SubscriberStubSettings>