com.google.cloud.dialogflow.v2

Class ListDocumentsRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>

com.google.cloud.dialogflow.v2.ListDocumentsRequest.Builder

All Implemented Interfaces:

ListDocumentsRequestOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, Cloneable

Enclosing class:

ListDocumentsRequest

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

 Request message for [Documents.ListDocuments][google.cloud.dialogflow.v2.Documents.ListDocuments].
 

Protobuf type google.cloud.dialogflow.v2.ListDocumentsRequest

Method Summary

Modifier and Type	Method and Description
ListDocumentsRequest.Builder	addRepeatedField(Descriptors.FieldDescriptor field, Object value)
ListDocumentsRequest	build()
ListDocumentsRequest	buildPartial()
ListDocumentsRequest.Builder	clear()
ListDocumentsRequest.Builder	clearField(Descriptors.FieldDescriptor field)
ListDocumentsRequest.Builder	clearFilter() The filter expression used to filter documents returned by the list method.
ListDocumentsRequest.Builder	clearOneof(Descriptors.OneofDescriptor oneof)
ListDocumentsRequest.Builder	clearPageSize() The maximum number of items to return in a single page.
ListDocumentsRequest.Builder	clearPageToken() The next_page_token value returned from a previous list request.
ListDocumentsRequest.Builder	clearParent() Required.
ListDocumentsRequest.Builder	clone()
ListDocumentsRequest	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()
String	getFilter() The filter expression used to filter documents returned by the list method.
ByteString	getFilterBytes() The filter expression used to filter documents returned by the list method.
int	getPageSize() The maximum number of items to return in a single page.
String	getPageToken() The next_page_token value returned from a previous list request.
ByteString	getPageTokenBytes() The next_page_token value returned from a previous list request.
String	getParent() Required.
ByteString	getParentBytes() Required.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ListDocumentsRequest.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
ListDocumentsRequest.Builder	mergeFrom(ListDocumentsRequest other)
ListDocumentsRequest.Builder	mergeFrom(Message other)
ListDocumentsRequest.Builder	mergeUnknownFields(UnknownFieldSet unknownFields)
ListDocumentsRequest.Builder	setField(Descriptors.FieldDescriptor field, Object value)
ListDocumentsRequest.Builder	setFilter(String value) The filter expression used to filter documents returned by the list method.
ListDocumentsRequest.Builder	setFilterBytes(ByteString value) The filter expression used to filter documents returned by the list method.
ListDocumentsRequest.Builder	setPageSize(int value) The maximum number of items to return in a single page.
ListDocumentsRequest.Builder	setPageToken(String value) The next_page_token value returned from a previous list request.
ListDocumentsRequest.Builder	setPageTokenBytes(ByteString value) The next_page_token value returned from a previous list request.
ListDocumentsRequest.Builder	setParent(String value) Required.
ListDocumentsRequest.Builder	setParentBytes(ByteString value) Required.
ListDocumentsRequest.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
ListDocumentsRequest.Builder	setUnknownFields(UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>

clear

public ListDocumentsRequest.Builder clear()

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>

getDefaultInstanceForType

public ListDocumentsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public ListDocumentsRequest build()

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public ListDocumentsRequest buildPartial()

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone

public ListDocumentsRequest.Builder clone()

Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>

setField

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

Specified by:

setField in interface Message.Builder

Overrides:

setField in class GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>

clearField

public ListDocumentsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>

clearOneof

public ListDocumentsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>

setRepeatedField

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

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>

addRepeatedField

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

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>

mergeFrom

public ListDocumentsRequest.Builder mergeFrom(Message other)

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<ListDocumentsRequest.Builder>

mergeFrom

public ListDocumentsRequest.Builder mergeFrom(ListDocumentsRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<ListDocumentsRequest.Builder>

Throws:

IOException

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

Specified by:

getParent in interface ListDocumentsRequestOrBuilder

Returns:

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

Specified by:

getParentBytes in interface ListDocumentsRequestOrBuilder

Returns:

The bytes for parent.

setParent

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

Parameters:

value - The parent to set.

Returns:

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:

This builder for chaining.

setParentBytes

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

Parameters:

value - The bytes for parent to set.

Returns:

This builder for chaining.

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;

Specified by:

getPageSize in interface ListDocumentsRequestOrBuilder

Returns:

The pageSize.

setPageSize

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;

Parameters:

value - The pageSize to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

getPageToken

public String getPageToken()

 The next_page_token value returned from a previous list request.
 

string page_token = 3;

Specified by:

getPageToken in interface ListDocumentsRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

public ByteString getPageTokenBytes()

 The next_page_token value returned from a previous list request.
 

string page_token = 3;

Specified by:

getPageTokenBytes in interface ListDocumentsRequestOrBuilder

Returns:

The bytes for pageToken.

setPageToken

public ListDocumentsRequest.Builder setPageToken(String value)

 The next_page_token value returned from a previous list request.
 

string page_token = 3;

Parameters:

value - The pageToken to set.

Returns:

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:

This builder for chaining.

setPageTokenBytes

public ListDocumentsRequest.Builder setPageTokenBytes(ByteString value)

 The next_page_token value returned from a previous list request.
 

string page_token = 3;

Parameters:

value - The bytes for pageToken to set.

Returns:

This builder for chaining.

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](https://aip.dev/160).
 

string filter = 4;

Specified by:

getFilter in interface ListDocumentsRequestOrBuilder

Returns:

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](https://aip.dev/160).
 

string filter = 4;

Specified by:

getFilterBytes in interface ListDocumentsRequestOrBuilder

Returns:

The bytes for filter.

setFilter

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](https://aip.dev/160).
 

string filter = 4;

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

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](https://aip.dev/160).
 

string filter = 4;

Returns:

This builder for chaining.

setFilterBytes

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](https://aip.dev/160).
 

string filter = 4;

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.

setUnknownFields

public final ListDocumentsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>

mergeUnknownFields

public final ListDocumentsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessageV3.Builder<ListDocumentsRequest.Builder>