Class SuggestArticlesRequest (4.33.0)

public final class SuggestArticlesRequest extends GeneratedMessageV3 implements SuggestArticlesRequestOrBuilder

The request message for Participants.SuggestArticles.

Protobuf type google.cloud.dialogflow.v2.SuggestArticlesRequest

Static Fields

ASSIST_QUERY_PARAMS_FIELD_NUMBER

public static final int ASSIST_QUERY_PARAMS_FIELD_NUMBER
Field Value
Type Description
int

CONTEXT_SIZE_FIELD_NUMBER

public static final int CONTEXT_SIZE_FIELD_NUMBER
Field Value
Type Description
int

LATEST_MESSAGE_FIELD_NUMBER

public static final int LATEST_MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SuggestArticlesRequest getDefaultInstance()
Returns
Type Description
SuggestArticlesRequest

getDescriptor()

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

newBuilder()

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

newBuilder(SuggestArticlesRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAssistQueryParams()

public AssistQueryParameters getAssistQueryParams()

Parameters for a human assist query.

.google.cloud.dialogflow.v2.AssistQueryParameters assist_query_params = 4;

Returns
Type Description
AssistQueryParameters

The assistQueryParams.

getAssistQueryParamsOrBuilder()

public AssistQueryParametersOrBuilder getAssistQueryParamsOrBuilder()

Parameters for a human assist query.

.google.cloud.dialogflow.v2.AssistQueryParameters assist_query_params = 4;

Returns
Type Description
AssistQueryParametersOrBuilder

getContextSize()

public int getContextSize()

Optional. Max number of messages prior to and including latest_message to use as context when compiling the suggestion. By default 20 and at most 50.

int32 context_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The contextSize.

getDefaultInstanceForType()

public SuggestArticlesRequest getDefaultInstanceForType()
Returns
Type Description
SuggestArticlesRequest

getLatestMessage()

public String getLatestMessage()

Optional. The name of the latest conversation message to compile suggestion for. If empty, it will be the latest message of the conversation.

Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>.

string latest_message = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The latestMessage.

getLatestMessageBytes()

public ByteString getLatestMessageBytes()

Optional. The name of the latest conversation message to compile suggestion for. If empty, it will be the latest message of the conversation.

Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID>.

string latest_message = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for latestMessage.

getParent()

public String getParent()

Required. The name of the participant to fetch suggestion for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The name of the participant to fetch suggestion for. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

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

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<SuggestArticlesRequest> getParserForType()
Returns
Type Description
Parser<SuggestArticlesRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasAssistQueryParams()

public boolean hasAssistQueryParams()

Parameters for a human assist query.

.google.cloud.dialogflow.v2.AssistQueryParameters assist_query_params = 4;

Returns
Type Description
boolean

Whether the assistQueryParams field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SuggestArticlesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SuggestArticlesRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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