Interface WriteUserEventRequestOrBuilder (0.45.0)

public interface WriteUserEventRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getParent()

public abstract String getParent()

Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}. If the write user event action is applied in [Location][] level, for example, the event with Document across multiple DataStore, the format is: projects/{project}/locations/{location}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The parent.

getParentBytes()

public abstract ByteString getParentBytes()

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for parent.

getUserEvent()

public abstract UserEvent getUserEvent()

Required. User event to write.

optional .google.cloud.discoveryengine.v1.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.

optional .google.cloud.discoveryengine.v1.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 is written asynchronously after validation, and the API responds without waiting for the write.

bool write_async = 3;

Returns
Type	Description
`boolean`	The writeAsync.

hasUserEvent()

public abstract boolean hasUserEvent()

Required. User event to write.

optional .google.cloud.discoveryengine.v1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`boolean`	Whether the userEvent field is set.