com.google.cloud.discoveryengine.v1

Class StreamAssistRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.discoveryengine.v1.StreamAssistRequest

All Implemented Interfaces:

StreamAssistRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated
public final class StreamAssistRequest
extends com.google.protobuf.GeneratedMessage
implements StreamAssistRequestOrBuilder

 Request for the
 [AssistantService.StreamAssist][google.cloud.discoveryengine.v1.AssistantService.StreamAssist]
 method.
 

Protobuf type google.cloud.discoveryengine.v1.StreamAssistRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StreamAssistRequest.Builder Request for the [AssistantService.StreamAssist][google.cloud.discoveryengine.v1.AssistantService.StreamAssist] method.
static class	StreamAssistRequest.GenerationSpec Assistant generation specification for the request.
static interface	StreamAssistRequest.GenerationSpecOrBuilder
static class	StreamAssistRequest.ToolsSpec Specification of tools that are used to serve the request.
static interface	StreamAssistRequest.ToolsSpecOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	GENERATION_SPEC_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	QUERY_FIELD_NUMBER
static int	SESSION_FIELD_NUMBER
static int	TOOLS_SPEC_FIELD_NUMBER
static int	USER_METADATA_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static StreamAssistRequest	getDefaultInstance()
StreamAssistRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
StreamAssistRequest.GenerationSpec	getGenerationSpec() Optional.
StreamAssistRequest.GenerationSpecOrBuilder	getGenerationSpecOrBuilder() Optional.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
com.google.protobuf.Parser<StreamAssistRequest>	getParserForType()
Query	getQuery() Optional.
QueryOrBuilder	getQueryOrBuilder() Optional.
int	getSerializedSize()
String	getSession() Optional.
com.google.protobuf.ByteString	getSessionBytes() Optional.
StreamAssistRequest.ToolsSpec	getToolsSpec() Optional.
StreamAssistRequest.ToolsSpecOrBuilder	getToolsSpecOrBuilder() Optional.
AssistUserMetadata	getUserMetadata() Optional.
AssistUserMetadataOrBuilder	getUserMetadataOrBuilder() Optional.
boolean	hasGenerationSpec() Optional.
int	hashCode()
boolean	hasQuery() Optional.
boolean	hasToolsSpec() Optional.
boolean	hasUserMetadata() Optional.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static StreamAssistRequest.Builder	newBuilder()
static StreamAssistRequest.Builder	newBuilder(StreamAssistRequest prototype)
StreamAssistRequest.Builder	newBuilderForType()
protected StreamAssistRequest.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static StreamAssistRequest	parseDelimitedFrom(InputStream input)
static StreamAssistRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamAssistRequest	parseFrom(byte[] data)
static StreamAssistRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamAssistRequest	parseFrom(ByteBuffer data)
static StreamAssistRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamAssistRequest	parseFrom(com.google.protobuf.ByteString data)
static StreamAssistRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamAssistRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static StreamAssistRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StreamAssistRequest	parseFrom(InputStream input)
static StreamAssistRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<StreamAssistRequest>	parser()
StreamAssistRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER

See Also:

Constant Field Values

SESSION_FIELD_NUMBER

public static final int SESSION_FIELD_NUMBER

See Also:

Constant Field Values

USER_METADATA_FIELD_NUMBER

public static final int USER_METADATA_FIELD_NUMBER

See Also:

Constant Field Values

TOOLS_SPEC_FIELD_NUMBER

public static final int TOOLS_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

GENERATION_SPEC_FIELD_NUMBER

public static final int GENERATION_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getName

public String getName()

 Required. The resource name of the
 [Assistant][google.cloud.discoveryengine.v1.Assistant]. Format:
 `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
 

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

Specified by:

getName in interface StreamAssistRequestOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Required. The resource name of the
 [Assistant][google.cloud.discoveryengine.v1.Assistant]. Format:
 `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
 

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

Specified by:

getNameBytes in interface StreamAssistRequestOrBuilder

Returns:

The bytes for name.

hasQuery

public boolean hasQuery()

 Optional. Current user query.

 Empty query is only supported if `file_ids` are provided. In this case, the
 answer will be generated based on those context files.
 

.google.cloud.discoveryengine.v1.Query query = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasQuery in interface StreamAssistRequestOrBuilder

Returns:

Whether the query field is set.

getQuery

public Query getQuery()

 Optional. Current user query.

 Empty query is only supported if `file_ids` are provided. In this case, the
 answer will be generated based on those context files.
 

.google.cloud.discoveryengine.v1.Query query = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getQuery in interface StreamAssistRequestOrBuilder

Returns:

The query.

getQueryOrBuilder

public QueryOrBuilder getQueryOrBuilder()

 Optional. Current user query.

 Empty query is only supported if `file_ids` are provided. In this case, the
 answer will be generated based on those context files.
 

.google.cloud.discoveryengine.v1.Query query = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getQueryOrBuilder in interface StreamAssistRequestOrBuilder

getSession

public String getSession()

 Optional. The session to use for the request. If specified, the assistant
 has access to the session history, and the query and the answer are stored
 there.

 If `-` is specified as the session ID, or it is left empty, then a new
 session is created with an automatically generated ID.

 Format:
 `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
 

string session = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Specified by:

getSession in interface StreamAssistRequestOrBuilder

Returns:

The session.

getSessionBytes

public com.google.protobuf.ByteString getSessionBytes()

 Optional. The session to use for the request. If specified, the assistant
 has access to the session history, and the query and the answer are stored
 there.

 If `-` is specified as the session ID, or it is left empty, then a new
 session is created with an automatically generated ID.

 Format:
 `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
 

string session = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Specified by:

getSessionBytes in interface StreamAssistRequestOrBuilder

Returns:

The bytes for session.

hasUserMetadata

public boolean hasUserMetadata()

 Optional. Information about the user initiating the query.
 

.google.cloud.discoveryengine.v1.AssistUserMetadata user_metadata = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasUserMetadata in interface StreamAssistRequestOrBuilder

Returns:

Whether the userMetadata field is set.

getUserMetadata

public AssistUserMetadata getUserMetadata()

 Optional. Information about the user initiating the query.
 

.google.cloud.discoveryengine.v1.AssistUserMetadata user_metadata = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getUserMetadata in interface StreamAssistRequestOrBuilder

Returns:

The userMetadata.

getUserMetadataOrBuilder

public AssistUserMetadataOrBuilder getUserMetadataOrBuilder()

 Optional. Information about the user initiating the query.
 

.google.cloud.discoveryengine.v1.AssistUserMetadata user_metadata = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getUserMetadataOrBuilder in interface StreamAssistRequestOrBuilder

hasToolsSpec

public boolean hasToolsSpec()

 Optional. Specification of tools that are used to serve the request.
 

.google.cloud.discoveryengine.v1.StreamAssistRequest.ToolsSpec tools_spec = 18 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasToolsSpec in interface StreamAssistRequestOrBuilder

Returns:

Whether the toolsSpec field is set.

getToolsSpec

public StreamAssistRequest.ToolsSpec getToolsSpec()

 Optional. Specification of tools that are used to serve the request.
 

.google.cloud.discoveryengine.v1.StreamAssistRequest.ToolsSpec tools_spec = 18 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getToolsSpec in interface StreamAssistRequestOrBuilder

Returns:

The toolsSpec.

getToolsSpecOrBuilder

public StreamAssistRequest.ToolsSpecOrBuilder getToolsSpecOrBuilder()

 Optional. Specification of tools that are used to serve the request.
 

.google.cloud.discoveryengine.v1.StreamAssistRequest.ToolsSpec tools_spec = 18 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getToolsSpecOrBuilder in interface StreamAssistRequestOrBuilder

hasGenerationSpec

public boolean hasGenerationSpec()

 Optional. Specification of the generation configuration for the request.
 

.google.cloud.discoveryengine.v1.StreamAssistRequest.GenerationSpec generation_spec = 19 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasGenerationSpec in interface StreamAssistRequestOrBuilder

Returns:

Whether the generationSpec field is set.

getGenerationSpec

public StreamAssistRequest.GenerationSpec getGenerationSpec()

 Optional. Specification of the generation configuration for the request.
 

.google.cloud.discoveryengine.v1.StreamAssistRequest.GenerationSpec generation_spec = 19 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getGenerationSpec in interface StreamAssistRequestOrBuilder

Returns:

The generationSpec.

getGenerationSpecOrBuilder

public StreamAssistRequest.GenerationSpecOrBuilder getGenerationSpecOrBuilder()

 Optional. Specification of the generation configuration for the request.
 

.google.cloud.discoveryengine.v1.StreamAssistRequest.GenerationSpec generation_spec = 19 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getGenerationSpecOrBuilder in interface StreamAssistRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static StreamAssistRequest parseFrom(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamAssistRequest parseFrom(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamAssistRequest parseFrom(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamAssistRequest parseFrom(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamAssistRequest parseFrom(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamAssistRequest parseFrom(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StreamAssistRequest parseFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static StreamAssistRequest parseFrom(InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static StreamAssistRequest parseDelimitedFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static StreamAssistRequest parseDelimitedFrom(InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

parseFrom

public static StreamAssistRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static StreamAssistRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

newBuilderForType

public StreamAssistRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static StreamAssistRequest.Builder newBuilder()

newBuilder

public static StreamAssistRequest.Builder newBuilder(StreamAssistRequest prototype)

toBuilder

public StreamAssistRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected StreamAssistRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static StreamAssistRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<StreamAssistRequest> parser()

getParserForType

public com.google.protobuf.Parser<StreamAssistRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public StreamAssistRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder