Google Cloud Ai Platform V1 Client - Class ListFeaturestoresRequest (0.16.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ListFeaturestoresRequest.

Request message for FeaturestoreService.ListFeaturestores.

Generated from protobuf message google.cloud.aiplatform.v1.ListFeaturestoresRequest

Methods

build

Parameter
Name	Description
`parent`	`string` Required. The resource name of the Location to list Featurestores. Format: `projects/{project}/locations/{location}` Please see {@see \Google\Cloud\AIPlatform\V1\FeaturestoreServiceClient::locationName()} for help formatting this field.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\ListFeaturestoresRequest`

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The resource name of the Location to list Featurestores. Format: `projects/{project}/locations/{location}`
`↳ filter`	`string` Lists the featurestores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > "2020-01-01" OR update_time > "2020-01-01"` Featurestores created or updated after 2020-01-01. * `labels.env = "prod"` Featurestores with label "env" set to "prod".
`↳ page_size`	`int` The maximum number of Featurestores to return. The service may return fewer than this value. If unspecified, at most 100 Featurestores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.
`↳ page_token`	`string` A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token.
`↳ order_by`	`string` A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` * `online_serving_config.fixed_node_count`
`↳ read_mask`	`Google\Protobuf\FieldMask` Mask specifying which fields to read.

getParent

Required. The resource name of the Location to list Featurestores.

Format: projects/{project}/locations/{location}

Returns
Type	Description
`string`

setParent

Required. The resource name of the Location to list Featurestores.

Format: projects/{project}/locations/{location}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFilter

Lists the featurestores that match the filter expression. The following fields are supported:

create_time: Supports =, !=, <, >, <=, and >= comparisons.

Values must be in RFC 3339 format.

update_time: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format.
online_serving_config.fixed_node_count: Supports =, !=, <, >, <=, and >= comparisons.
labels: Supports key-value equality and key presence. Examples:
create_time > "2020-01-01" OR update_time > "2020-01-01" Featurestores created or updated after 2020-01-01.
labels.env = "prod" Featurestores with label "env" set to "prod".

Returns
Type	Description
`string`

setFilter

Lists the featurestores that match the filter expression. The following fields are supported:

create_time: Supports =, !=, <, >, <=, and >= comparisons.

Values must be in RFC 3339 format.

update_time: Supports =, !=, <, >, <=, and >= comparisons. Values must be in RFC 3339 format.
online_serving_config.fixed_node_count: Supports =, !=, <, >, <=, and >= comparisons.
labels: Supports key-value equality and key presence. Examples:
create_time > "2020-01-01" OR update_time > "2020-01-01" Featurestores created or updated after 2020-01-01.
labels.env = "prod" Featurestores with label "env" set to "prod".

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

The maximum number of Featurestores to return. The service may return fewer than this value. If unspecified, at most 100 Featurestores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.

Returns
Type	Description
`int`

setPageSize

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token.

Returns
Type	Description
`string`

setPageToken

A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOrderBy

A comma-separated list of fields to order by, sorted in ascending order.

Use "desc" after a field name for descending. Supported Fields:

create_time
update_time
online_serving_config.fixed_node_count

Returns
Type	Description
`string`

setOrderBy

A comma-separated list of fields to order by, sorted in ascending order.

Use "desc" after a field name for descending. Supported Fields:

create_time
update_time
online_serving_config.fixed_node_count

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getReadMask

Mask specifying which fields to read.

Returns
Type	Description
`Google\Protobuf\FieldMask\|null`

hasReadMask

clearReadMask

setReadMask

Mask specifying which fields to read.

Parameter
Name	Description
`var`	`Google\Protobuf\FieldMask`

Returns
Type	Description
`$this`