Package com.google.cloud.aiplatform.v1

Class ListFeaturesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.ListFeaturesRequest
All Implemented Interfaces:
ListFeaturesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ListFeaturesRequest extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ListFeaturesRequest.Builder
    Request message for [FeaturestoreService.ListFeatures][google.cloud.aiplatform.v1.FeaturestoreService.ListFeatures].

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    FILTER_FIELD_NUMBER
     
    static final int
    LATEST_STATS_COUNT_FIELD_NUMBER
     
    static final int
    ORDER_BY_FIELD_NUMBER
     
    static final int
    PAGE_SIZE_FIELD_NUMBER
     
    static final int
    PAGE_TOKEN_FIELD_NUMBER
     
    static final int
    PARENT_FIELD_NUMBER
     
    static final int
    READ_MASK_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static ListFeaturesRequest
    getDefaultInstance()
     
    ListFeaturesRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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()
    Only applicable for Vertex AI Feature Store (Legacy).
    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.v1.FeaturestoreService.ListFeatures] call or [FeatureRegistryService.ListFeatures][google.cloud.aiplatform.v1.FeatureRegistryService.ListFeatures] call.
    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.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.
    com.google.protobuf.Parser<ListFeaturesRequest>
    getParserForType()
     
    com.google.protobuf.FieldMask
    getReadMask()
    Mask specifying which fields to read.
    com.google.protobuf.FieldMaskOrBuilder
    getReadMaskOrBuilder()
    Mask specifying which fields to read.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasReadMask()
    Mask specifying which fields to read.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ListFeaturesRequest.Builder
    newBuilder()
     
    static ListFeaturesRequest.Builder
    newBuilder(ListFeaturesRequest prototype)
     
    ListFeaturesRequest.Builder
    newBuilderForType()
     
    protected ListFeaturesRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static ListFeaturesRequest
    parseDelimitedFrom(InputStream input)
     
    static ListFeaturesRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListFeaturesRequest
    parseFrom(byte[] data)
     
    static ListFeaturesRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListFeaturesRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static ListFeaturesRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListFeaturesRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ListFeaturesRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListFeaturesRequest
    parseFrom(InputStream input)
     
    static ListFeaturesRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListFeaturesRequest
    parseFrom(ByteBuffer data)
     
    static ListFeaturesRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ListFeaturesRequest>
    parser()
     
    ListFeaturesRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • PARENT_FIELD_NUMBER

      public static final int PARENT_FIELD_NUMBER
      See Also:

    • FILTER_FIELD_NUMBER

      public static final int FILTER_FIELD_NUMBER
      See Also:

    • PAGE_SIZE_FIELD_NUMBER

      public static final int PAGE_SIZE_FIELD_NUMBER
      See Also:

    • PAGE_TOKEN_FIELD_NUMBER

      public static final int PAGE_TOKEN_FIELD_NUMBER
      See Also:

    • ORDER_BY_FIELD_NUMBER

      public static final int ORDER_BY_FIELD_NUMBER
      See Also:

    • READ_MASK_FIELD_NUMBER

      public static final int READ_MASK_FIELD_NUMBER
      See Also:

    • LATEST_STATS_COUNT_FIELD_NUMBER

      public static final int LATEST_STATS_COUNT_FIELD_NUMBER
      See Also:

  • 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

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

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

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

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

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

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

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

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ListFeaturesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListFeaturesRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListFeaturesRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListFeaturesRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListFeaturesRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListFeaturesRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ListFeaturesRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListFeaturesRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListFeaturesRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ListFeaturesRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListFeaturesRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ListFeaturesRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static ListFeaturesRequest.Builder newBuilder()

    • newBuilder

      public static ListFeaturesRequest.Builder newBuilder(ListFeaturesRequest prototype)

    • toBuilder

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

    • newBuilderForType

      protected ListFeaturesRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ListFeaturesRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ListFeaturesRequest> parser()

    • getParserForType

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

    • getDefaultInstanceForType

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