Class UserEventServiceStubSettings
- java.lang.Object
-
- com.google.api.gax.rpc.StubSettings<UserEventServiceStubSettings>
-
- com.google.cloud.retail.v2beta.stub.UserEventServiceStubSettings
-
@BetaApi @Generated("by gapic-generator-java") public class UserEventServiceStubSettings extends com.google.api.gax.rpc.StubSettings<UserEventServiceStubSettings>
Settings class to configure an instance ofUserEventServiceStub.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 total timeout of writeUserEvent 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 UserEventServiceStubSettings.Builder userEventServiceSettingsBuilder = UserEventServiceStubSettings.newBuilder(); userEventServiceSettingsBuilder .writeUserEventSettings() .setRetrySettings( userEventServiceSettingsBuilder .writeUserEventSettings() .getRetrySettings() .toBuilder() .setTotalTimeout(Duration.ofSeconds(30)) .build()); UserEventServiceStubSettings userEventServiceSettings = userEventServiceSettingsBuilder.build();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classUserEventServiceStubSettings.BuilderBuilder for UserEventServiceStubSettings.
-
Constructor Summary
Constructors Modifier Constructor Description protectedUserEventServiceStubSettings(UserEventServiceStubSettings.Builder settingsBuilder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.google.api.gax.rpc.UnaryCallSettings<CollectUserEventRequest,com.google.api.HttpBody>collectUserEventSettings()Returns the object with the settings used for calls to collectUserEvent.UserEventServiceStubcreateStub()static com.google.api.gax.rpc.ApiClientHeaderProvider.BuilderdefaultApiClientHeaderProviderBuilder()static com.google.api.gax.core.GoogleCredentialsProvider.BuilderdefaultCredentialsProviderBuilder()Returns a builder for the default credentials for this service.static com.google.api.gax.core.InstantiatingExecutorProvider.BuilderdefaultExecutorProviderBuilder()Returns a builder for the default ExecutorProvider for this service.static com.google.api.gax.rpc.ApiClientHeaderProvider.BuilderdefaultGrpcApiClientHeaderProviderBuilder()static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.BuilderdefaultGrpcTransportProviderBuilder()Returns a builder for the default gRPC ChannelProvider for this service.static com.google.api.gax.rpc.ApiClientHeaderProvider.BuilderdefaultHttpJsonApiClientHeaderProviderBuilder()static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.BuilderdefaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service.static com.google.api.gax.rpc.TransportChannelProviderdefaultTransportChannelProvider()static StringgetDefaultEndpoint()Returns the default service endpoint.static StringgetDefaultMtlsEndpoint()Returns the default mTLS service endpoint.static List<String>getDefaultServiceScopes()Returns the default service scopes.com.google.api.gax.rpc.OperationCallSettings<ImportUserEventsRequest,ImportUserEventsResponse,ImportMetadata>importUserEventsOperationSettings()Returns the object with the settings used for calls to importUserEvents.com.google.api.gax.rpc.UnaryCallSettings<ImportUserEventsRequest,com.google.longrunning.Operation>importUserEventsSettings()Returns the object with the settings used for calls to importUserEvents.static UserEventServiceStubSettings.BuildernewBuilder()Returns a new gRPC builder for this class.static UserEventServiceStubSettings.BuildernewBuilder(com.google.api.gax.rpc.ClientContext clientContext)Returns a new builder for this class.static UserEventServiceStubSettings.BuildernewHttpJsonBuilder()Returns a new REST builder for this class.com.google.api.gax.rpc.OperationCallSettings<PurgeUserEventsRequest,PurgeUserEventsResponse,PurgeMetadata>purgeUserEventsOperationSettings()Returns the object with the settings used for calls to purgeUserEvents.com.google.api.gax.rpc.UnaryCallSettings<PurgeUserEventsRequest,com.google.longrunning.Operation>purgeUserEventsSettings()Returns the object with the settings used for calls to purgeUserEvents.com.google.api.gax.rpc.OperationCallSettings<RejoinUserEventsRequest,RejoinUserEventsResponse,RejoinUserEventsMetadata>rejoinUserEventsOperationSettings()Returns the object with the settings used for calls to rejoinUserEvents.com.google.api.gax.rpc.UnaryCallSettings<RejoinUserEventsRequest,com.google.longrunning.Operation>rejoinUserEventsSettings()Returns the object with the settings used for calls to rejoinUserEvents.UserEventServiceStubSettings.BuildertoBuilder()Returns a builder containing all the values of this settings class.com.google.api.gax.rpc.UnaryCallSettings<WriteUserEventRequest,UserEvent>writeUserEventSettings()Returns the object with the settings used for calls to writeUserEvent.-
Methods inherited from class com.google.api.gax.rpc.StubSettings
getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, toString
-
-
-
-
Constructor Detail
-
UserEventServiceStubSettings
protected UserEventServiceStubSettings(UserEventServiceStubSettings.Builder settingsBuilder) throws IOException
- Throws:
IOException
-
-
Method Detail
-
writeUserEventSettings
public com.google.api.gax.rpc.UnaryCallSettings<WriteUserEventRequest,UserEvent> writeUserEventSettings()
Returns the object with the settings used for calls to writeUserEvent.
-
collectUserEventSettings
public com.google.api.gax.rpc.UnaryCallSettings<CollectUserEventRequest,com.google.api.HttpBody> collectUserEventSettings()
Returns the object with the settings used for calls to collectUserEvent.
-
purgeUserEventsSettings
public com.google.api.gax.rpc.UnaryCallSettings<PurgeUserEventsRequest,com.google.longrunning.Operation> purgeUserEventsSettings()
Returns the object with the settings used for calls to purgeUserEvents.
-
purgeUserEventsOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<PurgeUserEventsRequest,PurgeUserEventsResponse,PurgeMetadata> purgeUserEventsOperationSettings()
Returns the object with the settings used for calls to purgeUserEvents.
-
importUserEventsSettings
public com.google.api.gax.rpc.UnaryCallSettings<ImportUserEventsRequest,com.google.longrunning.Operation> importUserEventsSettings()
Returns the object with the settings used for calls to importUserEvents.
-
importUserEventsOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<ImportUserEventsRequest,ImportUserEventsResponse,ImportMetadata> importUserEventsOperationSettings()
Returns the object with the settings used for calls to importUserEvents.
-
rejoinUserEventsSettings
public com.google.api.gax.rpc.UnaryCallSettings<RejoinUserEventsRequest,com.google.longrunning.Operation> rejoinUserEventsSettings()
Returns the object with the settings used for calls to rejoinUserEvents.
-
rejoinUserEventsOperationSettings
public com.google.api.gax.rpc.OperationCallSettings<RejoinUserEventsRequest,RejoinUserEventsResponse,RejoinUserEventsMetadata> rejoinUserEventsOperationSettings()
Returns the object with the settings used for calls to rejoinUserEvents.
-
createStub
public UserEventServiceStub createStub() 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.
-
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 UserEventServiceStubSettings.Builder newBuilder()
Returns a new gRPC builder for this class.
-
newHttpJsonBuilder
public static UserEventServiceStubSettings.Builder newHttpJsonBuilder()
Returns a new REST builder for this class.
-
newBuilder
public static UserEventServiceStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
-
toBuilder
public UserEventServiceStubSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classcom.google.api.gax.rpc.StubSettings<UserEventServiceStubSettings>
-
-