Class ListMemoriesRequest (3.68.0)

public final class ListMemoriesRequest extends GeneratedMessageV3 implements ListMemoriesRequestOrBuilder

Request message for MemoryBankService.ListMemories.

Protobuf type google.cloud.aiplatform.v1beta1.ListMemoriesRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListMemoriesRequest getDefaultInstance()
Returns
Type Description
ListMemoriesRequest

getDescriptor()

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

newBuilder()

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

newBuilder(ListMemoriesRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ListMemoriesRequest getDefaultInstanceForType()
Returns
Type Description
ListMemoriesRequest

getFilter()

public String getFilter()

Optional. The standard list filter. More detail in AIP-160.

Supported fields (equality match only):

  • scope (as a JSON string)

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. The standard list filter. More detail in AIP-160.

Supported fields (equality match only):

  • scope (as a JSON string)

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

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

Optional. The standard list page size.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. The standard list page token.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. The standard list page token.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The resource name of the ReasoningEngine to list the Memories under. 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 list the Memories under. 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<ListMemoriesRequest> getParserForType()
Returns
Type Description
Parser<ListMemoriesRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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