public static final class ListChunksRequest.Builder extends GeneratedMessageV3.Builder<ListChunksRequest.Builder> implements ListChunksRequestOrBuilderRequest message for ChunkService.ListChunks method.
Protobuf type google.cloud.discoveryengine.v1alpha.ListChunksRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListChunksRequest.BuilderImplements
ListChunksRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListChunksRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ListChunksRequest.Builder | |
build()
public ListChunksRequest build()| Returns | |
|---|---|
| Type | Description |
ListChunksRequest | |
buildPartial()
public ListChunksRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListChunksRequest | |
clear()
public ListChunksRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListChunksRequest.Builder | |
clearField(Descriptors.FieldDescriptor field)
public ListChunksRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListChunksRequest.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListChunksRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListChunksRequest.Builder | |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ListChunksRequest.Builder | This builder for chaining. |
clone()
public ListChunksRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ListChunksRequest.Builder | |
getDefaultInstanceForType()
public ListChunksRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListChunksRequest | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString | The bytes for parent. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(ListChunksRequest other)
public ListChunksRequest.Builder mergeFrom(ListChunksRequest other)| Parameter | |
|---|---|
| Name | Description |
other | ListChunksRequest |
| Returns | |
|---|---|
| Type | Description |
ListChunksRequest.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListChunksRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListChunksRequest.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public ListChunksRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
ListChunksRequest.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListChunksRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListChunksRequest.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public ListChunksRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ListChunksRequest.Builder | |
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 | |
|---|---|
| Name | Description |
value | intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
ListChunksRequest.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListChunksRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListChunksRequest.Builder | |