Class CollectUserEventRequest.Builder (0.35.0)

public static final class CollectUserEventRequest.Builder extends GeneratedMessageV3.Builder<CollectUserEventRequest.Builder> implements CollectUserEventRequestOrBuilder

Request message for CollectUserEvent method.

Protobuf type google.cloud.discoveryengine.v1alpha.CollectUserEventRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public CollectUserEventRequest build()
Returns
TypeDescription
CollectUserEventRequest

buildPartial()

public CollectUserEventRequest buildPartial()
Returns
TypeDescription
CollectUserEventRequest

clear()

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

clearEts()

public CollectUserEventRequest.Builder clearEts()

The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.

optional int64 ets = 4;

Returns
TypeDescription
CollectUserEventRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearParent()

public CollectUserEventRequest.Builder clearParent()

Required. The parent DataStore resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
CollectUserEventRequest.Builder

This builder for chaining.

clearUri()

public CollectUserEventRequest.Builder clearUri()

The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.

optional string uri = 3;

Returns
TypeDescription
CollectUserEventRequest.Builder

This builder for chaining.

clearUserEvent()

public CollectUserEventRequest.Builder clearUserEvent()

Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.

string user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
CollectUserEventRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public CollectUserEventRequest getDefaultInstanceForType()
Returns
TypeDescription
CollectUserEventRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEts()

public long getEts()

The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.

optional int64 ets = 4;

Returns
TypeDescription
long

The ets.

getParent()

public String getParent()

Required. The parent DataStore resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent DataStore resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for parent.

getUri()

public String getUri()

The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.

optional string uri = 3;

Returns
TypeDescription
String

The uri.

getUriBytes()

public ByteString getUriBytes()

The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.

optional string uri = 3;

Returns
TypeDescription
ByteString

The bytes for uri.

getUserEvent()

public String getUserEvent()

Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.

string user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The userEvent.

getUserEventBytes()

public ByteString getUserEventBytes()

Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.

string user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for userEvent.

hasEts()

public boolean hasEts()

The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.

optional int64 ets = 4;

Returns
TypeDescription
boolean

Whether the ets field is set.

hasUri()

public boolean hasUri()

The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.

optional string uri = 3;

Returns
TypeDescription
boolean

Whether the uri field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(CollectUserEventRequest other)

public CollectUserEventRequest.Builder mergeFrom(CollectUserEventRequest other)
Parameter
NameDescription
otherCollectUserEventRequest
Returns
TypeDescription
CollectUserEventRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setEts(long value)

public CollectUserEventRequest.Builder setEts(long value)

The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.

optional int64 ets = 4;

Parameter
NameDescription
valuelong

The ets to set.

Returns
TypeDescription
CollectUserEventRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setParent(String value)

public CollectUserEventRequest.Builder setParent(String value)

Required. The parent DataStore resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
CollectUserEventRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public CollectUserEventRequest.Builder setParentBytes(ByteString value)

Required. The parent DataStore resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
CollectUserEventRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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

setUri(String value)

public CollectUserEventRequest.Builder setUri(String value)

The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.

optional string uri = 3;

Parameter
NameDescription
valueString

The uri to set.

Returns
TypeDescription
CollectUserEventRequest.Builder

This builder for chaining.

setUriBytes(ByteString value)

public CollectUserEventRequest.Builder setUriBytes(ByteString value)

The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.

optional string uri = 3;

Parameter
NameDescription
valueByteString

The bytes for uri to set.

Returns
TypeDescription
CollectUserEventRequest.Builder

This builder for chaining.

setUserEvent(String value)

public CollectUserEventRequest.Builder setUserEvent(String value)

Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.

string user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The userEvent to set.

Returns
TypeDescription
CollectUserEventRequest.Builder

This builder for chaining.

setUserEventBytes(ByteString value)

public CollectUserEventRequest.Builder setUserEventBytes(ByteString value)

Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.

string user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes for userEvent to set.

Returns
TypeDescription
CollectUserEventRequest.Builder

This builder for chaining.