1.0.0-beta25 (latest) 1.0.0-beta24

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

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

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

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> ListDocumentsRequest

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[ListDocumentsRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ListDocumentsRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[ListDocumentsRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ListDocumentsRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[ListDocumentsRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ListDocumentsRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html), [IPageRequest](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.Grpc.IPageRequest.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.DiscoveryEngine.V1Beta](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta)

## Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

## Constructors

### ListDocumentsRequest()

    public ListDocumentsRequest()

### ListDocumentsRequest(ListDocumentsRequest)

    public ListDocumentsRequest(ListDocumentsRequest other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ListDocumentsRequest` |

## Properties

### PageSize

    public int PageSize { get; set; }

Maximum number of \[Document\]\[google.cloud.discoveryengine.v1beta.Document\]s
to return. If unspecified, defaults to 100. The maximum allowed value is

1. Values above 1000 are set to 1000.

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int32` |   |

### PageToken

    public string PageToken { get; set; }

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

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

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.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.v1beta.Document\]s under this
branch, regardless of whether or not this branch exists, a
`PERMISSION_DENIED` error is returned.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### ParentAsBranchName

    public BranchName ParentAsBranchName { get; set; }

[BranchName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.BranchName)-typed view over the [Parent](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ListDocumentsRequest#Google_Cloud_DiscoveryEngine_V1Beta_ListDocumentsRequest_Parent) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.BranchName` |   |