Class ChatRequest.Builder (0.110.0)

public static final class ChatRequest.Builder extends GeneratedMessage.Builder<ChatRequest.Builder> implements ChatRequestOrBuilder

Request message for the Chat method.

Protobuf type google.analytics.data.v1alpha.ChatRequest

Static Methods

getDescriptor()

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

Methods

build()

public ChatRequest build()
Returns
Type Description
ChatRequest

buildPartial()

public ChatRequest buildPartial()
Returns
Type Description
ChatRequest

clear()

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

clearProperty()

public ChatRequest.Builder clearProperty()

Required. The property to chat about. Format: properties/{property}

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

Returns
Type Description
ChatRequest.Builder

This builder for chaining.

clearReturnPropertyQuota()

public ChatRequest.Builder clearReturnPropertyQuota()

Optional. If true, the response will include the current state of this Analytics Property's quota. Quota is returned in PropertyChatQuota.

bool return_property_quota = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ChatRequest.Builder

This builder for chaining.

clearSessionId()

public ChatRequest.Builder clearSessionId()

Optional. Provide this session ID to continue an existing conversation and maintain context. If this field is empty or unset, a new chat session is created. Invalid session IDs will result in an error.

optional string session_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ChatRequest.Builder

This builder for chaining.

clearUserQuery()

public ChatRequest.Builder clearUserQuery()

Required. The user's query.

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

Returns
Type Description
ChatRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ChatRequest getDefaultInstanceForType()
Returns
Type Description
ChatRequest

getDescriptorForType()

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

getProperty()

public String getProperty()

Required. The property to chat about. Format: properties/{property}

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

Returns
Type Description
String

The property.

getPropertyBytes()

public ByteString getPropertyBytes()

Required. The property to chat about. Format: properties/{property}

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

Returns
Type Description
ByteString

The bytes for property.

getReturnPropertyQuota()

public boolean getReturnPropertyQuota()

Optional. If true, the response will include the current state of this Analytics Property's quota. Quota is returned in PropertyChatQuota.

bool return_property_quota = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The returnPropertyQuota.

getSessionId()

public String getSessionId()

Optional. Provide this session ID to continue an existing conversation and maintain context. If this field is empty or unset, a new chat session is created. Invalid session IDs will result in an error.

optional string session_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The sessionId.

getSessionIdBytes()

public ByteString getSessionIdBytes()

Optional. Provide this session ID to continue an existing conversation and maintain context. If this field is empty or unset, a new chat session is created. Invalid session IDs will result in an error.

optional string session_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for sessionId.

getUserQuery()

public String getUserQuery()

Required. The user's query.

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

Returns
Type Description
String

The userQuery.

getUserQueryBytes()

public ByteString getUserQueryBytes()

Required. The user's query.

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

Returns
Type Description
ByteString

The bytes for userQuery.

hasSessionId()

public boolean hasSessionId()

Optional. Provide this session ID to continue an existing conversation and maintain context. If this field is empty or unset, a new chat session is created. Invalid session IDs will result in an error.

optional string session_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the sessionId field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ChatRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setProperty(String value)

public ChatRequest.Builder setProperty(String value)

Required. The property to chat about. Format: properties/{property}

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

Parameter
Name Description
value String

The property to set.

Returns
Type Description
ChatRequest.Builder

This builder for chaining.

setPropertyBytes(ByteString value)

public ChatRequest.Builder setPropertyBytes(ByteString value)

Required. The property to chat about. Format: properties/{property}

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

Parameter
Name Description
value ByteString

The bytes for property to set.

Returns
Type Description
ChatRequest.Builder

This builder for chaining.

setReturnPropertyQuota(boolean value)

public ChatRequest.Builder setReturnPropertyQuota(boolean value)

Optional. If true, the response will include the current state of this Analytics Property's quota. Quota is returned in PropertyChatQuota.

bool return_property_quota = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The returnPropertyQuota to set.

Returns
Type Description
ChatRequest.Builder

This builder for chaining.

setSessionId(String value)

public ChatRequest.Builder setSessionId(String value)

Optional. Provide this session ID to continue an existing conversation and maintain context. If this field is empty or unset, a new chat session is created. Invalid session IDs will result in an error.

optional string session_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The sessionId to set.

Returns
Type Description
ChatRequest.Builder

This builder for chaining.

setSessionIdBytes(ByteString value)

public ChatRequest.Builder setSessionIdBytes(ByteString value)

Optional. Provide this session ID to continue an existing conversation and maintain context. If this field is empty or unset, a new chat session is created. Invalid session IDs will result in an error.

optional string session_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for sessionId to set.

Returns
Type Description
ChatRequest.Builder

This builder for chaining.

setUserQuery(String value)

public ChatRequest.Builder setUserQuery(String value)

Required. The user's query.

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

Parameter
Name Description
value String

The userQuery to set.

Returns
Type Description
ChatRequest.Builder

This builder for chaining.

setUserQueryBytes(ByteString value)

public ChatRequest.Builder setUserQueryBytes(ByteString value)

Required. The user's query.

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

Parameter
Name Description
value ByteString

The bytes for userQuery to set.

Returns
Type Description
ChatRequest.Builder

This builder for chaining.