Class AdminServiceSettings (1.12.22)

public class AdminServiceSettings extends ClientSettings<AdminServiceSettings>

Settings class to configure an instance of AdminServiceClient.

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 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
 AdminServiceSettings.Builder adminServiceSettingsBuilder = AdminServiceSettings.newBuilder();
 adminServiceSettingsBuilder
     .createTopicSettings()
     .setRetrySettings(
         adminServiceSettingsBuilder
             .createTopicSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 AdminServiceSettings adminServiceSettings = adminServiceSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > AdminServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getUniverseDomain()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(AdminServiceStubSettings stub)

public static final AdminServiceSettings create(AdminServiceStubSettings stub)

Parameter
Name	Description
`stub`	`AdminServiceStubSettings`

Returns
Type	Description
`AdminServiceSettings`

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 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 AdminServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type	Description
`AdminServiceSettings.Builder`

newBuilder(ClientContext clientContext)

public static AdminServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`AdminServiceSettings.Builder`

Constructors

AdminServiceSettings(AdminServiceSettings.Builder settingsBuilder)

protected AdminServiceSettings(AdminServiceSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`AdminServiceSettings.Builder`

Methods

createReservationSettings()

public UnaryCallSettings<CreateReservationRequest,Reservation> createReservationSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateReservationRequest,Reservation>`

createSubscriptionSettings()

public UnaryCallSettings<CreateSubscriptionRequest,Subscription> createSubscriptionSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateSubscriptionRequest,Subscription>`

createTopicSettings()

public UnaryCallSettings<CreateTopicRequest,Topic> createTopicSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateTopicRequest,Topic>`

deleteReservationSettings()

public UnaryCallSettings<DeleteReservationRequest,Empty> deleteReservationSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteReservationRequest,Empty>`

deleteSubscriptionSettings()

public UnaryCallSettings<DeleteSubscriptionRequest,Empty> deleteSubscriptionSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteSubscriptionRequest,Empty>`

deleteTopicSettings()

public UnaryCallSettings<DeleteTopicRequest,Empty> deleteTopicSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteTopicRequest,Empty>`

getReservationSettings()

public UnaryCallSettings<GetReservationRequest,Reservation> getReservationSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetReservationRequest,Reservation>`

getSubscriptionSettings()

public UnaryCallSettings<GetSubscriptionRequest,Subscription> getSubscriptionSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetSubscriptionRequest,Subscription>`

getTopicPartitionsSettings()

public UnaryCallSettings<GetTopicPartitionsRequest,TopicPartitions> getTopicPartitionsSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetTopicPartitionsRequest,TopicPartitions>`

getTopicSettings()

public UnaryCallSettings<GetTopicRequest,Topic> getTopicSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetTopicRequest,Topic>`

listReservationTopicsSettings()

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

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

Returns
Type	Description
`PagedCallSettings<ListReservationTopicsRequest,ListReservationTopicsResponse,ListReservationTopicsPagedResponse>`

listReservationsSettings()

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

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

Returns
Type	Description
`PagedCallSettings<ListReservationsRequest,ListReservationsResponse,ListReservationsPagedResponse>`

listSubscriptionsSettings()

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

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

Returns
Type	Description
`PagedCallSettings<ListSubscriptionsRequest,ListSubscriptionsResponse,ListSubscriptionsPagedResponse>`

listTopicSubscriptionsSettings()

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

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

Returns
Type	Description
`PagedCallSettings<ListTopicSubscriptionsRequest,ListTopicSubscriptionsResponse,ListTopicSubscriptionsPagedResponse>`

listTopicsSettings()

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

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

Returns
Type	Description
`PagedCallSettings<ListTopicsRequest,ListTopicsResponse,ListTopicsPagedResponse>`

seekSubscriptionOperationSettings()

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

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

Returns
Type	Description
`OperationCallSettings<SeekSubscriptionRequest,SeekSubscriptionResponse,OperationMetadata>`

seekSubscriptionSettings()

public UnaryCallSettings<SeekSubscriptionRequest,Operation> seekSubscriptionSettings()

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

Returns
Type	Description
`UnaryCallSettings<SeekSubscriptionRequest,Operation>`

toBuilder()

public AdminServiceSettings.Builder toBuilder()

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

Returns
Type	Description
`AdminServiceSettings.Builder`

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateReservationSettings()

public UnaryCallSettings<UpdateReservationRequest,Reservation> updateReservationSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateReservationRequest,Reservation>`

updateSubscriptionSettings()

public UnaryCallSettings<UpdateSubscriptionRequest,Subscription> updateSubscriptionSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateSubscriptionRequest,Subscription>`

updateTopicSettings()

public UnaryCallSettings<UpdateTopicRequest,Topic> updateTopicSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateTopicRequest,Topic>`