Class ListRagMetadataRequest (3.89.0)

public final class ListRagMetadataRequest extends GeneratedMessage implements ListRagMetadataRequestOrBuilder

Request message for VertexRagDataService.ListRagMetadata.

Protobuf type google.cloud.aiplatform.v1beta1.ListRagMetadataRequest

Static Fields

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 ListRagMetadataRequest getDefaultInstance()
Returns
Type Description
ListRagMetadataRequest

getDescriptor()

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

newBuilder()

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

newBuilder(ListRagMetadataRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ListRagMetadataRequest getDefaultInstanceForType()
Returns
Type Description
ListRagMetadataRequest

getPageSize()

public int getPageSize()

Optional. The standard list page size. The maximum value is 100. If not specified, a default value of 100 will be used.

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

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. The standard list page token. Typically obtained via ListRagMetadataResponse.next_page_token of the previous VertexRagDataService.ListRagMetadata call.

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

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. The standard list page token. Typically obtained via ListRagMetadataResponse.next_page_token of the previous VertexRagDataService.ListRagMetadata call.

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The resource name of the RagFile from which to list the RagMetadata. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}

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 RagFile from which to list the RagMetadata. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}

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

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ListRagMetadataRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListRagMetadataRequest.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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