Class ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.ListRequest
Gets a list of Documents.
Inheritance
Implements
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1beta
Assembly: Google.Apis.DiscoveryEngine.v1beta.dll
Syntax
public class ProjectsResource.LocationsResource.DataStoresResource.BranchesResource.DocumentsResource.ListRequest : DiscoveryEngineBaseServiceRequest<GoogleCloudDiscoveryengineV1betaListDocumentsResponse>, IClientServiceRequest<GoogleCloudDiscoveryengineV1betaListDocumentsResponse>, IClientServiceRequest
Constructors
ListRequest(IClientService, string)
Constructs a new List request.
Declaration
public ListRequest(IClientService service, string parent)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
string | parent |
Properties
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
PageSize
Maximum number of Documents 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.
Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type | Description |
---|---|
int? |
PageToken
A page token ListDocumentsResponse.next_page_token, received from a previous
DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When
paginating, all other parameters provided to DocumentService.ListDocuments must match
the call that provided the page token. Otherwise, an INVALID_ARGUMENT
error is
returned.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type | Description |
---|---|
string |
Parent
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 Documents under this branch, regardless of
whether or not this branch exists, a PERMISSION_DENIED
error is returned.
Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type | Description |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Methods
InitParameters()
Initializes List parameter list.
Declaration
protected override void InitParameters()