public class SubscriptionAdminSettings extends ClientSettings<SubscriptionAdminSettings>Settings class to configure an instance of 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 of createSubscription:
// 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 for additional support in setting retries.
Static Methods
create(SubscriberStubSettings stub)
public static final SubscriptionAdminSettings create(SubscriberStubSettings stub)| Parameter | |
|---|---|
| Name | Description |
stub |
SubscriberStubSettings |
| Returns | |
|---|---|
| Type | Description |
SubscriptionAdminSettings |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
defaultApiClientHeaderProviderBuilder()
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()Returns a builder for the default credentials for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()Returns a builder for the default ExecutorProvider for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()Returns a builder for the default gRPC ChannelProvider for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultHttpJsonTransportProviderBuilder()
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()| Returns | |
|---|---|
| Type | Description |
TransportChannelProvider |
|
getDefaultEndpoint()
public static String getDefaultEndpoint()Returns the default service endpoint.
| Returns | |
|---|---|
| Type | Description |
String |
|
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()Returns the default service scopes.
| Returns | |
|---|---|
| Type | Description |
List<String> |
|
newBuilder()
public static SubscriptionAdminSettings.Builder newBuilder()Returns a new gRPC builder for this class.
| Returns | |
|---|---|
| Type | Description |
SubscriptionAdminSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static SubscriptionAdminSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
SubscriptionAdminSettings.Builder |
|
newHttpJsonBuilder()
public static SubscriptionAdminSettings.Builder newHttpJsonBuilder()Returns a new REST builder for this class.
| Returns | |
|---|---|
| Type | Description |
SubscriptionAdminSettings.Builder |
|
Constructors
SubscriptionAdminSettings(SubscriptionAdminSettings.Builder settingsBuilder)
protected SubscriptionAdminSettings(SubscriptionAdminSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
SubscriptionAdminSettings.Builder |
Methods
acknowledgeSettings()
public UnaryCallSettings<AcknowledgeRequest,Empty> acknowledgeSettings()Returns the object with the settings used for calls to acknowledge.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<AcknowledgeRequest,Empty> |
|
createSnapshotSettings()
public UnaryCallSettings<CreateSnapshotRequest,Snapshot> createSnapshotSettings()Returns the object with the settings used for calls to createSnapshot.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateSnapshotRequest,Snapshot> |
|
createSubscriptionSettings()
public UnaryCallSettings<Subscription,Subscription> createSubscriptionSettings()Returns the object with the settings used for calls to createSubscription.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<Subscription,Subscription> |
|
deleteSnapshotSettings()
public UnaryCallSettings<DeleteSnapshotRequest,Empty> deleteSnapshotSettings()Returns the object with the settings used for calls to deleteSnapshot.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteSnapshotRequest,Empty> |
|
deleteSubscriptionSettings()
public UnaryCallSettings<DeleteSubscriptionRequest,Empty> deleteSubscriptionSettings()Returns the object with the settings used for calls to deleteSubscription.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteSubscriptionRequest,Empty> |
|
getIamPolicySettings()
public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()Returns the object with the settings used for calls to getIamPolicy.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
|
getSnapshotSettings()
public UnaryCallSettings<GetSnapshotRequest,Snapshot> getSnapshotSettings()Returns the object with the settings used for calls to getSnapshot.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetSnapshotRequest,Snapshot> |
|
getSubscriptionSettings()
public UnaryCallSettings<GetSubscriptionRequest,Subscription> getSubscriptionSettings()Returns the object with the settings used for calls to getSubscription.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetSubscriptionRequest,Subscription> |
|
listSnapshotsSettings()
public PagedCallSettings<ListSnapshotsRequest,ListSnapshotsResponse,SubscriptionAdminClient.ListSnapshotsPagedResponse> listSnapshotsSettings()Returns the object with the settings used for calls to listSnapshots.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListSnapshotsRequest,ListSnapshotsResponse,ListSnapshotsPagedResponse> |
|
listSubscriptionsSettings()
public PagedCallSettings<ListSubscriptionsRequest,ListSubscriptionsResponse,SubscriptionAdminClient.ListSubscriptionsPagedResponse> listSubscriptionsSettings()Returns the object with the settings used for calls to listSubscriptions.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListSubscriptionsRequest,ListSubscriptionsResponse,ListSubscriptionsPagedResponse> |
|
modifyAckDeadlineSettings()
public UnaryCallSettings<ModifyAckDeadlineRequest,Empty> modifyAckDeadlineSettings()Returns the object with the settings used for calls to modifyAckDeadline.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<ModifyAckDeadlineRequest,Empty> |
|
modifyPushConfigSettings()
public UnaryCallSettings<ModifyPushConfigRequest,Empty> modifyPushConfigSettings()Returns the object with the settings used for calls to modifyPushConfig.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<ModifyPushConfigRequest,Empty> |
|
pullSettings()
public UnaryCallSettings<PullRequest,PullResponse> pullSettings()Returns the object with the settings used for calls to pull.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<PullRequest,PullResponse> |
|
seekSettings()
public UnaryCallSettings<SeekRequest,SeekResponse> seekSettings()Returns the object with the settings used for calls to seek.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<SeekRequest,SeekResponse> |
|
setIamPolicySettings()
public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()Returns the object with the settings used for calls to setIamPolicy.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
|
streamingPullSettings()
public StreamingCallSettings<StreamingPullRequest,StreamingPullResponse> streamingPullSettings()Returns the object with the settings used for calls to streamingPull.
| Returns | |
|---|---|
| Type | Description |
StreamingCallSettings<StreamingPullRequest,StreamingPullResponse> |
|
testIamPermissionsSettings()
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
|
toBuilder()
public SubscriptionAdminSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
SubscriptionAdminSettings.Builder |
|
updateSnapshotSettings()
public UnaryCallSettings<UpdateSnapshotRequest,Snapshot> updateSnapshotSettings()Returns the object with the settings used for calls to updateSnapshot.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateSnapshotRequest,Snapshot> |
|
updateSubscriptionSettings()
public UnaryCallSettings<UpdateSubscriptionRequest,Subscription> updateSubscriptionSettings()Returns the object with the settings used for calls to updateSubscription.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateSubscriptionRequest,Subscription> |
|