Interface MemoryOrBuilder (3.100.0) 

public interface MemoryOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsMetadata(String key)

public abstract boolean containsMetadata(String key)

Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.

map<string, .google.cloud.aiplatform.v1beta1.MemoryMetadataValue> metadata = 21 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

containsRevisionLabels(String key)

public abstract boolean containsRevisionLabels(String key)

Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.

map<string, string> revision_labels = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
boolean

containsScope(String key)

public abstract boolean containsScope(String key)

Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.

map<string, string> scope = 11 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
key String
Returns
Type Description
boolean

getContext()

public abstract String getContext()

Optional. Represents the context of the memory.

string context = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The context.

getContextBytes()

public abstract ByteString getContextBytes()

Optional. Represents the context of the memory.

string context = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for context.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Represents the timestamp when this Memory was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Represents the timestamp when this Memory was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDescription()

public abstract String getDescription()

Optional. Represents the description of the Memory.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. Represents the description of the Memory.

string description = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDisableMemoryRevisions()

public abstract boolean getDisableMemoryRevisions()

Optional. Input only. Indicates whether no revision will be created for this request.

bool disable_memory_revisions = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

The disableMemoryRevisions.

getDisplayName()

public abstract String getDisplayName()

Optional. Represents the display name of the Memory.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Optional. Represents the display name of the Memory.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getExpirationCase()

public abstract Memory.ExpirationCase getExpirationCase()
Returns
Type Description
Memory.ExpirationCase

getExpireTime()

public abstract Timestamp getExpireTime()

Optional. Represents the timestamp of when this resource is considered expired. This is always provided on output when expiration is set on input, regardless of whether expire_time or ttl was provided.

.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Timestamp

The expireTime.

getExpireTimeOrBuilder()

public abstract TimestampOrBuilder getExpireTimeOrBuilder()

Optional. Represents the timestamp of when this resource is considered expired. This is always provided on output when expiration is set on input, regardless of whether expire_time or ttl was provided.

.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimestampOrBuilder

getFact()

public abstract String getFact()

Optional. Represents semantic knowledge extracted from the source content.

string fact = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The fact.

getFactBytes()

public abstract ByteString getFactBytes()

Optional. Represents semantic knowledge extracted from the source content.

string fact = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for fact.

getMemoryType()

public abstract MemoryType getMemoryType()

Optional. Represents the type of the memory. If not set, the NATURAL_LANGUAGE_COLLECTION type is used. If STRUCTURED_COLLECTION or STRUCTURED_PROFILE is used, then structured_data must be provided.

.google.cloud.aiplatform.v1beta1.MemoryType memory_type = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MemoryType

The memoryType.

getMemoryTypeValue()

public abstract int getMemoryTypeValue()

Optional. Represents the type of the memory. If not set, the NATURAL_LANGUAGE_COLLECTION type is used. If STRUCTURED_COLLECTION or STRUCTURED_PROFILE is used, then structured_data must be provided.

.google.cloud.aiplatform.v1beta1.MemoryType memory_type = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for memoryType.

getMetadata() (deprecated)

public abstract Map<String,MemoryMetadataValue> getMetadata()

Use #getMetadataMap() instead.

Returns
Type Description
Map<String,MemoryMetadataValue>

getMetadataCount()

public abstract int getMetadataCount()

Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.

map<string, .google.cloud.aiplatform.v1beta1.MemoryMetadataValue> metadata = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getMetadataMap()

public abstract Map<String,MemoryMetadataValue> getMetadataMap()

Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.

map<string, .google.cloud.aiplatform.v1beta1.MemoryMetadataValue> metadata = 21 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,MemoryMetadataValue>

getMetadataOrDefault(String key, MemoryMetadataValue defaultValue)

public abstract MemoryMetadataValue getMetadataOrDefault(String key, MemoryMetadataValue defaultValue)

Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.

map<string, .google.cloud.aiplatform.v1beta1.MemoryMetadataValue> metadata = 21 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue MemoryMetadataValue
Returns
Type Description
MemoryMetadataValue

getMetadataOrThrow(String key)

public abstract MemoryMetadataValue getMetadataOrThrow(String key)

Optional. Represents user-provided metadata for the Memory. This information was provided when creating, updating, or generating the Memory. It was not generated by Memory Bank.

map<string, .google.cloud.aiplatform.v1beta1.MemoryMetadataValue> metadata = 21 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
MemoryMetadataValue

getName()

public abstract String getName()

Identifier. Represents the resource name of the Memory. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. Represents the resource name of the Memory. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getRevisionExpirationCase()

public abstract Memory.RevisionExpirationCase getRevisionExpirationCase()
Returns
Type Description
Memory.RevisionExpirationCase

getRevisionExpireTime()

public abstract Timestamp getRevisionExpireTime()

Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.

.google.protobuf.Timestamp revision_expire_time = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
Timestamp

The revisionExpireTime.

getRevisionExpireTimeOrBuilder()

public abstract TimestampOrBuilder getRevisionExpireTimeOrBuilder()

Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.

.google.protobuf.Timestamp revision_expire_time = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getRevisionLabels() (deprecated)

public abstract Map<String,String> getRevisionLabels()

Use #getRevisionLabelsMap() instead.

Returns
Type Description
Map<String,String>

getRevisionLabelsCount()

public abstract int getRevisionLabelsCount()

Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.

map<string, string> revision_labels = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
int

getRevisionLabelsMap()

