com.google.cloud.dialogflow.v2beta1

Class ListDocumentsRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.dialogflow.v2beta1.ListDocumentsRequest

All Implemented Interfaces:

ListDocumentsRequestOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

public final class ListDocumentsRequest
extends GeneratedMessageV3
implements ListDocumentsRequestOrBuilder

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

Protobuf type google.cloud.dialogflow.v2beta1.ListDocumentsRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListDocumentsRequest.Builder Request message for [Documents.ListDocuments][google.cloud.dialogflow.v2beta1.Documents.ListDocuments].

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	FILTER_FIELD_NUMBER
static int	PAGE_SIZE_FIELD_NUMBER
static int	PAGE_TOKEN_FIELD_NUMBER
static int	PARENT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static ListDocumentsRequest	getDefaultInstance()
ListDocumentsRequest	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
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.
Parser<ListDocumentsRequest>	getParserForType()
int	getSerializedSize()
UnknownFieldSet	getUnknownFields()
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ListDocumentsRequest.Builder	newBuilder()
static ListDocumentsRequest.Builder	newBuilder(ListDocumentsRequest prototype)
ListDocumentsRequest.Builder	newBuilderForType()
protected ListDocumentsRequest.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static ListDocumentsRequest	parseDelimitedFrom(InputStream input)
static ListDocumentsRequest	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static ListDocumentsRequest	parseFrom(byte[] data)
static ListDocumentsRequest	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static ListDocumentsRequest	parseFrom(ByteBuffer data)
static ListDocumentsRequest	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static ListDocumentsRequest	parseFrom(ByteString data)
static ListDocumentsRequest	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static ListDocumentsRequest	parseFrom(CodedInputStream input)
static ListDocumentsRequest	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static ListDocumentsRequest	parseFrom(InputStream input)
static ListDocumentsRequest	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<ListDocumentsRequest>	parser()
ListDocumentsRequest.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

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.

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.

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.

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.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static ListDocumentsRequest parseFrom(ByteBuffer data)
                                      throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListDocumentsRequest parseFrom(ByteBuffer data,
                                             ExtensionRegistryLite extensionRegistry)
                                      throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListDocumentsRequest parseFrom(ByteString data)
                                      throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListDocumentsRequest parseFrom(ByteString data,
                                             ExtensionRegistryLite extensionRegistry)
                                      throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListDocumentsRequest parseFrom(byte[] data)
                                      throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListDocumentsRequest parseFrom(byte[] data,
                                             ExtensionRegistryLite extensionRegistry)
                                      throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static ListDocumentsRequest parseFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

public static ListDocumentsRequest parseFrom(InputStream input,
                                             ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static ListDocumentsRequest parseDelimitedFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static ListDocumentsRequest parseDelimitedFrom(InputStream input,
                                                      ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

parseFrom

public static ListDocumentsRequest parseFrom(CodedInputStream input)
                                      throws IOException

Throws:

IOException

parseFrom

public static ListDocumentsRequest parseFrom(CodedInputStream input,
                                             ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

newBuilderForType

public ListDocumentsRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static ListDocumentsRequest.Builder newBuilder()

newBuilder

public static ListDocumentsRequest.Builder newBuilder(ListDocumentsRequest prototype)

toBuilder

public ListDocumentsRequest.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected ListDocumentsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static ListDocumentsRequest getDefaultInstance()

parser

public static Parser<ListDocumentsRequest> parser()

getParserForType

public Parser<ListDocumentsRequest> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public ListDocumentsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder