com.google.cloud.pubsublite.v1

Class AdminServiceSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<AdminServiceSettings>

com.google.cloud.pubsublite.v1.AdminServiceSettings

@Generated(value="by gapic-generator-java")
public class AdminServiceSettings
extends com.google.api.gax.rpc.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();
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static AdminServiceSettings	create(AdminServiceStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<CreateReservationRequest,Reservation>	createReservationSettings() Returns the object with the settings used for calls to createReservation.
com.google.api.gax.rpc.UnaryCallSettings<CreateSubscriptionRequest,Subscription>	createSubscriptionSettings() Returns the object with the settings used for calls to createSubscription.
com.google.api.gax.rpc.UnaryCallSettings<CreateTopicRequest,Topic>	createTopicSettings() Returns the object with the settings used for calls to createTopic.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<DeleteReservationRequest,com.google.protobuf.Empty>	deleteReservationSettings() Returns the object with the settings used for calls to deleteReservation.
com.google.api.gax.rpc.UnaryCallSettings<DeleteSubscriptionRequest,com.google.protobuf.Empty>	deleteSubscriptionSettings() Returns the object with the settings used for calls to deleteSubscription.
com.google.api.gax.rpc.UnaryCallSettings<DeleteTopicRequest,com.google.protobuf.Empty>	deleteTopicSettings() Returns the object with the settings used for calls to deleteTopic.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetReservationRequest,Reservation>	getReservationSettings() Returns the object with the settings used for calls to getReservation.
com.google.api.gax.rpc.UnaryCallSettings<GetSubscriptionRequest,Subscription>	getSubscriptionSettings() Returns the object with the settings used for calls to getSubscription.
com.google.api.gax.rpc.UnaryCallSettings<GetTopicPartitionsRequest,TopicPartitions>	getTopicPartitionsSettings() Returns the object with the settings used for calls to getTopicPartitions.
com.google.api.gax.rpc.UnaryCallSettings<GetTopicRequest,Topic>	getTopicSettings() Returns the object with the settings used for calls to getTopic.
com.google.api.gax.rpc.PagedCallSettings<ListReservationsRequest,ListReservationsResponse,AdminServiceClient.ListReservationsPagedResponse>	listReservationsSettings() Returns the object with the settings used for calls to listReservations.
com.google.api.gax.rpc.PagedCallSettings<ListReservationTopicsRequest,ListReservationTopicsResponse,AdminServiceClient.ListReservationTopicsPagedResponse>	listReservationTopicsSettings() Returns the object with the settings used for calls to listReservationTopics.
com.google.api.gax.rpc.PagedCallSettings<ListSubscriptionsRequest,ListSubscriptionsResponse,AdminServiceClient.ListSubscriptionsPagedResponse>	listSubscriptionsSettings() Returns the object with the settings used for calls to listSubscriptions.
com.google.api.gax.rpc.PagedCallSettings<ListTopicsRequest,ListTopicsResponse,AdminServiceClient.ListTopicsPagedResponse>	listTopicsSettings() Returns the object with the settings used for calls to listTopics.
com.google.api.gax.rpc.PagedCallSettings<ListTopicSubscriptionsRequest,ListTopicSubscriptionsResponse,AdminServiceClient.ListTopicSubscriptionsPagedResponse>	listTopicSubscriptionsSettings() Returns the object with the settings used for calls to listTopicSubscriptions.
static AdminServiceSettings.Builder	newBuilder() Returns a new builder for this class.
static AdminServiceSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.OperationCallSettings<SeekSubscriptionRequest,SeekSubscriptionResponse,OperationMetadata>	seekSubscriptionOperationSettings() Returns the object with the settings used for calls to seekSubscription.
com.google.api.gax.rpc.UnaryCallSettings<SeekSubscriptionRequest,com.google.longrunning.Operation>	seekSubscriptionSettings() Returns the object with the settings used for calls to seekSubscription.
AdminServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.UnaryCallSettings<UpdateReservationRequest,Reservation>	updateReservationSettings() Returns the object with the settings used for calls to updateReservation.
com.google.api.gax.rpc.UnaryCallSettings<UpdateSubscriptionRequest,Subscription>	updateSubscriptionSettings() Returns the object with the settings used for calls to updateSubscription.
com.google.api.gax.rpc.UnaryCallSettings<UpdateTopicRequest,Topic>	updateTopicSettings() Returns the object with the settings used for calls to updateTopic.

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

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminServiceSettings

protected AdminServiceSettings(AdminServiceSettings.Builder settingsBuilder)
                        throws IOException

Throws:

IOException

Method Detail

createTopicSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateTopicRequest,Topic> createTopicSettings()

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

getTopicSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetTopicRequest,Topic> getTopicSettings()

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

getTopicPartitionsSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetTopicPartitionsRequest,TopicPartitions> getTopicPartitionsSettings()

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

listTopicsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListTopicsRequest,ListTopicsResponse,AdminServiceClient.ListTopicsPagedResponse> listTopicsSettings()

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

updateTopicSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateTopicRequest,Topic> updateTopicSettings()

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

deleteTopicSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteTopicRequest,com.google.protobuf.Empty> deleteTopicSettings()

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

listTopicSubscriptionsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListTopicSubscriptionsRequest,ListTopicSubscriptionsResponse,AdminServiceClient.ListTopicSubscriptionsPagedResponse> listTopicSubscriptionsSettings()

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

createSubscriptionSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateSubscriptionRequest,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.

listSubscriptionsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListSubscriptionsRequest,ListSubscriptionsResponse,AdminServiceClient.ListSubscriptionsPagedResponse> listSubscriptionsSettings()

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

updateSubscriptionSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateSubscriptionRequest,Subscription> updateSubscriptionSettings()

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

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.

seekSubscriptionSettings

public com.google.api.gax.rpc.UnaryCallSettings<SeekSubscriptionRequest,com.google.longrunning.Operation> seekSubscriptionSettings()

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

seekSubscriptionOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<SeekSubscriptionRequest,SeekSubscriptionResponse,OperationMetadata> seekSubscriptionOperationSettings()

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

createReservationSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateReservationRequest,Reservation> createReservationSettings()

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

getReservationSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetReservationRequest,Reservation> getReservationSettings()

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

listReservationsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListReservationsRequest,ListReservationsResponse,AdminServiceClient.ListReservationsPagedResponse> listReservationsSettings()

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

updateReservationSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateReservationRequest,Reservation> updateReservationSettings()

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

deleteReservationSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteReservationRequest,com.google.protobuf.Empty> deleteReservationSettings()

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

listReservationTopicsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListReservationTopicsRequest,ListReservationTopicsResponse,AdminServiceClient.ListReservationTopicsPagedResponse> listReservationTopicsSettings()

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

create

public static final AdminServiceSettings create(AdminServiceStubSettings stub)
                                         throws IOException

Throws:

IOException

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.

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 ChannelProvider for this service.

defaultTransportChannelProvider

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

defaultApiClientHeaderProviderBuilder

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

newBuilder

public static AdminServiceSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static AdminServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public AdminServiceSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<AdminServiceSettings>