Package com.google.cloud.aiplatform.v1
Class Session
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.Session
- All Implemented Interfaces:
SessionOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class Session
extends com.google.protobuf.GeneratedMessage
implements SessionOrBuilder
A session contains a set of actions between users and Vertex agents.Protobuf type
google.cloud.aiplatform.v1.Session- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA session contains a set of actions between users and Vertex agents.static enumNested 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 extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsLabels(String key) The labels with user-defined metadata to organize your Sessions.booleancom.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.static Sessionstatic final com.google.protobuf.Descriptors.DescriptorOptional.com.google.protobuf.ByteStringOptional.com.google.protobuf.TimestampOptional.com.google.protobuf.TimestampOrBuilderOptional.Deprecated.intThe labels with user-defined metadata to organize your Sessions.The labels with user-defined metadata to organize your Sessions.getLabelsOrDefault(String key, String defaultValue) The labels with user-defined metadata to organize your Sessions.getLabelsOrThrow(String key) The labels with user-defined metadata to organize your Sessions.getName()Identifier.com.google.protobuf.ByteStringIdentifier.com.google.protobuf.Parser<Session>intcom.google.protobuf.StructOptional.com.google.protobuf.StructOrBuilderOptional.com.google.protobuf.DurationgetTtl()Optional.com.google.protobuf.DurationOrBuilderOptional.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Required.com.google.protobuf.ByteStringRequired.booleanOutput only.booleanOptional.inthashCode()booleanOptional.booleanhasTtl()Optional.booleanOutput only.protected com.google.protobuf.GeneratedMessage.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) final booleanstatic Session.Builderstatic Session.BuildernewBuilder(Session prototype) protected Session.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static SessionparseDelimitedFrom(InputStream input) static SessionparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SessionparseFrom(byte[] data) static SessionparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SessionparseFrom(com.google.protobuf.ByteString data) static SessionparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SessionparseFrom(com.google.protobuf.CodedInputStream input) static SessionparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SessionparseFrom(InputStream input) static SessionparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static SessionparseFrom(ByteBuffer data) static SessionparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<Session>parser()voidwriteTo(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, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
EXPIRE_TIME_FIELD_NUMBER
public static final int EXPIRE_TIME_FIELD_NUMBER- See Also:
-
TTL_FIELD_NUMBER
public static final int TTL_FIELD_NUMBER- See Also:
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER- See Also:
-
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER- See Also:
-
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER- See Also:
-
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER- See Also:
-
SESSION_STATE_FIELD_NUMBER
public static final int SESSION_STATE_FIELD_NUMBER- See Also:
-
USER_ID_FIELD_NUMBER
public static final int USER_ID_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getExpirationCase
- Specified by:
getExpirationCasein interfaceSessionOrBuilder
-
hasExpireTime
public boolean hasExpireTime()Optional. Timestamp of when this session is considered expired. This is *always* provided on output, regardless of what was sent on input. The minimum value is 24 hours from the time of creation.
.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasExpireTimein interfaceSessionOrBuilder- Returns:
- Whether the expireTime field is set.
-
getExpireTime
public com.google.protobuf.Timestamp getExpireTime()Optional. Timestamp of when this session is considered expired. This is *always* provided on output, regardless of what was sent on input. The minimum value is 24 hours from the time of creation.
.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getExpireTimein interfaceSessionOrBuilder- Returns:
- The expireTime.
-
getExpireTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getExpireTimeOrBuilder()Optional. Timestamp of when this session is considered expired. This is *always* provided on output, regardless of what was sent on input. The minimum value is 24 hours from the time of creation.
.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getExpireTimeOrBuilderin interfaceSessionOrBuilder
-
hasTtl
public boolean hasTtl()Optional. Input only. The TTL for this session. The minimum value is 24 hours.
.google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];- Specified by:
hasTtlin interfaceSessionOrBuilder- Returns:
- Whether the ttl field is set.
-
getTtl
public com.google.protobuf.Duration getTtl()Optional. Input only. The TTL for this session. The minimum value is 24 hours.
.google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];- Specified by:
getTtlin interfaceSessionOrBuilder- Returns:
- The ttl.
-
getTtlOrBuilder
public com.google.protobuf.DurationOrBuilder getTtlOrBuilder()Optional. Input only. The TTL for this session. The minimum value is 24 hours.
.google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];- Specified by:
getTtlOrBuilderin interfaceSessionOrBuilder
-
getName
Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.string name = 1 [(.google.api.field_behavior) = IDENTIFIER];- Specified by:
getNamein interfaceSessionOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()Identifier. The resource name of the session. Format: 'projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}'.string name = 1 [(.google.api.field_behavior) = IDENTIFIER];- Specified by:
getNameBytesin interfaceSessionOrBuilder- Returns:
- The bytes for name.
-
hasCreateTime
public boolean hasCreateTime()Output only. Timestamp when the session was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasCreateTimein interfaceSessionOrBuilder- Returns:
- Whether the createTime field is set.
-
getCreateTime
public com.google.protobuf.Timestamp getCreateTime()Output only. Timestamp when the session was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreateTimein interfaceSessionOrBuilder- Returns:
- The createTime.
-
getCreateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()Output only. Timestamp when the session was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreateTimeOrBuilderin interfaceSessionOrBuilder
-
hasUpdateTime
public boolean hasUpdateTime()Output only. Timestamp when the session was updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasUpdateTimein interfaceSessionOrBuilder- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
public com.google.protobuf.Timestamp getUpdateTime()Output only. Timestamp when the session was updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUpdateTimein interfaceSessionOrBuilder- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()Output only. Timestamp when the session was updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUpdateTimeOrBuilderin interfaceSessionOrBuilder
-
getDisplayName
Optional. The display name of the session.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getDisplayNamein interfaceSessionOrBuilder- Returns:
- The displayName.
-
getDisplayNameBytes
public com.google.protobuf.ByteString getDisplayNameBytes()Optional. The display name of the session.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getDisplayNameBytesin interfaceSessionOrBuilder- Returns:
- The bytes for displayName.
-
getLabelsCount
public int getLabelsCount()Description copied from interface:SessionOrBuilderThe labels with user-defined metadata to organize your Sessions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
map<string, string> labels = 8;- Specified by:
getLabelsCountin interfaceSessionOrBuilder
-
containsLabels
The labels with user-defined metadata to organize your Sessions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
map<string, string> labels = 8;- Specified by:
containsLabelsin interfaceSessionOrBuilder
-
getLabels
Deprecated.UsegetLabelsMap()instead.- Specified by:
getLabelsin interfaceSessionOrBuilder
-
getLabelsMap
The labels with user-defined metadata to organize your Sessions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
map<string, string> labels = 8;- Specified by:
getLabelsMapin interfaceSessionOrBuilder
-
getLabelsOrDefault
The labels with user-defined metadata to organize your Sessions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
map<string, string> labels = 8;- Specified by:
getLabelsOrDefaultin interfaceSessionOrBuilder
-
getLabelsOrThrow
The labels with user-defined metadata to organize your Sessions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
map<string, string> labels = 8;- Specified by:
getLabelsOrThrowin interfaceSessionOrBuilder
-
hasSessionState
public boolean hasSessionState()Optional. Session specific memory which stores key conversation points.
.google.protobuf.Struct session_state = 10 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
hasSessionStatein interfaceSessionOrBuilder- Returns:
- Whether the sessionState field is set.
-
getSessionState
public com.google.protobuf.Struct getSessionState()Optional. Session specific memory which stores key conversation points.
.google.protobuf.Struct session_state = 10 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getSessionStatein interfaceSessionOrBuilder- Returns:
- The sessionState.
-
getSessionStateOrBuilder
public com.google.protobuf.StructOrBuilder getSessionStateOrBuilder()Optional. Session specific memory which stores key conversation points.
.google.protobuf.Struct session_state = 10 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getSessionStateOrBuilderin interfaceSessionOrBuilder
-
getUserId
Required. Immutable. String id provided by the user
string user_id = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];- Specified by:
getUserIdin interfaceSessionOrBuilder- Returns:
- The userId.
-
getUserIdBytes
public com.google.protobuf.ByteString getUserIdBytes()Required. Immutable. String id provided by the user
string user_id = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];- Specified by:
getUserIdBytesin interfaceSessionOrBuilder- Returns:
- The bytes for userId.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Session parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Session parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Session parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Session parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Session parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Session parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Session parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Session parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Session parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Session.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-