Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::ListFeaturesRequest (v0.13.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::ListFeaturesRequest.

Request message for FeaturestoreService.ListFeatures.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String

Returns

(::String) —
Lists the Features that match the filter expression. The following filters are supported:
- value_type: Supports = and != comparisons.
- create_time: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format.
- update_time: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format.
- labels: Supports key-value equality as well as key presence.
Examples:
- value_type = DOUBLE --> Features whose type is DOUBLE.
- create_time > \"2020-01-31T15:30:00.000000Z\" OR update_time > \"2020-01-31T15:30:00.000000Z\" --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z.
- labels.active = yes AND labels.env = prod --> Features having both (active: yes) and (env: prod) labels.
- labels.env: * --> Any Feature which has a label with 'env' as the key.

#filter=

def filter=(value) -> ::String

Parameter

value (::String) —
Lists the Features that match the filter expression. The following filters are supported:
- value_type: Supports = and != comparisons.
- create_time: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format.
- update_time: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format.
- labels: Supports key-value equality as well as key presence.
Examples:
- value_type = DOUBLE --> Features whose type is DOUBLE.
- create_time > \"2020-01-31T15:30:00.000000Z\" OR update_time > \"2020-01-31T15:30:00.000000Z\" --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z.
- labels.active = yes AND labels.env = prod --> Features having both (active: yes) and (env: prod) labels.
- labels.env: * --> Any Feature which has a label with 'env' as the key.

Returns

(::String) —
Lists the Features that match the filter expression. The following filters are supported:
- value_type: Supports = and != comparisons.
- create_time: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format.
- update_time: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format.
- labels: Supports key-value equality as well as key presence.
Examples:
- value_type = DOUBLE --> Features whose type is DOUBLE.
- create_time > \"2020-01-31T15:30:00.000000Z\" OR update_time > \"2020-01-31T15:30:00.000000Z\" --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z.
- labels.active = yes AND labels.env = prod --> Features having both (active: yes) and (env: prod) labels.
- labels.env: * --> Any Feature which has a label with 'env' as the key.

#latest_stats_count

def latest_stats_count() -> ::Integer

Returns

(::Integer) — If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.

#latest_stats_count=

def latest_stats_count=(value) -> ::Integer

Parameter

value (::Integer) — If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.

Returns

(::Integer) — If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.

#order_by

def order_by() -> ::String

Returns

(::String) —
A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:
- feature_id
- value_type
- create_time
- update_time

#order_by=

def order_by=(value) -> ::String

Parameter

value (::String) —
A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:
- feature_id
- value_type
- create_time
- update_time

Returns

(::String) —
A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:
- feature_id
- value_type
- create_time
- update_time

#page_size

def page_size() -> ::Integer

Returns

(::Integer) — The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.

#page_size=

def page_size=(value) -> ::Integer

Parameter

value (::Integer) — The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.

Returns

(::Integer) — The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.

#page_token

def page_token() -> ::String

Returns

(::String) — A page token, received from a previous FeaturestoreService.ListFeatures call. Provide this to retrieve the subsequent page.

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

#page_token=

def page_token=(value) -> ::String

Parameter

value (::String) — A page token, received from a previous FeaturestoreService.ListFeatures call. Provide this to retrieve the subsequent page.

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

Returns

(::String) — A page token, received from a previous FeaturestoreService.ListFeatures call. Provide this to retrieve the subsequent page.

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

#parent

def parent() -> ::String

Returns

(::String) — Required. The resource name of the Location to list Features. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

#parent=

def parent=(value) -> ::String

Parameter

value (::String) — Required. The resource name of the Location to list Features. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

Returns

(::String) — Required. The resource name of the Location to list Features. Format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

#read_mask

def read_mask() -> ::Google::Protobuf::FieldMask

Returns

(::Google::Protobuf::FieldMask) — Mask specifying which fields to read.

#read_mask=

def read_mask=(value) -> ::Google::Protobuf::FieldMask

Parameter

value (::Google::Protobuf::FieldMask) — Mask specifying which fields to read.

Returns

(::Google::Protobuf::FieldMask) — Mask specifying which fields to read.