Class ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.SessionsResource.FilesResource.ListRequest

Lists metadata for all files in the current session.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<GoogleCloudDiscoveryengineV1alphaListFilesResponse>
DiscoveryEngineBaseServiceRequest<GoogleCloudDiscoveryengineV1alphaListFilesResponse>
ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.SessionsResource.FilesResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1alpha
Assembly: Google.Apis.DiscoveryEngine.v1alpha.dll
Syntax
public class ProjectsResource.LocationsResource.CollectionsResource.EnginesResource.SessionsResource.FilesResource.ListRequest : DiscoveryEngineBaseServiceRequest<GoogleCloudDiscoveryengineV1alphaListFilesResponse>, IClientServiceRequest<GoogleCloudDiscoveryengineV1alphaListFilesResponse>, 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

Filter

Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the files being filtered. Filter expression is case-sensitive. Currently supported field names are: * upload_time * last_add_time * last_use_time * file_name * mime_type Some examples of filters would be: * "file_name = 'file_1'" * "file_name = 'file_1' AND mime_type = 'text/plain'" * "last_use_time &gt; '2025-06-14T12:00:00Z'" For a full description of the filter format, please see https://google.aip.dev/160.

Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type Description
string

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

OrderBy

Optional. Specifies the order in which files are returned. The value is a comma-separated string of fields to sort by. For ascending order - just the field name is used. For descending order - the field name is suffixed with desc. Sorting is stable and applied sequentially according to the order of fields provided in the string. Supported fields for ordering: * upload_time: The time the file was uploaded. * file_name: The name of the file. * mime_type: The MIME type of the file. * session_name: The name of the session the file belongs to. Default Behavior: If the order_by field is not specified, files will be returned sorted by creation time in descending order. Examples: 1. Sort by file name in ascending order: file_name 2. Sort by upload time in descending order: upload_time desc 3. Sort by file name (ascending), then by content type (MIME type) (descending), and finally by upload time (ascending): file_name, mime_type desc, upload_time

Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual string OrderBy { get; set; }
Property Value
Type Description
string

PageSize

Optional. The maximum number of files to return. The service may return fewer than this value. If unspecified, at most 100 files will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. If user specifies a value less than or equal to 0 - the request will be rejected with an INVALID_ARGUMENT error.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

Optional. A page token received from a previous ListFiles call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListFiles must match the call that provided the page token (except page_size, which may differ).

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Parent

Required. The resource name of the Session. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session} Name of the session resource to which the file belong.

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()
Overrides

Implements