Discovery Engine v1 API - Class ListDocumentsRequest (1.5.0) 

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

Reference documentation and code samples for the Discovery Engine v1 API class ListDocumentsRequest.

Request message for [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments] method.

Inheritance

object > ListDocumentsRequest

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

ListDocumentsRequest()

public ListDocumentsRequest()

ListDocumentsRequest(ListDocumentsRequest)

public ListDocumentsRequest(ListDocumentsRequest other)
Parameter
Name Description
other ListDocumentsRequest

Properties

PageSize

public int PageSize { get; set; }

Maximum number of [Document][google.cloud.discoveryengine.v1.Document]s to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000.

If this field is negative, an INVALID_ARGUMENT error is returned.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

A page token [ListDocumentsResponse.next_page_token][google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token], received from a previous [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments] call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to [DocumentService.ListDocuments][google.cloud.discoveryengine.v1.DocumentService.ListDocuments] must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

Property Value
Type Description
string

Parent

public string Parent { get; set; }

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. Use default_branch as the branch ID, to list documents under the default branch.

If the caller does not have permission to list [Document][google.cloud.discoveryengine.v1.Document]s under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

Property Value
Type Description
string

ParentAsBranchName

public BranchName ParentAsBranchName { get; set; }

BranchName-typed view over the Parent resource name property.

Property Value
Type Description
BranchName