Class WriteUserEventRequest.Builder (0.41.0)

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

Request message for WriteUserEvent method.

Protobuf type google.cloud.discoveryengine.v1beta.WriteUserEventRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public WriteUserEventRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
WriteUserEventRequest.Builder
Overrides

build()

public WriteUserEventRequest build()
Returns
Type Description
WriteUserEventRequest

buildPartial()

public WriteUserEventRequest buildPartial()
Returns
Type Description
WriteUserEventRequest

clear()

public WriteUserEventRequest.Builder clear()
Returns
Type Description
WriteUserEventRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public WriteUserEventRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
WriteUserEventRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public WriteUserEventRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
WriteUserEventRequest.Builder
Overrides

clearParent()

public WriteUserEventRequest.Builder clearParent()

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

This builder for chaining.

clearUserEvent()

public WriteUserEventRequest.Builder clearUserEvent()

Required. User event to write.

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

Returns
Type Description
WriteUserEventRequest.Builder

clearWriteAsync()

public WriteUserEventRequest.Builder clearWriteAsync()

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

This builder for chaining.

clone()

public WriteUserEventRequest.Builder clone()
Returns
Type Description
WriteUserEventRequest.Builder
Overrides

getDefaultInstanceForType()

public WriteUserEventRequest getDefaultInstanceForType()
Returns
Type Description
WriteUserEventRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getUserEvent()

public UserEvent getUserEvent()

Required. User event to write.

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

Returns
Type Description
UserEvent

The userEvent.

getUserEventBuilder()

public UserEvent.Builder getUserEventBuilder()

Required. User event to write.

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

Returns
Type Description
UserEvent.Builder

getUserEventOrBuilder()

public UserEventOrBuilder getUserEventOrBuilder()

Required. User event to write.

optional .google.cloud.discoveryengine.v1beta.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.v1beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the userEvent field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(WriteUserEventRequest other)

public WriteUserEventRequest.Builder mergeFrom(WriteUserEventRequest other)
Parameter
Name Description
other WriteUserEventRequest
Returns
Type Description
WriteUserEventRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public WriteUserEventRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
WriteUserEventRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public WriteUserEventRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
WriteUserEventRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final WriteUserEventRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
WriteUserEventRequest.Builder
Overrides

mergeUserEvent(UserEvent value)

public WriteUserEventRequest.Builder mergeUserEvent(UserEvent value)

Required. User event to write.

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

Parameter
Name Description
value UserEvent
Returns
Type Description
WriteUserEventRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public WriteUserEventRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
WriteUserEventRequest.Builder
Overrides

setParent(String value)

public WriteUserEventRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
WriteUserEventRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public WriteUserEventRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
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
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
WriteUserEventRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final WriteUserEventRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
WriteUserEventRequest.Builder
Overrides

setUserEvent(UserEvent value)

public WriteUserEventRequest.Builder setUserEvent(UserEvent value)

Required. User event to write.

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

Parameter
Name Description
value UserEvent
Returns
Type Description
WriteUserEventRequest.Builder

setUserEvent(UserEvent.Builder builderForValue)

public WriteUserEventRequest.Builder setUserEvent(UserEvent.Builder builderForValue)

Required. User event to write.

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

Parameter
Name Description
builderForValue UserEvent.Builder
Returns
Type Description
WriteUserEventRequest.Builder

setWriteAsync(boolean value)

public WriteUserEventRequest.Builder setWriteAsync(boolean value)

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;

Parameter
Name Description
value boolean

The writeAsync to set.

Returns
Type Description
WriteUserEventRequest.Builder

This builder for chaining.