Class WriteUserEventRequest.Builder (2.29.0)

public static final class WriteUserEventRequest.Builder extends GeneratedMessageV3.Builder<WriteUserEventRequest.Builder> implements WriteUserEventRequestOrBuilder

Request message for WriteUserEvent method.

Protobuf type google.cloud.retail.v2.WriteUserEventRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public WriteUserEventRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
WriteUserEventRequest.Builder
Overrides

build()

public WriteUserEventRequest build()
Returns
TypeDescription
WriteUserEventRequest

buildPartial()

public WriteUserEventRequest buildPartial()
Returns
TypeDescription
WriteUserEventRequest

clear()

public WriteUserEventRequest.Builder clear()
Returns
TypeDescription
WriteUserEventRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public WriteUserEventRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
WriteUserEventRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public WriteUserEventRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
WriteUserEventRequest.Builder
Overrides

clearParent()

public WriteUserEventRequest.Builder clearParent()

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
WriteUserEventRequest.Builder

This builder for chaining.

clearUserEvent()

public WriteUserEventRequest.Builder clearUserEvent()

Required. User event to write.

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

Returns
TypeDescription
WriteUserEventRequest.Builder

clearWriteAsync()

public WriteUserEventRequest.Builder clearWriteAsync()

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
WriteUserEventRequest.Builder

This builder for chaining.

clone()

public WriteUserEventRequest.Builder clone()
Returns
TypeDescription
WriteUserEventRequest.Builder
Overrides

getDefaultInstanceForType()

public WriteUserEventRequest getDefaultInstanceForType()
Returns
TypeDescription
WriteUserEventRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

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.

getUserEventBuilder()

public UserEvent.Builder getUserEventBuilder()

Required. User event to write.

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

Returns
TypeDescription
UserEvent.Builder

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(WriteUserEventRequest other)

public WriteUserEventRequest.Builder mergeFrom(WriteUserEventRequest other)
Parameter
NameDescription
otherWriteUserEventRequest
Returns
TypeDescription
WriteUserEventRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public WriteUserEventRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WriteUserEventRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public WriteUserEventRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
WriteUserEventRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final WriteUserEventRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
WriteUserEventRequest.Builder
Overrides

mergeUserEvent(UserEvent value)

public WriteUserEventRequest.Builder mergeUserEvent(UserEvent value)

Required. User event to write.

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

Parameter
NameDescription
valueUserEvent
Returns
TypeDescription
WriteUserEventRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public WriteUserEventRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
WriteUserEventRequest.Builder
Overrides

setParent(String value)

public WriteUserEventRequest.Builder setParent(String value)

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

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

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
WriteUserEventRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public WriteUserEventRequest.Builder setParentBytes(ByteString value)

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

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

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
WriteUserEventRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public WriteUserEventRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
WriteUserEventRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final WriteUserEventRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
WriteUserEventRequest.Builder
Overrides

setUserEvent(UserEvent value)

public WriteUserEventRequest.Builder setUserEvent(UserEvent value)

Required. User event to write.

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

Parameter
NameDescription
valueUserEvent
Returns
TypeDescription
WriteUserEventRequest.Builder

setUserEvent(UserEvent.Builder builderForValue)

public WriteUserEventRequest.Builder setUserEvent(UserEvent.Builder builderForValue)

Required. User event to write.

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

Parameter
NameDescription
builderForValueUserEvent.Builder
Returns
TypeDescription
WriteUserEventRequest.Builder

setWriteAsync(boolean value)

public WriteUserEventRequest.Builder setWriteAsync(boolean value)

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;

Parameter
NameDescription
valueboolean

The writeAsync to set.

Returns
TypeDescription
WriteUserEventRequest.Builder

This builder for chaining.