Reference documentation and code samples for the Google Cloud Artifact Registry V1 Client class ListFilesRequest.
The request to list files.
Generated from protobuf message google.devtools.artifactregistry.v1.ListFilesRequest
Namespace
Google \ Cloud \ ArtifactRegistry \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1
↳ filter
string
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*`"
↳ page_size
int
The maximum number of files to return. Maximum page size is 1,000.
↳ page_token
string
The next_page_token value returned from a previous list request, if any.
↳ order_by
string
The field to order the results by.
getParent
Required. The name of the repository whose files will be listed. For
example: "projects/p1/locations/us-central1/repositories/repo1
Returns
Type
Description
string
setParent
Required. The name of the repository whose files will be listed. For
example: "projects/p1/locations/us-central1/repositories/repo1
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
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/*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*`"
Returns
Type
Description
string
setFilter
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/*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*`"
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
The maximum number of files to return. Maximum page size is 1,000.
Returns
Type
Description
int
setPageSize
The maximum number of files to return. Maximum page size is 1,000.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
The next_page_token value returned from a previous list request, if any.
Returns
Type
Description
string
setPageToken
The next_page_token value returned from a previous list request, if any.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getOrderBy
The field to order the results by.
Returns
Type
Description
string
setOrderBy
The field to order the results by.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The name of the repository whose files will be listed. For
example: "projects/p1/locations/us-central1/repositories/repo1
Please see ArtifactRegistryClient::repositoryName() for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Google Cloud Artifact Registry V1 Client - Class ListFilesRequest (1.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.1 (latest)](/php/docs/reference/cloud-artifact-registry/latest/V1.ListFilesRequest)\n- [1.2.0](/php/docs/reference/cloud-artifact-registry/1.2.0/V1.ListFilesRequest)\n- [1.1.3](/php/docs/reference/cloud-artifact-registry/1.1.3/V1.ListFilesRequest)\n- [1.0.0](/php/docs/reference/cloud-artifact-registry/1.0.0/V1.ListFilesRequest)\n- [0.6.5](/php/docs/reference/cloud-artifact-registry/0.6.5/V1.ListFilesRequest)\n- [0.5.1](/php/docs/reference/cloud-artifact-registry/0.5.1/V1.ListFilesRequest)\n- [0.4.4](/php/docs/reference/cloud-artifact-registry/0.4.4/V1.ListFilesRequest)\n- [0.3.13](/php/docs/reference/cloud-artifact-registry/0.3.13/V1.ListFilesRequest) \nReference documentation and code samples for the Google Cloud Artifact Registry V1 Client class ListFilesRequest.\n\nThe request to list files.\n\nGenerated from protobuf message `google.devtools.artifactregistry.v1.ListFilesRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ ArtifactRegistry \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The name of the repository whose files will be listed. For\nexample: \"projects/p1/locations/us-central1/repositories/repo1\n\n### setParent\n\nRequired. The name of the repository whose files will be listed. For\nexample: \"projects/p1/locations/us-central1/repositories/repo1\n\n### getFilter\n\nAn expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n- `name`\n- `owner`\n- `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:\n- `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:\n- `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-*\"`\n- `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt\"`\n- `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:\n- `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:\n- `\"annotations.external_link:external_link_value\"` To filter just for a specific annotation key `external_link`, append the following filter expression to your request:\n- `\"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:\n- ``\"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:\n- ``\"annotations.*_link:`*example.com*`\"``\n\n### setFilter\n\nAn expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n- `name`\n- `owner`\n- `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:\n- `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:\n- `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-*\"`\n- `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt\"`\n- `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:\n- `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:\n- `\"annotations.external_link:external_link_value\"` To filter just for a specific annotation key `external_link`, append the following filter expression to your request:\n- `\"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:\n- ``\"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:\n- ``\"annotations.*_link:`*example.com*`\"``\n\n### getPageSize\n\nThe maximum number of files to return. Maximum page size is 1,000.\n\n### setPageSize\n\nThe maximum number of files to return. Maximum page size is 1,000.\n\n### getPageToken\n\nThe next_page_token value returned from a previous list request, if any.\n\n### setPageToken\n\nThe next_page_token value returned from a previous list request, if any.\n\n### getOrderBy\n\nThe field to order the results by.\n\n### setOrderBy\n\nThe field to order the results by.\n\n### static::build"]]
