Class ListRagMetadataRequest.Builder (3.89.0)

public static final class ListRagMetadataRequest.Builder extends GeneratedMessage.Builder<ListRagMetadataRequest.Builder> implements ListRagMetadataRequestOrBuilder

Request message for VertexRagDataService.ListRagMetadata.

Protobuf type google.cloud.aiplatform.v1beta1.ListRagMetadataRequest

Static Methods

getDescriptor()

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

Methods

build()

public ListRagMetadataRequest build()
Returns
Type Description
ListRagMetadataRequest

buildPartial()

public ListRagMetadataRequest buildPartial()
Returns
Type Description
ListRagMetadataRequest

clear()

public ListRagMetadataRequest.Builder clear()
Returns
Type Description
ListRagMetadataRequest.Builder
Overrides

clearPageSize()

public ListRagMetadataRequest.Builder clearPageSize()

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
ListRagMetadataRequest.Builder

This builder for chaining.

clearPageToken()

public ListRagMetadataRequest.Builder clearPageToken()

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
ListRagMetadataRequest.Builder

This builder for chaining.

clearParent()

public ListRagMetadataRequest.Builder clearParent()

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
ListRagMetadataRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListRagMetadataRequest getDefaultInstanceForType()
Returns
Type Description
ListRagMetadataRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListRagMetadataRequest other)

public ListRagMetadataRequest.Builder mergeFrom(ListRagMetadataRequest other)
Parameter
Name Description
other ListRagMetadataRequest
Returns
Type Description
ListRagMetadataRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListRagMetadataRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListRagMetadataRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListRagMetadataRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListRagMetadataRequest.Builder
Overrides

setPageSize(int value)

public ListRagMetadataRequest.Builder setPageSize(int value)

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];

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListRagMetadataRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListRagMetadataRequest.Builder setPageToken(String value)

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];

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListRagMetadataRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListRagMetadataRequest.Builder setPageTokenBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListRagMetadataRequest.Builder

This builder for chaining.

setParent(String value)

public ListRagMetadataRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListRagMetadataRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListRagMetadataRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListRagMetadataRequest.Builder

This builder for chaining.