Package com.google.cloud.aiplatform.v1beta1

Interface ListFeaturesRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ListFeaturesRequest, ListFeaturesRequest.Builder
    public interface ListFeaturesRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getFilter()
      Lists the Features that match the filter expression.
      com.google.protobuf.ByteString getFilterBytes()
      Lists the Features that match the filter expression.
      int getLatestStatsCount()
      If set, return the most recent [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count] of stats for each Feature in response.
      String getOrderBy()
      A comma-separated list of fields to order by, sorted in ascending order.
      com.google.protobuf.ByteString getOrderByBytes()
      A comma-separated list of fields to order by, sorted in ascending order.
      int getPageSize()
      The maximum number of Features to return.
      String getPageToken()
      A page token, received from a previous [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures] call.
      com.google.protobuf.ByteString getPageTokenBytes()
      A page token, received from a previous [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures] call.
      String getParent()
      Required.
      com.google.protobuf.ByteString getParentBytes()
      Required.
      com.google.protobuf.FieldMask getReadMask()
      Mask specifying which fields to read.
      com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()
      Mask specifying which fields to read.
      boolean hasReadMask()
      Mask specifying which fields to read.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getParent

        String getParent()
         Required. The resource name of the Location to list Features.
 Format:
 `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The parent.

      • getParentBytes

        com.google.protobuf.ByteString getParentBytes()
         Required. The resource name of the Location to list Features.
 Format:
 `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for parent.

      • getFilter

        String getFilter()
         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.
        string filter = 2;
        Returns:
        The filter.

      • getFilterBytes

        com.google.protobuf.ByteString getFilterBytes()
         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.
        string filter = 2;
        Returns:
        The bytes for filter.

      • getPageSize

        int getPageSize()
         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.
        int32 page_size = 3;
        Returns:
        The pageSize.

      • getPageToken

        String getPageToken()
         A page token, received from a previous
 [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures]
 must match the call that provided the page token.
        string page_token = 4;
        Returns:
        The pageToken.

      • getPageTokenBytes

        com.google.protobuf.ByteString getPageTokenBytes()
         A page token, received from a previous
 [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1beta1.FeaturestoreService.ListFeatures]
 must match the call that provided the page token.
        string page_token = 4;
        Returns:
        The bytes for pageToken.

      • getOrderBy

        String getOrderBy()
         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`
        string order_by = 5;
        Returns:
        The orderBy.

      • getOrderByBytes

        com.google.protobuf.ByteString getOrderByBytes()
         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`
        string order_by = 5;
        Returns:
        The bytes for orderBy.

      • hasReadMask

        boolean hasReadMask()
         Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 6;
        Returns:
        Whether the readMask field is set.

      • getReadMask

        com.google.protobuf.FieldMask getReadMask()
         Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 6;
        Returns:
        The readMask.

      • getReadMaskOrBuilder

        com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()
         Mask specifying which fields to read.
        .google.protobuf.FieldMask read_mask = 6;

      • getLatestStatsCount

        int getLatestStatsCount()
         If set, return the most recent
 [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1beta1.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][google.cloud.aiplatform.v1beta1.ListFeaturesRequest.latest_stats_count],
 return all existing stats.
        int32 latest_stats_count = 7;
        Returns:
        The latestStatsCount.