Google Cloud Artifact Registry V1 Client - Class ListFilesRequest (0.6.5)

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 An example of using a filter: * name="projects/p1/locations/us-central1/repositories/repo1/files/a/b/*" --> Files with an ID starting with "a/b/". * owner="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0" --> Files owned by the version 1.0 in package pkg1.
↳ page_size int

The maximum number of files to return.
↳ 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 An example of using a filter:
  • name="projects/p1/locations/us-central1/repositories/repo1/files/a/b/*" --> Files with an ID starting with "a/b/".
  • owner="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0" --> Files owned by the version 1.0 in package pkg1.
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 An example of using a filter:
  • name="projects/p1/locations/us-central1/repositories/repo1/files/a/b/*" --> Files with an ID starting with "a/b/".
  • owner="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0" --> Files owned by the version 1.0 in package pkg1.
Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

The maximum number of files to return.

Returns
Type Description
int

setPageSize

The maximum number of files to return.

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 Google\Cloud\ArtifactRegistry\V1\ArtifactRegistryClient::repositoryName() for help formatting this field.
Returns
Type Description
Google\Cloud\ArtifactRegistry\V1\ListFilesRequest