Class ChatRequest (0.110.0)

public final class ChatRequest extends GeneratedMessage implements ChatRequestOrBuilder

Request message for the Chat method.

Protobuf type google.analytics.data.v1alpha.ChatRequest

Static Fields

PROPERTY_FIELD_NUMBER

public static final int PROPERTY_FIELD_NUMBER
Field Value
Type Description
int

RETURN_PROPERTY_QUOTA_FIELD_NUMBER

public static final int RETURN_PROPERTY_QUOTA_FIELD_NUMBER
Field Value
Type Description
int

SESSION_ID_FIELD_NUMBER

public static final int SESSION_ID_FIELD_NUMBER
Field Value
Type Description
int

USER_QUERY_FIELD_NUMBER

public static final int USER_QUERY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ChatRequest getDefaultInstance()
Returns
Type Description
ChatRequest

getDescriptor()

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

newBuilder()

public static ChatRequest.Builder newBuilder()
Returns
Type Description
ChatRequest.Builder

newBuilder(ChatRequest prototype)

public static ChatRequest.Builder newBuilder(ChatRequest prototype)
Parameter
Name Description
prototype ChatRequest
Returns
Type Description
ChatRequest.Builder

parseDelimitedFrom(InputStream input)

public static ChatRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ChatRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ChatRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ChatRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ChatRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ChatRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ChatRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ChatRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ChatRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ChatRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ChatRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ChatRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ChatRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ChatRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ChatRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ChatRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ChatRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ChatRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ChatRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ChatRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ChatRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ChatRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ChatRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ChatRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ChatRequest> parser()
Returns
Type Description
Parser<ChatRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ChatRequest getDefaultInstanceForType()
Returns
Type Description
ChatRequest

getParserForType()

public Parser<ChatRequest> getParserForType()
Returns
Type Description
Parser<ChatRequest>
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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ChatRequest.Builder newBuilderForType()
Returns
Type Description
ChatRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ChatRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ChatRequest.Builder
Overrides

toBuilder()

public ChatRequest.Builder toBuilder()
Returns
Type Description
ChatRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException