com.google.cloud.discoveryengine.v1alpha

Interface WriteUserEventRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

WriteUserEventRequest, WriteUserEventRequest.Builder

public interface WriteUserEventRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
UserEvent	getUserEvent() Required.
UserEventOrBuilder	getUserEventOrBuilder() Required.
boolean	getWriteAsync() If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.
boolean	hasUserEvent() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

String getParent()

 Required. The parent resource name.
 If the write user event action is applied in
 [DataStore][google.cloud.discoveryengine.v1alpha.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][google.cloud.discoveryengine.v1alpha.Document] across multiple
 [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], the format is:
 `projects/{project}/locations/{location}`.
 

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

Returns:

The parent.

getParentBytes

com.google.protobuf.ByteString getParentBytes()

 Required. The parent resource name.
 If the write user event action is applied in
 [DataStore][google.cloud.discoveryengine.v1alpha.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][google.cloud.discoveryengine.v1alpha.Document] across multiple
 [DataStore][google.cloud.discoveryengine.v1alpha.DataStore], the format is:
 `projects/{project}/locations/{location}`.
 

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

Returns:

The bytes for parent.

hasUserEvent

boolean hasUserEvent()

 Required. User event to write.
 

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

Returns:

Whether the userEvent field is set.

getUserEvent

UserEvent getUserEvent()

 Required. User event to write.
 

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

Returns:

The userEvent.

getUserEventOrBuilder

UserEventOrBuilder getUserEventOrBuilder()

 Required. User event to write.
 

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

getWriteAsync

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:

The writeAsync.