Interface WriteUserEventRequestOrBuilder (2.49.0)

public interface WriteUserEventRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getParent()

public abstract String getParent()

Required. The parent catalog resource name, such as projects/1234/locations/global/catalogs/default_catalog.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. The parent catalog resource name, such as projects/1234/locations/global/catalogs/default_catalog.

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for parent.

getUserEvent()

public abstract UserEvent getUserEvent()

Required. User event to write.

.google.cloud.retail.v2alpha.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UserEvent

The userEvent.

getUserEventOrBuilder()

public abstract UserEventOrBuilder getUserEventOrBuilder()

Required. User event to write.

.google.cloud.retail.v2alpha.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
UserEventOrBuilder

getWriteAsync()

public abstract boolean getWriteAsync()

If set to true, the user event will be written asynchronously after validation, and the API will respond without waiting for the write. Therefore, silent failures can occur even if the API returns success. In case of silent failures, error messages can be found in Stackdriver logs.

bool write_async = 3;

Returns
Type Description
boolean

The writeAsync.

hasUserEvent()

public abstract boolean hasUserEvent()

Required. User event to write.

.google.cloud.retail.v2alpha.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the userEvent field is set.