Class WriteUserEventRequest (0.45.0)

public final class WriteUserEventRequest extends GeneratedMessageV3 implements WriteUserEventRequestOrBuilder

Request message for WriteUserEvent method.

Protobuf type google.cloud.discoveryengine.v1.WriteUserEventRequest

Static Fields

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

USER_EVENT_FIELD_NUMBER

public static final int USER_EVENT_FIELD_NUMBER
Field Value
Type Description
int

WRITE_ASYNC_FIELD_NUMBER

public static final int WRITE_ASYNC_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static WriteUserEventRequest getDefaultInstance()
Returns
Type Description
WriteUserEventRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static WriteUserEventRequest.Builder newBuilder()
Returns
Type Description
WriteUserEventRequest.Builder

newBuilder(WriteUserEventRequest prototype)

public static WriteUserEventRequest.Builder newBuilder(WriteUserEventRequest prototype)
Parameter
Name Description
prototype WriteUserEventRequest
Returns
Type Description
WriteUserEventRequest.Builder

parseDelimitedFrom(InputStream input)

public static WriteUserEventRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WriteUserEventRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WriteUserEventRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteUserEventRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static WriteUserEventRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
WriteUserEventRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static WriteUserEventRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteUserEventRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static WriteUserEventRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
WriteUserEventRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static WriteUserEventRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteUserEventRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static WriteUserEventRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
WriteUserEventRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static WriteUserEventRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteUserEventRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static WriteUserEventRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
WriteUserEventRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WriteUserEventRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteUserEventRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static WriteUserEventRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
WriteUserEventRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static WriteUserEventRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteUserEventRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<WriteUserEventRequest> parser()
Returns
Type Description
Parser<WriteUserEventRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public WriteUserEventRequest getDefaultInstanceForType()
Returns
Type Description
WriteUserEventRequest

getParent()

public 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 ByteString getParentBytes()

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
ByteString

The bytes for parent.

getParserForType()

public Parser<WriteUserEventRequest> getParserForType()
Returns
Type Description
Parser<WriteUserEventRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUserEvent()

public 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 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 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public WriteUserEventRequest.Builder newBuilderForType()
Returns
Type Description
WriteUserEventRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected WriteUserEventRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
WriteUserEventRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public WriteUserEventRequest.Builder toBuilder()
Returns
Type Description
WriteUserEventRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException