Class ListDocumentsRequest.Builder (4.52.0)

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

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

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

clearField(Descriptors.FieldDescriptor field)

public ListDocumentsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListDocumentsRequest.Builder
Overrides

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

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

getDefaultInstanceForType()

public ListDocumentsRequest getDefaultInstanceForType()
Returns
Type Description
ListDocumentsRequest

getDescriptorForType()

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

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListDocumentsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListDocumentsRequest.Builder
Overrides

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

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

setUnknownFields(UnknownFieldSet unknownFields)

public final ListDocumentsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListDocumentsRequest.Builder
Overrides