Retail v2 API - Class UserEventServiceSettings (2.6.0)

public sealed class UserEventServiceSettings : ServiceSettingsBase

Reference documentation and code samples for the Retail v2 API class UserEventServiceSettings.

Settings for UserEventServiceClient instances.

Inheritance

object > ServiceSettingsBase > UserEventServiceSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

UserEventServiceSettings()

public UserEventServiceSettings()

Constructs a new UserEventServiceSettings object with default settings.

Properties

CollectUserEventSettings

public CallSettings CollectUserEventSettings { get; set; }

CallSettings for synchronous and asynchronous calls to UserEventServiceClient.CollectUserEvent and UserEventServiceClient.CollectUserEventAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 5000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 5 seconds.

ImportUserEventsOperationsSettings

public OperationsSettings ImportUserEventsOperationsSettings { get; set; }

Long Running Operation settings for calls to UserEventServiceClient.ImportUserEvents and UserEventServiceClient.ImportUserEventsAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

ImportUserEventsSettings

public CallSettings ImportUserEventsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to UserEventServiceClient.ImportUserEvents and UserEventServiceClient.ImportUserEventsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 300000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 600 seconds.

LocationsSettings

public LocationsSettings LocationsSettings { get; set; }

The settings to use for the LocationsClient associated with the client.

Property Value
Type	Description
`LocationsSettings`

PurgeUserEventsOperationsSettings

public OperationsSettings PurgeUserEventsOperationsSettings { get; set; }

Long Running Operation settings for calls to UserEventServiceClient.PurgeUserEvents and UserEventServiceClient.PurgeUserEventsAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

PurgeUserEventsSettings

public CallSettings PurgeUserEventsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to UserEventServiceClient.PurgeUserEvents and UserEventServiceClient.PurgeUserEventsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 30000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 30 seconds.

RejoinUserEventsOperationsSettings

public OperationsSettings RejoinUserEventsOperationsSettings { get; set; }

Long Running Operation settings for calls to UserEventServiceClient.RejoinUserEvents and UserEventServiceClient.RejoinUserEventsAsync.

Property Value
Type	Description
`OperationsSettings`

Remarks

Uses default PollSettings of:

Initial delay: 20 seconds.
Delay multiplier: 1.5
Maximum delay: 45 seconds.
Total timeout: 24 hours.

RejoinUserEventsSettings

public CallSettings RejoinUserEventsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to UserEventServiceClient.RejoinUserEvents and UserEventServiceClient.RejoinUserEventsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 5000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 5 seconds.

WriteUserEventSettings

public CallSettings WriteUserEventSettings { get; set; }

CallSettings for synchronous and asynchronous calls to UserEventServiceClient.WriteUserEvent and UserEventServiceClient.WriteUserEventAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 100 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 5000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable, DeadlineExceeded.
Timeout: 5 seconds.

Methods

Clone()

public UserEventServiceSettings Clone()

Creates a deep clone of this object, with all the same property values.

Returns
Type	Description
`UserEventServiceSettings`	A deep clone of this UserEventServiceSettings object.

GetDefault()

public static UserEventServiceSettings GetDefault()

Get a new instance of the default UserEventServiceSettings.

Returns
Type	Description
`UserEventServiceSettings`	A new instance of the default UserEventServiceSettings.