Package com.google.cloud.aiplatform.v1

Class ListFeaturesRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ListFeaturesRequest.Builder>
com.google.cloud.aiplatform.v1.ListFeaturesRequest.Builder
All Implemented Interfaces:
ListFeaturesRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ListFeaturesRequest
public static final class ListFeaturesRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ListFeaturesRequest.Builder> implements ListFeaturesRequestOrBuilder
 Request message for
 [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures].
 Request message for
 [FeatureRegistryService.ListFeatures][google.cloud.aiplatform.v1.FeatureRegistryService.ListFeatures].
Protobuf type google.cloud.aiplatform.v1.ListFeaturesRequest

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ListFeaturesRequest.Builder>

    • clear

      public ListFeaturesRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ListFeaturesRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ListFeaturesRequest.Builder>

    • getDefaultInstanceForType

      public ListFeaturesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public ListFeaturesRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public ListFeaturesRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public ListFeaturesRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListFeaturesRequest.Builder>

    • mergeFrom

      public ListFeaturesRequest.Builder mergeFrom(ListFeaturesRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListFeaturesRequest.Builder>

    • mergeFrom

      public ListFeaturesRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListFeaturesRequest.Builder>
      Throws:
      IOException

    • getParent

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

    • getParentBytes

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

    • setParent

      public ListFeaturesRequest.Builder setParent(String value)
       Required. The resource name of the Location to list Features.
 Format for entity_type as parent:
 `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
 Format for feature_group as parent:
 `projects/{project}/locations/{location}/featureGroups/{feature_group}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.

    • clearParent

      public ListFeaturesRequest.Builder clearParent()
       Required. The resource name of the Location to list Features.
 Format for entity_type as parent:
 `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
 Format for feature_group as parent:
 `projects/{project}/locations/{location}/featureGroups/{feature_group}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setParentBytes

      public ListFeaturesRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       Required. The resource name of the Location to list Features.
 Format for entity_type as parent:
 `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`
 Format for feature_group as parent:
 `projects/{project}/locations/{location}/featureGroups/{feature_group}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

    • getFilter

      public 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;
      Specified by:
      getFilter in interface ListFeaturesRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public 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;
      Specified by:
      getFilterBytes in interface ListFeaturesRequestOrBuilder
      Returns:
      The bytes for filter.

    • setFilter

      public ListFeaturesRequest.Builder setFilter(String value)
       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;
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

    • clearFilter

      public ListFeaturesRequest.Builder clearFilter()
       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:
      This builder for chaining.

    • setFilterBytes

      public ListFeaturesRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.

    • getPageSize

      public 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;
      Specified by:
      getPageSize in interface ListFeaturesRequestOrBuilder
      Returns:
      The pageSize.

    • setPageSize

      public ListFeaturesRequest.Builder setPageSize(int value)
       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;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public ListFeaturesRequest.Builder clearPageSize()
       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:
      This builder for chaining.

    • getPageToken

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

 When paginating, all other parameters provided to
 [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures]
 or
 [FeatureRegistryService.ListFeatures][google.cloud.aiplatform.v1.FeatureRegistryService.ListFeatures]
 must match the call that provided the page token.
      string page_token = 4;
      Specified by:
      getPageToken in interface ListFeaturesRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

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

 When paginating, all other parameters provided to
 [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures]
 or
 [FeatureRegistryService.ListFeatures][google.cloud.aiplatform.v1.FeatureRegistryService.ListFeatures]
 must match the call that provided the page token.
      string page_token = 4;
      Specified by:
      getPageTokenBytes in interface ListFeaturesRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • setPageToken

      public ListFeaturesRequest.Builder setPageToken(String value)
       A page token, received from a previous
 [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures]
 call or
 [FeatureRegistryService.ListFeatures][google.cloud.aiplatform.v1.FeatureRegistryService.ListFeatures]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures]
 or
 [FeatureRegistryService.ListFeatures][google.cloud.aiplatform.v1.FeatureRegistryService.ListFeatures]
 must match the call that provided the page token.
      string page_token = 4;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public ListFeaturesRequest.Builder clearPageToken()
       A page token, received from a previous
 [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures]
 call or
 [FeatureRegistryService.ListFeatures][google.cloud.aiplatform.v1.FeatureRegistryService.ListFeatures]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures]
 or
 [FeatureRegistryService.ListFeatures][google.cloud.aiplatform.v1.FeatureRegistryService.ListFeatures]
 must match the call that provided the page token.
      string page_token = 4;
      Returns:
      This builder for chaining.

    • setPageTokenBytes

      public ListFeaturesRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       A page token, received from a previous
 [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures]
 call or
 [FeatureRegistryService.ListFeatures][google.cloud.aiplatform.v1.FeatureRegistryService.ListFeatures]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures]
 or
 [FeatureRegistryService.ListFeatures][google.cloud.aiplatform.v1.FeatureRegistryService.ListFeatures]
 must match the call that provided the page token.
      string page_token = 4;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

    • getOrderBy

      public 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` (Not supported for FeatureRegistry Feature)
 * `create_time`
 * `update_time`
      string order_by = 5;
      Specified by:
      getOrderBy in interface ListFeaturesRequestOrBuilder
      Returns:
      The orderBy.

    • getOrderByBytes

      public 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` (Not supported for FeatureRegistry Feature)
 * `create_time`
 * `update_time`
      string order_by = 5;
      Specified by:
      getOrderByBytes in interface ListFeaturesRequestOrBuilder
      Returns:
      The bytes for orderBy.

    • setOrderBy

      public ListFeaturesRequest.Builder setOrderBy(String value)
       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` (Not supported for FeatureRegistry Feature)
 * `create_time`
 * `update_time`
      string order_by = 5;
      Parameters:
      value - The orderBy to set.
      Returns:
      This builder for chaining.

    • clearOrderBy

      public ListFeaturesRequest.Builder clearOrderBy()
       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` (Not supported for FeatureRegistry Feature)
 * `create_time`
 * `update_time`
      string order_by = 5;
      Returns:
      This builder for chaining.

    • setOrderByBytes

      public ListFeaturesRequest.Builder setOrderByBytes(com.google.protobuf.ByteString value)
       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` (Not supported for FeatureRegistry Feature)
 * `create_time`
 * `update_time`
      string order_by = 5;
      Parameters:
      value - The bytes for orderBy to set.
      Returns:
      This builder for chaining.

    • hasReadMask

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

    • getReadMask

      public com.google.protobuf.FieldMask getReadMask()
       Mask specifying which fields to read.
      .google.protobuf.FieldMask read_mask = 6;
      Specified by:
      getReadMask in interface ListFeaturesRequestOrBuilder
      Returns:
      The readMask.

    • setReadMask

      public ListFeaturesRequest.Builder setReadMask(com.google.protobuf.FieldMask value)
       Mask specifying which fields to read.
      .google.protobuf.FieldMask read_mask = 6;

    • setReadMask

      public ListFeaturesRequest.Builder setReadMask(com.google.protobuf.FieldMask.Builder builderForValue)
       Mask specifying which fields to read.
      .google.protobuf.FieldMask read_mask = 6;

    • mergeReadMask

      public ListFeaturesRequest.Builder mergeReadMask(com.google.protobuf.FieldMask value)
       Mask specifying which fields to read.
      .google.protobuf.FieldMask read_mask = 6;

    • clearReadMask

      public ListFeaturesRequest.Builder clearReadMask()
       Mask specifying which fields to read.
      .google.protobuf.FieldMask read_mask = 6;

    • getReadMaskBuilder

      public com.google.protobuf.FieldMask.Builder getReadMaskBuilder()
       Mask specifying which fields to read.
      .google.protobuf.FieldMask read_mask = 6;

    • getReadMaskOrBuilder

      public com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()
       Mask specifying which fields to read.
      .google.protobuf.FieldMask read_mask = 6;
      Specified by:
      getReadMaskOrBuilder in interface ListFeaturesRequestOrBuilder

    • getLatestStatsCount

      public int getLatestStatsCount()
       Only applicable for Vertex AI Feature Store (Legacy).
 If set, return the most recent
 [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1.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.v1.ListFeaturesRequest.latest_stats_count],
 return all existing stats.
      int32 latest_stats_count = 7;
      Specified by:
      getLatestStatsCount in interface ListFeaturesRequestOrBuilder
      Returns:
      The latestStatsCount.

    • setLatestStatsCount

      public ListFeaturesRequest.Builder setLatestStatsCount(int value)
       Only applicable for Vertex AI Feature Store (Legacy).
 If set, return the most recent
 [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1.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.v1.ListFeaturesRequest.latest_stats_count],
 return all existing stats.
      int32 latest_stats_count = 7;
      Parameters:
      value - The latestStatsCount to set.
      Returns:
      This builder for chaining.

    • clearLatestStatsCount

      public ListFeaturesRequest.Builder clearLatestStatsCount()
       Only applicable for Vertex AI Feature Store (Legacy).
 If set, return the most recent
 [ListFeaturesRequest.latest_stats_count][google.cloud.aiplatform.v1.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.v1.ListFeaturesRequest.latest_stats_count],
 return all existing stats.
      int32 latest_stats_count = 7;
      Returns:
      This builder for chaining.