public final class ListDocumentsRequest extends GeneratedMessageV3 implements ListDocumentsRequestOrBuilder
Request message for Documents.ListDocuments.
Protobuf type google.cloud.dialogflow.v2beta1.ListDocumentsRequest
Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstance()
public static ListDocumentsRequest getDefaultInstance()
Returns
getDefaultInstanceForType()
public ListDocumentsRequest getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
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
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
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
getParserForType()
public Parser<ListDocumentsRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static ListDocumentsRequest.Builder newBuilder()
Returns
newBuilder(ListDocumentsRequest prototype)
public static ListDocumentsRequest.Builder newBuilder(ListDocumentsRequest prototype)
Parameter
Returns
newBuilderForType()
public ListDocumentsRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListDocumentsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static ListDocumentsRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListDocumentsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ListDocumentsRequest parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListDocumentsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ListDocumentsRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListDocumentsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListDocumentsRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListDocumentsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListDocumentsRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListDocumentsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ListDocumentsRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListDocumentsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ListDocumentsRequest> parser()
Returns
toBuilder()
public ListDocumentsRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions