Class GenerateMemoriesRequest (3.68.0)

public final class GenerateMemoriesRequest extends GeneratedMessageV3 implements GenerateMemoriesRequestOrBuilder

Request message for MemoryBankService.GenerateMemories.

Protobuf type google.cloud.aiplatform.v1beta1.GenerateMemoriesRequest

Static Fields

DIRECT_CONTENTS_SOURCE_FIELD_NUMBER

public static final int DIRECT_CONTENTS_SOURCE_FIELD_NUMBER
Field Value
Type Description
int

DISABLE_CONSOLIDATION_FIELD_NUMBER

public static final int DISABLE_CONSOLIDATION_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

SCOPE_FIELD_NUMBER

public static final int SCOPE_FIELD_NUMBER
Field Value
Type Description
int

VERTEX_SESSION_SOURCE_FIELD_NUMBER

public static final int VERTEX_SESSION_SOURCE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GenerateMemoriesRequest getDefaultInstance()
Returns
Type Description
GenerateMemoriesRequest

getDescriptor()

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

newBuilder()

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

newBuilder(GenerateMemoriesRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsScope(String key)

public boolean containsScope(String key)

Optional. The scope of the memories that should be generated. Memories will be consolidated across memories with the same scope. Must be provided unless the scope is defined in the source content. If scope is provided, it will override the scope defined in the source content. Scope values cannot contain the wildcard character '*'.

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

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

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

getDefaultInstanceForType()

public GenerateMemoriesRequest getDefaultInstanceForType()
Returns
Type Description
GenerateMemoriesRequest

getDirectContentsSource()

public GenerateMemoriesRequest.DirectContentsSource getDirectContentsSource()

Defines a direct source of content as the source content from which to generate memories.

.google.cloud.aiplatform.v1beta1.GenerateMemoriesRequest.DirectContentsSource direct_contents_source = 3;

Returns
Type Description
GenerateMemoriesRequest.DirectContentsSource

The directContentsSource.

getDirectContentsSourceOrBuilder()

public GenerateMemoriesRequest.DirectContentsSourceOrBuilder getDirectContentsSourceOrBuilder()

Defines a direct source of content as the source content from which to generate memories.

.google.cloud.aiplatform.v1beta1.GenerateMemoriesRequest.DirectContentsSource direct_contents_source = 3;

Returns
Type Description
GenerateMemoriesRequest.DirectContentsSourceOrBuilder

getDisableConsolidation()

public boolean getDisableConsolidation()

Optional. If true, generated memories will not be consolidated with existing memories; all generated memories will be added as new memories regardless of whether they are duplicates of or contradictory to existing memories. By default, memory consolidation is enabled.

bool disable_consolidation = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The disableConsolidation.

getParent()

public String getParent()

Required. The resource name of the ReasoningEngine to generate memories for. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the ReasoningEngine to generate memories for. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

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

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

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

getScope() (deprecated)

public Map<String,String> getScope()

Use #getScopeMap() instead.

Returns
Type Description
Map<String,String>

getScopeCount()

public int getScopeCount()

Optional. The scope of the memories that should be generated. Memories will be consolidated across memories with the same scope. Must be provided unless the scope is defined in the source content. If scope is provided, it will override the scope defined in the source content. Scope values cannot contain the wildcard character '*'.

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

Returns
Type Description
int

getScopeMap()

public Map<String,String> getScopeMap()

Optional. The scope of the memories that should be generated. Memories will be consolidated across memories with the same scope. Must be provided unless the scope is defined in the source content. If scope is provided, it will override the scope defined in the source content. Scope values cannot contain the wildcard character '*'.

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

Returns
Type Description
Map<String,String>

getScopeOrDefault(String key, String defaultValue)

public String getScopeOrDefault(String key, String defaultValue)

Optional. The scope of the memories that should be generated. Memories will be consolidated across memories with the same scope. Must be provided unless the scope is defined in the source content. If scope is provided, it will override the scope defined in the source content. Scope values cannot contain the wildcard character '*'.

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getScopeOrThrow(String key)

public String getScopeOrThrow(String key)

Optional. The scope of the memories that should be generated. Memories will be consolidated across memories with the same scope. Must be provided unless the scope is defined in the source content. If scope is provided, it will override the scope defined in the source content. Scope values cannot contain the wildcard character '*'.

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

Parameter
Name Description
key String
Returns
Type Description
String

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSourceCase()

public GenerateMemoriesRequest.SourceCase getSourceCase()
Returns
Type Description
GenerateMemoriesRequest.SourceCase

getVertexSessionSource()

public GenerateMemoriesRequest.VertexSessionSource getVertexSessionSource()

Defines a Vertex Session as the source content from which to generate memories.

.google.cloud.aiplatform.v1beta1.GenerateMemoriesRequest.VertexSessionSource vertex_session_source = 2;

Returns
Type Description
GenerateMemoriesRequest.VertexSessionSource

The vertexSessionSource.

getVertexSessionSourceOrBuilder()

public GenerateMemoriesRequest.VertexSessionSourceOrBuilder getVertexSessionSourceOrBuilder()

Defines a Vertex Session as the source content from which to generate memories.

.google.cloud.aiplatform.v1beta1.GenerateMemoriesRequest.VertexSessionSource vertex_session_source = 2;

Returns
Type Description
GenerateMemoriesRequest.VertexSessionSourceOrBuilder

hasDirectContentsSource()

public boolean hasDirectContentsSource()

Defines a direct source of content as the source content from which to generate memories.

.google.cloud.aiplatform.v1beta1.GenerateMemoriesRequest.DirectContentsSource direct_contents_source = 3;

Returns
Type Description
boolean

Whether the directContentsSource field is set.

hasVertexSessionSource()

public boolean hasVertexSessionSource()

Defines a Vertex Session as the source content from which to generate memories.

.google.cloud.aiplatform.v1beta1.GenerateMemoriesRequest.VertexSessionSource vertex_session_source = 2;

Returns
Type Description
boolean

Whether the vertexSessionSource field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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