Class ListDocumentsRequest.Builder (4.13.0)

Version 4.13.0

• 4.58.0 (latest)
• 4.57.0
• 4.55.0
• 4.54.0
• 4.53.0
• 4.52.0
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.47.0
• 4.46.0
• 4.45.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.33.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.23.0
• 4.22.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.1
• 4.8.6
• 4.7.5
• 4.6.0
• 4.5.11
• 4.4.0
• 4.3.1

public static final class ListDocumentsRequest.Builder extends GeneratedMessageV3.Builder<ListDocumentsRequest.Builder> implements ListDocumentsRequestOrBuilder

Request message for Documents.ListDocuments.

Protobuf type google.cloud.dialogflow.v2.ListDocumentsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListDocumentsRequest.Builder

Implements

ListDocumentsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListDocumentsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
ListDocumentsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ListDocumentsRequest build()

Returns

Type	Description
ListDocumentsRequest

buildPartial()

public ListDocumentsRequest buildPartial()

Returns

Type	Description
ListDocumentsRequest

clear()

public ListDocumentsRequest.Builder clear()

Returns

Type	Description
ListDocumentsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public ListDocumentsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
ListDocumentsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFilter()

public ListDocumentsRequest.Builder clearFilter()

The filter expression used to filter documents returned by the list method. The expression has the following syntax: <field> <operator> <value> [AND <field> <operator> <value>] ... The following fields and operators are supported:

• knowledge_types with has(:) operator
• display_name with has(:) operator
• state with equals(=) operator Examples:
• "knowledge_types:FAQ" matches documents with FAQ knowledge type.
• "display_name:customer" matches documents whose display name contains "customer".
• "state=ACTIVE" matches documents with ACTIVE state.
• "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents. For more information about filtering, see API Filtering.

string filter = 4;

Returns

Type	Description
ListDocumentsRequest.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListDocumentsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
ListDocumentsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPageSize()

public ListDocumentsRequest.Builder clearPageSize()

The maximum number of items to return in a single page. By default 10 and at most 100.

int32 page_size = 2;

Returns

Type	Description
ListDocumentsRequest.Builder	This builder for chaining.

clearPageToken()

public ListDocumentsRequest.Builder clearPageToken()

The next_page_token value returned from a previous list request.

string page_token = 3;

Returns

Type	Description
ListDocumentsRequest.Builder	This builder for chaining.

clearParent()

public ListDocumentsRequest.Builder clearParent()

Required. The knowledge base to list all documents for. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>.

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

Returns

Type	Description
ListDocumentsRequest.Builder	This builder for chaining.

clone()

public ListDocumentsRequest.Builder clone()

Returns

Type	Description
ListDocumentsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ListDocumentsRequest getDefaultInstanceForType()

Returns

Type	Description
ListDocumentsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFilter()

public String getFilter()

The filter expression used to filter documents returned by the list method. The expression has the following syntax: <field> <operator> <value> [AND <field> <operator> <value>] ... The following fields and operators are supported:

• knowledge_types with has(:) operator
• display_name with has(:) operator
• state with equals(=) operator Examples:
• "knowledge_types:FAQ" matches documents with FAQ knowledge type.
• "display_name:customer" matches documents whose display name contains "customer".
• "state=ACTIVE" matches documents with ACTIVE state.
• "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents. For more information about filtering, see API Filtering.

string filter = 4;

Returns

Type	Description
String	The filter.

getFilterBytes()

public ByteString getFilterBytes()

The filter expression used to filter documents returned by the list method. The expression has the following syntax: <field> <operator> <value> [AND <field> <operator> <value>] ... The following fields and operators are supported:

• knowledge_types with has(:) operator
• display_name with has(:) operator
• state with equals(=) operator Examples:
• "knowledge_types:FAQ" matches documents with FAQ knowledge type.
• "display_name:customer" matches documents whose display name contains "customer".
• "state=ACTIVE" matches documents with ACTIVE state.
• "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents. For more information about filtering, see API Filtering.

string filter = 4;

Returns

Type	Description
ByteString	The bytes for filter.

getPageSize()

public int getPageSize()

The maximum number of items to return in a single page. By default 10 and at most 100.

int32 page_size = 2;

Returns

Type	Description
int	The pageSize.

getPageToken()

public String getPageToken()

The next_page_token value returned from a previous list request.

string page_token = 3;

Returns

Type	Description
String	The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

The next_page_token value returned from a previous list request.

string page_token = 3;

Returns

Type	Description
ByteString	The bytes for pageToken.

getParent()

public String getParent()

Required. The knowledge base to list all documents for. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>.

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

Returns

Type	Description
String	The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The knowledge base to list all documents for. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>.

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(ListDocumentsRequest other)

public ListDocumentsRequest.Builder mergeFrom(ListDocumentsRequest other)

Parameter

Name	Description
other	ListDocumentsRequest

Returns

Type	Description
ListDocumentsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListDocumentsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
ListDocumentsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public ListDocumentsRequest.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
ListDocumentsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListDocumentsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
ListDocumentsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public ListDocumentsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
ListDocumentsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilter(String value)

public ListDocumentsRequest.Builder setFilter(String value)

The filter expression used to filter documents returned by the list method. The expression has the following syntax: <field> <operator> <value> [AND <field> <operator> <value>] ... The following fields and operators are supported:

• knowledge_types with has(:) operator
• display_name with has(:) operator
• state with equals(=) operator Examples:
• "knowledge_types:FAQ" matches documents with FAQ knowledge type.
• "display_name:customer" matches documents whose display name contains "customer".
• "state=ACTIVE" matches documents with ACTIVE state.
• "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents. For more information about filtering, see API Filtering.

string filter = 4;

Parameter

Name	Description
value	String The filter to set.

Returns

Type	Description
ListDocumentsRequest.Builder	This builder for chaining.

setFilterBytes(ByteString value)

public ListDocumentsRequest.Builder setFilterBytes(ByteString value)

The filter expression used to filter documents returned by the list method. The expression has the following syntax: <field> <operator> <value> [AND <field> <operator> <value>] ... The following fields and operators are supported:

• knowledge_types with has(:) operator
• display_name with has(:) operator
• state with equals(=) operator Examples:
• "knowledge_types:FAQ" matches documents with FAQ knowledge type.
• "display_name:customer" matches documents whose display name contains "customer".
• "state=ACTIVE" matches documents with ACTIVE state.
• "knowledge_types:FAQ AND state=ACTIVE" matches all active FAQ documents. For more information about filtering, see API Filtering.

string filter = 4;

Parameter

Name	Description
value	ByteString The bytes for filter to set.

Returns

Type	Description
ListDocumentsRequest.Builder	This builder for chaining.

setPageSize(int value)

public ListDocumentsRequest.Builder setPageSize(int value)

The maximum number of items to return in a single page. By default 10 and at most 100.

int32 page_size = 2;

Parameter

Name	Description
value	int The pageSize to set.

Returns

Type	Description
ListDocumentsRequest.Builder	This builder for chaining.

setPageToken(String value)

public ListDocumentsRequest.Builder setPageToken(String value)

The next_page_token value returned from a previous list request.

string page_token = 3;

Parameter

Name	Description
value	String The pageToken to set.

Returns

Type	Description
ListDocumentsRequest.Builder	This builder for chaining.

setPageTokenBytes(ByteString value)

public ListDocumentsRequest.Builder setPageTokenBytes(ByteString value)

The next_page_token value returned from a previous list request.

string page_token = 3;

Parameter

Name	Description
value	ByteString The bytes for pageToken to set.

Returns

Type	Description
ListDocumentsRequest.Builder	This builder for chaining.

setParent(String value)

public ListDocumentsRequest.Builder setParent(String value)

Required. The knowledge base to list all documents for. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>.

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

Parameter

Name	Description
value	String The parent to set.

Returns

Type	Description
ListDocumentsRequest.Builder	This builder for chaining.

setParentBytes(ByteString value)

public ListDocumentsRequest.Builder setParentBytes(ByteString value)

Required. The knowledge base to list all documents for. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>.

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
ListDocumentsRequest.Builder	This builder for chaining.

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

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

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
ListDocumentsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ListDocumentsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
ListDocumentsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)