Package com.google.cloud.aiplatform.v1
Interface SessionOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Session,Session.Builder
@Generated
public interface SessionOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsLabels(String key) The labels with user-defined metadata to organize your Sessions.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Optional.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.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.booleanOptional.booleanhasTtl()Optional.booleanOutput only.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
hasExpireTime
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];- Returns:
- Whether the expireTime field is set.
-
getExpireTime
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];- Returns:
- The expireTime.
-
getExpireTimeOrBuilder
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]; -
hasTtl
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];- Returns:
- Whether the ttl field is set.
-
getTtl
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];- Returns:
- The ttl.
-
getTtlOrBuilder
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]; -
getName
String 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];- Returns:
- The name.
-
getNameBytes
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];- Returns:
- The bytes for name.
-
hasCreateTime
boolean hasCreateTime()Output only. Timestamp when the session was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the createTime field is set.
-
getCreateTime
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];- Returns:
- The createTime.
-
getCreateTimeOrBuilder
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]; -
hasUpdateTime
boolean hasUpdateTime()Output only. Timestamp when the session was updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
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];- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
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]; -
getDisplayName
String getDisplayName()Optional. The display name of the session.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The displayName.
-
getDisplayNameBytes
com.google.protobuf.ByteString getDisplayNameBytes()Optional. The display name of the session.
string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The bytes for displayName.
-
getLabelsCount
int getLabelsCount()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; -
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; -
getLabels
Deprecated.UsegetLabelsMap()instead. -
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; -
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; -
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; -
hasSessionState
boolean hasSessionState()Optional. Session specific memory which stores key conversation points.
.google.protobuf.Struct session_state = 10 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- Whether the sessionState field is set.
-
getSessionState
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];- Returns:
- The sessionState.
-
getSessionStateOrBuilder
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]; -
getUserId
String getUserId()Required. Immutable. String id provided by the user
string user_id = 12 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];- Returns:
- The userId.
-
getUserIdBytes
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];- Returns:
- The bytes for userId.
-
getExpirationCase
Session.ExpirationCase getExpirationCase()
-