Class WriteUserEventRequest (2.39.0)

public final class WriteUserEventRequest extends GeneratedMessageV3 implements WriteUserEventRequestOrBuilder

Request message for WriteUserEvent method.

Protobuf type google.cloud.retail.v2.WriteUserEventRequest

Static Fields

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

USER_EVENT_FIELD_NUMBER

public static final int USER_EVENT_FIELD_NUMBER
Field Value
TypeDescription
int

WRITE_ASYNC_FIELD_NUMBER

public static final int WRITE_ASYNC_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static WriteUserEventRequest getDefaultInstance()
Returns
TypeDescription
WriteUserEventRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static WriteUserEventRequest.Builder newBuilder()
Returns
TypeDescription
WriteUserEventRequest.Builder

newBuilder(WriteUserEventRequest prototype)

public static WriteUserEventRequest.Builder newBuilder(WriteUserEventRequest prototype)
Parameter
NameDescription
prototypeWriteUserEventRequest
Returns
TypeDescription
WriteUserEventRequest.Builder

parseDelimitedFrom(InputStream input)

public static WriteUserEventRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
WriteUserEventRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WriteUserEventRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WriteUserEventRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static WriteUserEventRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
WriteUserEventRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static WriteUserEventRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WriteUserEventRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static WriteUserEventRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
WriteUserEventRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static WriteUserEventRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WriteUserEventRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static WriteUserEventRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
WriteUserEventRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static WriteUserEventRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WriteUserEventRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static WriteUserEventRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
WriteUserEventRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static WriteUserEventRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WriteUserEventRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static WriteUserEventRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
WriteUserEventRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static WriteUserEventRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WriteUserEventRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<WriteUserEventRequest> parser()
Returns
TypeDescription
Parser<WriteUserEventRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public WriteUserEventRequest getDefaultInstanceForType()
Returns
TypeDescription
WriteUserEventRequest

getParent()

public 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
TypeDescription
String

The parent.

getParentBytes()

public 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
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<WriteUserEventRequest> getParserForType()
Returns
TypeDescription
Parser<WriteUserEventRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUserEvent()

public UserEvent getUserEvent()

Required. User event to write.

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

Returns
TypeDescription
UserEvent

The userEvent.

getUserEventOrBuilder()

public UserEventOrBuilder getUserEventOrBuilder()

Required. User event to write.

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

Returns
TypeDescription
UserEventOrBuilder

getWriteAsync()

public 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
TypeDescription
boolean

The writeAsync.

hasUserEvent()

public boolean hasUserEvent()

Required. User event to write.

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

Returns
TypeDescription
boolean

Whether the userEvent field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public WriteUserEventRequest.Builder newBuilderForType()
Returns
TypeDescription
WriteUserEventRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected WriteUserEventRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
WriteUserEventRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public WriteUserEventRequest.Builder toBuilder()
Returns
TypeDescription
WriteUserEventRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException