Class ProjectsResource.LocationsResource.RepositoriesResource.FilesResource.ListRequest
Lists files.
Inheritance
Inherited Members
Namespace: Google.Apis.ArtifactRegistry.v1
Assembly: Google.Apis.ArtifactRegistry.v1.dll
Syntax
public class ProjectsResource.LocationsResource.RepositoriesResource.FilesResource.ListRequest : ArtifactRegistryBaseServiceRequest<ListFilesResponse>, IClientServiceRequest<ListFilesResponse>, 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
An expression for filtering the results of the request. Filter rules are case insensitive.
The fields eligible for filtering are: * name
* owner
* annotations
Examples of using
a filter: To filter the results of your request to files with the name my_file.txt
in
project my-project
in the us-central
region, in repository my-repo
, append the
following filter expression to your request: *
name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt"
You can also use wildcards to match any number of characters before or after the value: *
name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-*"
*
name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt"
*
name="projects/my-project/locations/us-central1/repositories/my-repo/files/*file*"
To
filter the results of your request to files owned by the version 1.0
in package pkg1
,
append the following filter expression to your request: *
owner="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"
To filter the results of your request to files with the annotation key-value pair
[external_link
: external_link_value
], append the following filter expression to your
request: * "annotations.external_link:external_link_value"
To filter just for a specific
annotation key external_link
, append the following filter expression to your request: *
"annotations.external_link"
If the annotation key or value contains special characters,
you can escape them by surrounding the value with backticks. For example, to filter the
results of your request to files with the annotation key-value pair
[external.link
:https://example.com/my-file
], append the following filter expression to
your request: * "annotations.`external.link`:`https://example.com/my-file`"
You can
also filter with annotations with a wildcard to match any number of characters before or
after the value: * "annotations.*_link:`*example.com*`"
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
The field to order the results by.
Declaration
[RequestParameter("orderBy", RequestParameterType.Query)]
public virtual string OrderBy { get; set; }
Property Value
Type | Description |
---|---|
string |
PageSize
The maximum number of files to return. Maximum page size is 1,000.
Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type | Description |
---|---|
int? |
PageToken
The next_page_token value returned from a previous list request, if any.
Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type | Description |
---|---|
string |
Parent
Required. The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1
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()