Class UserEventServiceStubSettings (2.53.0) 

public class UserEventServiceStubSettings extends StubSettings<UserEventServiceStubSettings>

Settings class to configure an instance of UserEventServiceStub.

The default instance has everything set to sensible defaults:

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


 // 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
 UserEventServiceStubSettings.Builder userEventServiceSettingsBuilder =
     UserEventServiceStubSettings.newBuilder();
 userEventServiceSettingsBuilder
     .writeUserEventSettings()
     .setRetrySettings(
         userEventServiceSettingsBuilder
             .writeUserEventSettings()
             .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());
 UserEventServiceStubSettings userEventServiceSettings = userEventServiceSettingsBuilder.build();

Please refer to the Client Side Retry Guide for additional support in setting retries.

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for purgeUserEvents:


 // 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
 UserEventServiceStubSettings.Builder userEventServiceSettingsBuilder =
     UserEventServiceStubSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 userEventServiceSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > StubSettings > UserEventServiceStubSettings

Static Methods

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

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
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

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
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

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 UserEventServiceStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
UserEventServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static UserEventServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
UserEventServiceStubSettings.Builder

newHttpJsonBuilder()

public static UserEventServiceStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
UserEventServiceStubSettings.Builder

Constructors

UserEventServiceStubSettings(UserEventServiceStubSettings.Builder settingsBuilder)

protected UserEventServiceStubSettings(UserEventServiceStubSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder UserEventServiceStubSettings.Builder

Methods

collectUserEventSettings()

public UnaryCallSettings<CollectUserEventRequest,HttpBody> collectUserEventSettings()

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

Returns
Type Description
UnaryCallSettings<CollectUserEventRequest,com.google.api.HttpBody>

createStub()

public UserEventServiceStub createStub()
Returns
Type Description
UserEventServiceStub
Exceptions
Type Description
IOException

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

importUserEventsOperationSettings()

public OperationCallSettings<ImportUserEventsRequest,ImportUserEventsResponse,ImportMetadata> importUserEventsOperationSettings()

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

Returns
Type Description
OperationCallSettings<ImportUserEventsRequest,ImportUserEventsResponse,ImportMetadata>

importUserEventsSettings()

public UnaryCallSettings<ImportUserEventsRequest,Operation> importUserEventsSettings()

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

Returns
Type Description
UnaryCallSettings<ImportUserEventsRequest,Operation>

purgeUserEventsOperationSettings()

public OperationCallSettings<PurgeUserEventsRequest,PurgeUserEventsResponse,PurgeMetadata> purgeUserEventsOperationSettings()

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

Returns
Type Description
OperationCallSettings<PurgeUserEventsRequest,PurgeUserEventsResponse,PurgeMetadata>

purgeUserEventsSettings()

public UnaryCallSettings<PurgeUserEventsRequest,Operation> purgeUserEventsSettings()

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

Returns
Type Description
UnaryCallSettings<PurgeUserEventsRequest,Operation>

rejoinUserEventsOperationSettings()

public OperationCallSettings<RejoinUserEventsRequest,RejoinUserEventsResponse,RejoinUserEventsMetadata> rejoinUserEventsOperationSettings()

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

Returns
Type Description
OperationCallSettings<RejoinUserEventsRequest,RejoinUserEventsResponse,RejoinUserEventsMetadata>

rejoinUserEventsSettings()

public UnaryCallSettings<RejoinUserEventsRequest,Operation> rejoinUserEventsSettings()

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

Returns
Type Description
UnaryCallSettings<RejoinUserEventsRequest,Operation>

toBuilder()

public UserEventServiceStubSettings.Builder toBuilder()

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

Returns
Type Description
UserEventServiceStubSettings.Builder
Overrides

writeUserEventSettings()

public UnaryCallSettings<WriteUserEventRequest,UserEvent> writeUserEventSettings()

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

Returns
Type Description
UnaryCallSettings<WriteUserEventRequest,UserEvent>