Class AdminServiceStubSettings (1.6.3)

Stay organized with collections Save and categorize content based on your preferences.
public class AdminServiceStubSettings extends StubSettings<AdminServiceStubSettings>

Settings class to configure an instance of AdminServiceStub.

The default instance has everything set to sensible defaults:

  • The default service address (pubsublite.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:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 AdminServiceStubSettings.Builder adminServiceSettingsBuilder =
     AdminServiceStubSettings.newBuilder();
 adminServiceSettingsBuilder
     .createTopicSettings()
     .setRetrySettings(
         adminServiceSettingsBuilder
             .createTopicSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 AdminServiceStubSettings adminServiceSettings = adminServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > AdminServiceStubSettings

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static AdminServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
AdminServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static AdminServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
AdminServiceStubSettings.Builder

Constructors

AdminServiceStubSettings(AdminServiceStubSettings.Builder settingsBuilder)

protected AdminServiceStubSettings(AdminServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderAdminServiceStubSettings.Builder

Methods

createReservationSettings()

public UnaryCallSettings<CreateReservationRequest,Reservation> createReservationSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateReservationRequest,Reservation>

createStub()

public AdminServiceStub createStub()
Returns
TypeDescription
AdminServiceStub
Exceptions
TypeDescription
IOException

createSubscriptionSettings()

public UnaryCallSettings<CreateSubscriptionRequest,Subscription> createSubscriptionSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateSubscriptionRequest,Subscription>

createTopicSettings()

public UnaryCallSettings<CreateTopicRequest,Topic> createTopicSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateTopicRequest,Topic>

deleteReservationSettings()

public UnaryCallSettings<DeleteReservationRequest,Empty> deleteReservationSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteReservationRequest,Empty>

deleteSubscriptionSettings()

public UnaryCallSettings<DeleteSubscriptionRequest,Empty> deleteSubscriptionSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteSubscriptionRequest,Empty>

deleteTopicSettings()

public UnaryCallSettings<DeleteTopicRequest,Empty> deleteTopicSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteTopicRequest,Empty>

getReservationSettings()

public UnaryCallSettings<GetReservationRequest,Reservation> getReservationSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetReservationRequest,Reservation>

getSubscriptionSettings()

public UnaryCallSettings<GetSubscriptionRequest,Subscription> getSubscriptionSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetSubscriptionRequest,Subscription>

getTopicPartitionsSettings()

public UnaryCallSettings<GetTopicPartitionsRequest,TopicPartitions> getTopicPartitionsSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetTopicPartitionsRequest,TopicPartitions>

getTopicSettings()

public UnaryCallSettings<GetTopicRequest,Topic> getTopicSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetTopicRequest,Topic>

listReservationTopicsSettings()

public PagedCallSettings<ListReservationTopicsRequest,ListReservationTopicsResponse,AdminServiceClient.ListReservationTopicsPagedResponse> listReservationTopicsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListReservationTopicsRequest,ListReservationTopicsResponse,ListReservationTopicsPagedResponse>

listReservationsSettings()

public PagedCallSettings<ListReservationsRequest,ListReservationsResponse,AdminServiceClient.ListReservationsPagedResponse> listReservationsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListReservationsRequest,ListReservationsResponse,ListReservationsPagedResponse>

listSubscriptionsSettings()

public PagedCallSettings<ListSubscriptionsRequest,ListSubscriptionsResponse,AdminServiceClient.ListSubscriptionsPagedResponse> listSubscriptionsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListSubscriptionsRequest,ListSubscriptionsResponse,ListSubscriptionsPagedResponse>

listTopicSubscriptionsSettings()

public PagedCallSettings<ListTopicSubscriptionsRequest,ListTopicSubscriptionsResponse,AdminServiceClient.ListTopicSubscriptionsPagedResponse> listTopicSubscriptionsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListTopicSubscriptionsRequest,ListTopicSubscriptionsResponse,ListTopicSubscriptionsPagedResponse>

listTopicsSettings()

public PagedCallSettings<ListTopicsRequest,ListTopicsResponse,AdminServiceClient.ListTopicsPagedResponse> listTopicsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListTopicsRequest,ListTopicsResponse,ListTopicsPagedResponse>

seekSubscriptionOperationSettings()

public OperationCallSettings<SeekSubscriptionRequest,SeekSubscriptionResponse,OperationMetadata> seekSubscriptionOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<SeekSubscriptionRequest,SeekSubscriptionResponse,OperationMetadata>

seekSubscriptionSettings()

public UnaryCallSettings<SeekSubscriptionRequest,Operation> seekSubscriptionSettings()

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

Returns
TypeDescription
UnaryCallSettings<SeekSubscriptionRequest,Operation>

toBuilder()

public AdminServiceStubSettings.Builder toBuilder()

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

Returns
TypeDescription
AdminServiceStubSettings.Builder
Overrides

updateReservationSettings()

public UnaryCallSettings<UpdateReservationRequest,Reservation> updateReservationSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateReservationRequest,Reservation>

updateSubscriptionSettings()

public UnaryCallSettings<UpdateSubscriptionRequest,Subscription> updateSubscriptionSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateSubscriptionRequest,Subscription>

updateTopicSettings()

public UnaryCallSettings<UpdateTopicRequest,Topic> updateTopicSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateTopicRequest,Topic>