Class: Google::Cloud::AIPlatform::V1::ListFeaturesRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb

Overview

Request message for FeaturestoreService.ListFeatures.

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns 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.


742
743
744
745
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 742

class ListFeaturesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#latest_stats_count ⇒ ::Integer

Returns 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:



742
743
744
745
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 742

class ListFeaturesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#order_by ⇒ ::String

Returns 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


742
743
744
745
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 742

class ListFeaturesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_size ⇒ ::Integer

Returns 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.



742
743
744
745
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 742

class ListFeaturesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

Returns 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:



742
743
744
745
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 742

class ListFeaturesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns 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}



742
743
744
745
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 742

class ListFeaturesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#read_mask ⇒ ::Google::Protobuf::FieldMask

Returns Mask specifying which fields to read.

Returns:



742
743
744
745
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 742

class ListFeaturesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end