Class ListChunksRequest.Builder (0.35.0)

public static final class ListChunksRequest.Builder extends GeneratedMessageV3.Builder<ListChunksRequest.Builder> implements ListChunksRequestOrBuilder

Request message for ChunkService.ListChunks method.

Protobuf type google.cloud.discoveryengine.v1alpha.ListChunksRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListChunksRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListChunksRequest.Builder
Overrides

build()

public ListChunksRequest build()
Returns
TypeDescription
ListChunksRequest

buildPartial()

public ListChunksRequest buildPartial()
Returns
TypeDescription
ListChunksRequest

clear()

public ListChunksRequest.Builder clear()
Returns
TypeDescription
ListChunksRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListChunksRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListChunksRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ListChunksRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListChunksRequest.Builder
Overrides

clearPageSize()

public ListChunksRequest.Builder clearPageSize()

Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT error is returned.

int32 page_size = 2;

Returns
TypeDescription
ListChunksRequest.Builder

This builder for chaining.

clearPageToken()

public ListChunksRequest.Builder clearPageToken()

A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

string page_token = 3;

Returns
TypeDescription
ListChunksRequest.Builder

This builder for chaining.

clearParent()

public ListChunksRequest.Builder clearParent()

Required. The parent document resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.

If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a PERMISSION_DENIED error is returned.

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

Returns
TypeDescription
ListChunksRequest.Builder

This builder for chaining.

clone()

public ListChunksRequest.Builder clone()
Returns
TypeDescription
ListChunksRequest.Builder
Overrides

getDefaultInstanceForType()

public ListChunksRequest getDefaultInstanceForType()
Returns
TypeDescription
ListChunksRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getPageSize()

public int getPageSize()

Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT error is returned.

int32 page_size = 2;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

string page_token = 3;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

string page_token = 3;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The parent document resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.

If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a PERMISSION_DENIED error is returned.

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

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent document resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.

If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a PERMISSION_DENIED error is returned.

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

Returns
TypeDescription
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListChunksRequest other)

public ListChunksRequest.Builder mergeFrom(ListChunksRequest other)
Parameter
NameDescription
otherListChunksRequest
Returns
TypeDescription
ListChunksRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListChunksRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListChunksRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListChunksRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListChunksRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListChunksRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListChunksRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListChunksRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListChunksRequest.Builder
Overrides

setPageSize(int value)

public ListChunksRequest.Builder setPageSize(int value)

Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT error is returned.

int32 page_size = 2;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListChunksRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListChunksRequest.Builder setPageToken(String value)

A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

string page_token = 3;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListChunksRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListChunksRequest.Builder setPageTokenBytes(ByteString value)

A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

string page_token = 3;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListChunksRequest.Builder

This builder for chaining.

setParent(String value)

public ListChunksRequest.Builder setParent(String value)

Required. The parent document resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.

If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a PERMISSION_DENIED error is returned.

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

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListChunksRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListChunksRequest.Builder setParentBytes(ByteString value)

Required. The parent document resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.

If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a PERMISSION_DENIED error is returned.

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

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListChunksRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListChunksRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListChunksRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListChunksRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListChunksRequest.Builder
Overrides