Class ListDocumentsRequest (3.9.0)

public sealed class ListDocumentsRequest : IMessage<ListDocumentsRequest>, IEquatable<ListDocumentsRequest>, IDeepCloneable<ListDocumentsRequest>, IBufferMessage, IMessage, IPageRequest

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

Inheritance

Object > ListDocumentsRequest

Implements

IMessage<ListDocumentsRequest>, IEquatable<ListDocumentsRequest>, IDeepCloneable<ListDocumentsRequest>, IBufferMessage, IMessage, IPageRequest

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

ListDocumentsRequest()

public ListDocumentsRequest()

ListDocumentsRequest(ListDocumentsRequest)

public ListDocumentsRequest(ListDocumentsRequest other)

Parameter
Name	Description
`other`	`ListDocumentsRequest`

Properties

Filter

public string Filter { get; set; }

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.

Property Value
Type	Description
`String`

PageSize

public int PageSize { get; set; }

The maximum number of items to return in a single page. By default 10 and at most 100.

Property Value
Type	Description
`Int32`

PageToken

public string PageToken { get; set; }

The next_page_token value returned from a previous list request.

Property Value
Type	Description
`String`

Parent

public string Parent { get; set; }

Required. The knowledge base to list all documents for. Format: projects/{Project ID}/locations/{Location ID>/knowledgeBases/<Knowledge Base ID>.

Property Value
Type	Description
`String`

ParentAsKnowledgeBaseName

public KnowledgeBaseName ParentAsKnowledgeBaseName { get; set; }

KnowledgeBaseName-typed view over the Parent resource name property.

Property Value
Type	Description
`KnowledgeBaseName`