Package 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("by gapic-generator-java") public class SubscriberStubSettings extends com.google.api.gax.rpc.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: 


 // 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
 SubscriberStubSettings.Builder subscriptionAdminSettingsBuilder =
     SubscriberStubSettings.newBuilder();
 subscriptionAdminSettingsBuilder
     .createSubscriptionSettings()
     .setRetrySettings(
         subscriptionAdminSettingsBuilder
             .createSubscriptionSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 SubscriberStubSettings subscriptionAdminSettings = subscriptionAdminSettingsBuilder.build();

  • Constructor Details

  • Method Details

    • createSubscriptionSettings

      public com.google.api.gax.rpc.UnaryCallSettings<Subscription,Subscription> createSubscriptionSettings()
      Returns the object with the settings used for calls to createSubscription.

    • getSubscriptionSettings

      public com.google.api.gax.rpc.UnaryCallSettings<GetSubscriptionRequest,Subscription> getSubscriptionSettings()
      Returns the object with the settings used for calls to getSubscription.

    • updateSubscriptionSettings

      public com.google.api.gax.rpc.UnaryCallSettings<UpdateSubscriptionRequest,Subscription> updateSubscriptionSettings()
      Returns the object with the settings used for calls to updateSubscription.

    • listSubscriptionsSettings

      public com.google.api.gax.rpc.PagedCallSettings<ListSubscriptionsRequest,ListSubscriptionsResponse,SubscriptionAdminClient.ListSubscriptionsPagedResponse> listSubscriptionsSettings()
      Returns the object with the settings used for calls to listSubscriptions.

    • deleteSubscriptionSettings

      public com.google.api.gax.rpc.UnaryCallSettings<DeleteSubscriptionRequest,com.google.protobuf.Empty> deleteSubscriptionSettings()
      Returns the object with the settings used for calls to deleteSubscription.

    • modifyAckDeadlineSettings

      public com.google.api.gax.rpc.UnaryCallSettings<ModifyAckDeadlineRequest,com.google.protobuf.Empty> modifyAckDeadlineSettings()
      Returns the object with the settings used for calls to modifyAckDeadline.

    • acknowledgeSettings

      public com.google.api.gax.rpc.UnaryCallSettings<AcknowledgeRequest,com.google.protobuf.Empty> acknowledgeSettings()
      Returns the object with the settings used for calls to acknowledge.

    • pullSettings

      public com.google.api.gax.rpc.UnaryCallSettings<PullRequest,PullResponse> pullSettings()
      Returns the object with the settings used for calls to pull.

    • streamingPullSettings

      public com.google.api.gax.rpc.StreamingCallSettings<StreamingPullRequest,StreamingPullResponse> streamingPullSettings()
      Returns the object with the settings used for calls to streamingPull.

    • modifyPushConfigSettings

      public com.google.api.gax.rpc.UnaryCallSettings<ModifyPushConfigRequest,com.google.protobuf.Empty> modifyPushConfigSettings()
      Returns the object with the settings used for calls to modifyPushConfig.

    • getSnapshotSettings

      public com.google.api.gax.rpc.UnaryCallSettings<GetSnapshotRequest,Snapshot> getSnapshotSettings()
      Returns the object with the settings used for calls to getSnapshot.

    • listSnapshotsSettings

      public com.google.api.gax.rpc.PagedCallSettings<ListSnapshotsRequest,ListSnapshotsResponse,SubscriptionAdminClient.ListSnapshotsPagedResponse> listSnapshotsSettings()
      Returns the object with the settings used for calls to listSnapshots.

    • createSnapshotSettings

      public com.google.api.gax.rpc.UnaryCallSettings<CreateSnapshotRequest,Snapshot> createSnapshotSettings()
      Returns the object with the settings used for calls to createSnapshot.

    • updateSnapshotSettings

      public com.google.api.gax.rpc.UnaryCallSettings<UpdateSnapshotRequest,Snapshot> updateSnapshotSettings()
      Returns the object with the settings used for calls to updateSnapshot.

    • deleteSnapshotSettings

      public com.google.api.gax.rpc.UnaryCallSettings<DeleteSnapshotRequest,com.google.protobuf.Empty> deleteSnapshotSettings()
      Returns the object with the settings used for calls to deleteSnapshot.

    • seekSettings

      public com.google.api.gax.rpc.UnaryCallSettings<SeekRequest,SeekResponse> seekSettings()
      Returns the object with the settings used for calls to seek.

    • setIamPolicySettings

      public com.google.api.gax.rpc.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 com.google.api.gax.rpc.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 com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()
      Returns the object with the settings used for calls to testIamPermissions.

    • createStub

      public SubscriberStub createStub() throws IOException
      Throws:
      IOException

    • getEndpoint

      public String getEndpoint()
      Returns the endpoint set by the user or the the service's default endpoint.
      Overrides:
      getEndpoint in class com.google.api.gax.rpc.StubSettings<SubscriberStubSettings>

    • getServiceName

      public String getServiceName()
      Returns the default service name.
      Overrides:
      getServiceName in class com.google.api.gax.rpc.StubSettings<SubscriberStubSettings>

    • defaultExecutorProviderBuilder

      public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
      Returns a builder for the default ExecutorProvider for this service.

    • getDefaultEndpoint

      public static String getDefaultEndpoint()
      Returns the default service endpoint.

    • getDefaultMtlsEndpoint

      public static String getDefaultMtlsEndpoint()
      Returns the default mTLS service endpoint.

    • getDefaultServiceScopes

      public static List<String> getDefaultServiceScopes()
      Returns the default service scopes.

    • defaultCredentialsProviderBuilder

      public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
      Returns a builder for the default credentials for this service.

    • defaultGrpcTransportProviderBuilder

      public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
      Returns a builder for the default gRPC ChannelProvider for this service.

    • defaultHttpJsonTransportProviderBuilder

      @BetaApi public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
      Returns a builder for the default REST ChannelProvider for this service.

    • defaultTransportChannelProvider

      public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

    • defaultGrpcApiClientHeaderProviderBuilder

      @BetaApi("The surface for customizing headers is not stable yet and may change in the future.") public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()

    • defaultHttpJsonApiClientHeaderProviderBuilder

      @BetaApi("The surface for customizing headers is not stable yet and may change in the future.") public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()

    • defaultApiClientHeaderProviderBuilder

      public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

    • newBuilder

      public static SubscriberStubSettings.Builder newBuilder()
      Returns a new gRPC builder for this class.

    • newHttpJsonBuilder

      public static SubscriberStubSettings.Builder newHttpJsonBuilder()
      Returns a new REST builder for this class.

    • newBuilder

      public static SubscriberStubSettings.Builder newBuilder(com.google.api.gax.rpc.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 com.google.api.gax.rpc.StubSettings<SubscriberStubSettings>