WriteUserEventRequest.Builder (proto-google-cloud-retail-v2 2.34.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<WriteUserEventRequest.Builder>
    - - com.google.cloud.retail.v2.WriteUserEventRequest.Builder

All Implemented Interfaces:

WriteUserEventRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

WriteUserEventRequest
```
public static final class WriteUserEventRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<WriteUserEventRequest.Builder>
implements WriteUserEventRequestOrBuilder
```
```
 Request message for WriteUserEvent method.
 
```
Protobuf type google.cloud.retail.v2.WriteUserEventRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WriteUserEventRequest.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`WriteUserEventRequest`	`build()`
`WriteUserEventRequest`	`buildPartial()`
`WriteUserEventRequest.Builder`	`clear()`
`WriteUserEventRequest.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`WriteUserEventRequest.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`WriteUserEventRequest.Builder`	`clearParent()` Required.
`WriteUserEventRequest.Builder`	`clearUserEvent()` Required.
`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.
`WriteUserEventRequest.Builder`	`clone()`
`WriteUserEventRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getParent()` Required.
`com.google.protobuf.ByteString`	`getParentBytes()` Required.
`UserEvent`	`getUserEvent()` Required.
`UserEvent.Builder`	`getUserEventBuilder()` Required.
`UserEventOrBuilder`	`getUserEventOrBuilder()` Required.
`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.
`boolean`	`hasUserEvent()` Required.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`WriteUserEventRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`WriteUserEventRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`WriteUserEventRequest.Builder`	`mergeFrom(WriteUserEventRequest other)`
`WriteUserEventRequest.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`WriteUserEventRequest.Builder`	`mergeUserEvent(UserEvent value)` Required.
`WriteUserEventRequest.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`WriteUserEventRequest.Builder`	`setParent(String value)` Required.
`WriteUserEventRequest.Builder`	`setParentBytes(com.google.protobuf.ByteString value)` Required.
`WriteUserEventRequest.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`WriteUserEventRequest.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`WriteUserEventRequest.Builder`	`setUserEvent(UserEvent.Builder builderForValue)` Required.
`WriteUserEventRequest.Builder`	`setUserEvent(UserEvent value)` Required.
`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.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<WriteUserEventRequest.Builder>
  - clear
```
public WriteUserEventRequest.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<WriteUserEventRequest.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<WriteUserEventRequest.Builder>
  - getDefaultInstanceForType
```
public WriteUserEventRequest getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public WriteUserEventRequest build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public WriteUserEventRequest buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public WriteUserEventRequest.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<WriteUserEventRequest.Builder>
  - setField
```
public WriteUserEventRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<WriteUserEventRequest.Builder>
  - clearField
```
public WriteUserEventRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<WriteUserEventRequest.Builder>
  - clearOneof
```
public WriteUserEventRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<WriteUserEventRequest.Builder>
  - setRepeatedField
```
public WriteUserEventRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      int index,
                                                      Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<WriteUserEventRequest.Builder>
  - addRepeatedField
```
public WriteUserEventRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<WriteUserEventRequest.Builder>
  - mergeFrom
```
public WriteUserEventRequest.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<WriteUserEventRequest.Builder>
  - mergeFrom
```
public WriteUserEventRequest.Builder mergeFrom(WriteUserEventRequest other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<WriteUserEventRequest.Builder>
  - mergeFrom
```
public WriteUserEventRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<WriteUserEventRequest.Builder>
    
    Throws:
    
    IOException
  - 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];
    Specified by:
    
    getParent in interface WriteUserEventRequestOrBuilder
    
    Returns:
    
    The parent.
  - getParentBytes
```
public com.google.protobuf.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];
    Specified by:
    
    getParentBytes in interface WriteUserEventRequestOrBuilder
    
    Returns:
    
    The bytes for parent.
  - setParent
```
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];
    Parameters:
    
    value - The parent to set.
    
    Returns:
    
    This builder for chaining.
  - 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:
    
    This builder for chaining.
  - setParentBytes
```
public WriteUserEventRequest.Builder setParentBytes(com.google.protobuf.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];
    Parameters:
    
    value - The bytes for parent to set.
    
    Returns:
    
    This builder for chaining.
  - hasUserEvent
```
public boolean hasUserEvent()
```
```
 Required. User event to write.
 
```
    .google.cloud.retail.v2.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    hasUserEvent in interface WriteUserEventRequestOrBuilder
    
    Returns:
    
    Whether the userEvent field is set.
  - getUserEvent
```
public UserEvent getUserEvent()
```
```
 Required. User event to write.
 
```
    .google.cloud.retail.v2.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getUserEvent in interface WriteUserEventRequestOrBuilder
    
    Returns:
    
    The userEvent.
  - setUserEvent
```
public WriteUserEventRequest.Builder setUserEvent(UserEvent value)
```
```
 Required. User event to write.
 
```
    .google.cloud.retail.v2.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
  - setUserEvent
```
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];
  - mergeUserEvent
```
public WriteUserEventRequest.Builder mergeUserEvent(UserEvent value)
```
```
 Required. User event to write.
 
```
    .google.cloud.retail.v2.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
  - clearUserEvent
```
public WriteUserEventRequest.Builder clearUserEvent()
```
```
 Required. User event to write.
 
```
    .google.cloud.retail.v2.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
  - getUserEventBuilder
```
public UserEvent.Builder getUserEventBuilder()
```
```
 Required. User event to write.
 
```
    .google.cloud.retail.v2.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
  - getUserEventOrBuilder
```
public UserEventOrBuilder getUserEventOrBuilder()
```
```
 Required. User event to write.
 
```
    .google.cloud.retail.v2.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getUserEventOrBuilder in interface WriteUserEventRequestOrBuilder
  - 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;
    Specified by:
    
    getWriteAsync in interface WriteUserEventRequestOrBuilder
    
    Returns:
    
    The writeAsync.
  - setWriteAsync
```
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;
    Parameters:
    
    value - The writeAsync to set.
    
    Returns:
    
    This builder for chaining.
  - 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:
    
    This builder for chaining.
  - setUnknownFields
```
public final WriteUserEventRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<WriteUserEventRequest.Builder>
  - mergeUnknownFields
```
public final WriteUserEventRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<WriteUserEventRequest.Builder>

Class WriteUserEventRequest.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getParent

getParentBytes

setParent

clearParent

setParentBytes

hasUserEvent

getUserEvent

setUserEvent

setUserEvent

mergeUserEvent

clearUserEvent

getUserEventBuilder

getUserEventOrBuilder

getWriteAsync

setWriteAsync

clearWriteAsync

setUnknownFields

mergeUnknownFields