public abstract Map<String,String> getRevisionLabelsMap()

Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.

map<string, string> revision_labels = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
Map<String,String>

getRevisionLabelsOrDefault(String key, String defaultValue)

public abstract String getRevisionLabelsOrDefault(String key, String defaultValue)

Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.

map<string, string> revision_labels = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getRevisionLabelsOrThrow(String key)

public abstract String getRevisionLabelsOrThrow(String key)

Optional. Input only. Represents the labels to apply to the Memory Revision created as a result of this request.

map<string, string> revision_labels = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name Description
key String
Returns
Type Description
String

getRevisionTtl()

public abstract Duration getRevisionTtl()

Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.

.google.protobuf.Duration revision_ttl = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
Duration

The revisionTtl.

getRevisionTtlOrBuilder()

public abstract DurationOrBuilder getRevisionTtlOrBuilder()

Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.

.google.protobuf.Duration revision_ttl = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
DurationOrBuilder

getScope() (deprecated)

public abstract Map<String,String> getScope()

Use #getScopeMap() instead.

Returns
Type Description
Map<String,String>

getScopeCount()

public abstract int getScopeCount()

Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.

map<string, string> scope = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getScopeMap()

public abstract Map<String,String> getScopeMap()

Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.

map<string, string> scope = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Map<String,String>

getScopeOrDefault(String key, String defaultValue)

public abstract String getScopeOrDefault(String key, String defaultValue)

Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.

map<string, string> scope = 11 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getScopeOrThrow(String key)

public abstract String getScopeOrThrow(String key)

Required. Immutable. Represents the scope of the Memory. Memories are isolated within their scope. The scope is defined when creating or generating memories. Scope values cannot contain the wildcard character '*'.

map<string, string> scope = 11 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
key String
Returns
Type Description
String

getStructuredContent()

public abstract Memory.StructuredContent getStructuredContent()

Optional. Represents the structured content of the memory.

.google.cloud.aiplatform.v1beta1.Memory.StructuredContent structured_content = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Memory.StructuredContent

The structuredContent.

getStructuredContentOrBuilder()

public abstract Memory.StructuredContentOrBuilder getStructuredContentOrBuilder()

Optional. Represents the structured content of the memory.

.google.cloud.aiplatform.v1beta1.Memory.StructuredContent structured_content = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Memory.StructuredContentOrBuilder

getTopics(int index)

public abstract MemoryTopicId getTopics(int index)

Optional. Represents the Topics of the Memory.

repeated .google.cloud.aiplatform.v1beta1.MemoryTopicId topics = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
MemoryTopicId

getTopicsCount()

public abstract int getTopicsCount()

Optional. Represents the Topics of the Memory.

repeated .google.cloud.aiplatform.v1beta1.MemoryTopicId topics = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getTopicsList()

public abstract List<MemoryTopicId> getTopicsList()

Optional. Represents the Topics of the Memory.

repeated .google.cloud.aiplatform.v1beta1.MemoryTopicId topics = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<MemoryTopicId>

getTopicsOrBuilder(int index)

public abstract MemoryTopicIdOrBuilder getTopicsOrBuilder(int index)

Optional. Represents the Topics of the Memory.

repeated .google.cloud.aiplatform.v1beta1.MemoryTopicId topics = 15 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
MemoryTopicIdOrBuilder

getTopicsOrBuilderList()

public abstract List<? extends MemoryTopicIdOrBuilder> getTopicsOrBuilderList()

Optional. Represents the Topics of the Memory.

repeated .google.cloud.aiplatform.v1beta1.MemoryTopicId topics = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1beta1.MemoryTopicIdOrBuilder>

getTtl()

public abstract Duration getTtl()

Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.

.google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Duration

The ttl.

getTtlOrBuilder()

public abstract DurationOrBuilder getTtlOrBuilder()

Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.

.google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Represents the timestamp when this Memory was most recently updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Represents the timestamp when this Memory was most recently updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Represents the timestamp when this Memory was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasDisableMemoryRevisions()

public abstract boolean hasDisableMemoryRevisions()

Optional. Input only. Indicates whether no revision will be created for this request.

bool disable_memory_revisions = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

Whether the disableMemoryRevisions field is set.

hasExpireTime()

public abstract boolean hasExpireTime()

Optional. Represents the timestamp of when this resource is considered expired. This is always provided on output when expiration is set on input, regardless of whether expire_time or ttl was provided.

.google.protobuf.Timestamp expire_time = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the expireTime field is set.

hasRevisionExpireTime()

public abstract boolean hasRevisionExpireTime()

Optional. Input only. Represents the timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.

.google.protobuf.Timestamp revision_expire_time = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

Whether the revisionExpireTime field is set.

hasRevisionTtl()

public abstract boolean hasRevisionTtl()

Optional. Input only. Represents the TTL for the revision. The expiration time is computed: now + TTL.

.google.protobuf.Duration revision_ttl = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type Description
boolean

Whether the revisionTtl field is set.

hasStructuredContent()

public abstract boolean hasStructuredContent()

Optional. Represents the structured content of the memory.

.google.cloud.aiplatform.v1beta1.Memory.StructuredContent structured_content = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the structuredContent field is set.

hasTtl()

public abstract boolean hasTtl()

Optional. Input only. Represents the TTL for this resource. The expiration time is computed: now + TTL.

.google.protobuf.Duration ttl = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the ttl field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Represents the timestamp when this Memory was most recently updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.