# Artifact Registry V1 API - Class Google::Cloud::ArtifactRegistry::V1::ListFilesRequest (v1.14.0)

1.14.0 (latest) 1.13.0 1.12.0 1.11.0 1.10.0 1.9.0 1.8.0 1.7.1 1.6.0 1.5.0 1.4.1 1.3.0 1.2.0 1.1.0 1.0.1 0.13.0 0.12.2 0.11.0 0.10.0 0.9.1 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.2 Reference documentation and code samples for the Artifact Registry V1 API class Google::Cloud::ArtifactRegistry::V1::ListFilesRequest.

The request to list files.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #filter

    def filter() -> ::String

**Returns**

- (::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*`"``

### #filter=

    def filter=(value) -> ::String

**Parameter**

- **value** (::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*`"``
**Returns**

- (::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*`"``

### #order_by

    def order_by() -> ::String

**Returns**

- (::String) --- The field to order the results by.

### #order_by=

    def order_by=(value) -> ::String

**Parameter**

- **value** (::String) --- The field to order the results by.
**Returns**

- (::String) --- The field to order the results by.

### #page_size

    def page_size() -> ::Integer

**Returns**

- (::Integer) --- The maximum number of files to return. Maximum page size is 1,000.

### #page_size=

    def page_size=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- The maximum number of files to return. Maximum page size is 1,000.
**Returns**

- (::Integer) --- The maximum number of files to return. Maximum page size is 1,000.

### #page_token

    def page_token() -> ::String

**Returns**

- (::String) --- The next_page_token value returned from a previous list request, if any.

### #page_token=

    def page_token=(value) -> ::String

**Parameter**

- **value** (::String) --- The next_page_token value returned from a previous list request, if any.
**Returns**

- (::String) --- The next_page_token value returned from a previous list request, if any.

### #parent

    def parent() -> ::String

**Returns**

- (::String) --- Required. The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1

### #parent=

    def parent=(value) -> ::String

**Parameter**

- **value** (::String) --- Required. The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1
**Returns**

- (::String) --- Required. The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1