Class ListDocumentsRequest (4.11.0) 

public final class ListDocumentsRequest extends GeneratedMessageV3 implements ListDocumentsRequestOrBuilder

Request message for Documents.ListDocuments.

Protobuf type google.cloud.dialogflow.v2.ListDocumentsRequest

Inheritance

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

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListDocumentsRequest getDefaultInstance()
Returns
Type Description
ListDocumentsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ListDocumentsRequest.Builder newBuilder()
Returns
Type Description
ListDocumentsRequest.Builder

newBuilder(ListDocumentsRequest prototype)

public static ListDocumentsRequest.Builder newBuilder(ListDocumentsRequest prototype)
Parameter
Name Description
prototype ListDocumentsRequest
Returns
Type Description
ListDocumentsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListDocumentsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListDocumentsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListDocumentsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListDocumentsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListDocumentsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListDocumentsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListDocumentsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListDocumentsRequest> parser()
Returns
Type Description
Parser<ListDocumentsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListDocumentsRequest getDefaultInstanceForType()
Returns
Type Description
ListDocumentsRequest

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.

getParserForType()

public Parser<ListDocumentsRequest> getParserForType()
Returns
Type Description
Parser<ListDocumentsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListDocumentsRequest.Builder newBuilderForType()
Returns
Type Description
ListDocumentsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListDocumentsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListDocumentsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListDocumentsRequest.Builder toBuilder()
Returns
Type Description
ListDocumentsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides Exceptions
Type Description
IOException