Package com.google.cloud.aiplatform.v1

Class SearchFeaturesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.SearchFeaturesRequest
All Implemented Interfaces:
SearchFeaturesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SearchFeaturesRequest extends com.google.protobuf.GeneratedMessage implements SearchFeaturesRequestOrBuilder
 Request message for
 [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures].
Protobuf type google.cloud.aiplatform.v1.SearchFeaturesRequest
See Also:

  • Nested Class Summary

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

    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
    LOCATION_FIELD_NUMBER
     
    static final int
    PAGE_SIZE_FIELD_NUMBER
     
    static final int
    PAGE_TOKEN_FIELD_NUMBER
     
    static final int
    QUERY_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 SearchFeaturesRequest
    getDefaultInstance()
     
    SearchFeaturesRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getLocation()
    Required.
    com.google.protobuf.ByteString
    getLocationBytes()
    Required.
    int
    getPageSize()
    The maximum number of Features to return.
    String
    getPageToken()
    A page token, received from a previous [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures] call.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    A page token, received from a previous [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures] call.
    com.google.protobuf.Parser<SearchFeaturesRequest>
    getParserForType()
     
    String
    getQuery()
    Query string that is a conjunction of field-restricted queries and/or field-restricted filters.
    com.google.protobuf.ByteString
    getQueryBytes()
    Query string that is a conjunction of field-restricted queries and/or field-restricted filters.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static SearchFeaturesRequest.Builder
    newBuilder()
     
    static SearchFeaturesRequest.Builder
    newBuilder(SearchFeaturesRequest prototype)
     
    SearchFeaturesRequest.Builder
    newBuilderForType()
     
    protected SearchFeaturesRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static SearchFeaturesRequest
    parseDelimitedFrom(InputStream input)
     
    static SearchFeaturesRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchFeaturesRequest
    parseFrom(byte[] data)
     
    static SearchFeaturesRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchFeaturesRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static SearchFeaturesRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchFeaturesRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static SearchFeaturesRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchFeaturesRequest
    parseFrom(InputStream input)
     
    static SearchFeaturesRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchFeaturesRequest
    parseFrom(ByteBuffer data)
     
    static SearchFeaturesRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<SearchFeaturesRequest>
    parser()
     
    SearchFeaturesRequest.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

  • 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

    • getLocation

      public String getLocation()
       Required. The resource name of the Location to search Features.
 Format:
 `projects/{project}/locations/{location}`
      string location = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getLocation in interface SearchFeaturesRequestOrBuilder
      Returns:
      The location.

    • getLocationBytes

      public com.google.protobuf.ByteString getLocationBytes()
       Required. The resource name of the Location to search Features.
 Format:
 `projects/{project}/locations/{location}`
      string location = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getLocationBytes in interface SearchFeaturesRequestOrBuilder
      Returns:
      The bytes for location.

    • getQuery

      public String getQuery()
       Query string that is a conjunction of field-restricted queries and/or
 field-restricted filters.  Field-restricted queries and filters can be
 combined using `AND` to form a conjunction.

 A field query is in the form FIELD:QUERY. This implicitly checks if QUERY
 exists as a substring within Feature's FIELD. The QUERY
 and the FIELD are converted to a sequence of words (i.e. tokens) for
 comparison. This is done by:

 * Removing leading/trailing whitespace and tokenizing the search value.
 Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore
 `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated
 as a wildcard that matches characters within a token.
 * Ignoring case.
 * Prepending an asterisk to the first and appending an asterisk to the
 last token in QUERY.

 A QUERY must be either a singular token or a phrase. A phrase is one or
 multiple words enclosed in double quotation marks ("). With phrases, the
 order of the words is important. Words in the phrase must be matching in
 order and consecutively.

 Supported FIELDs for field-restricted queries:

 * `feature_id`
 * `description`
 * `entity_type_id`

 Examples:

 * `feature_id: foo` --> Matches a Feature with ID containing the substring
 `foo` (eg. `foo`, `foofeature`, `barfoo`).
 * `feature_id: foo*feature` --> Matches a Feature with ID containing the
 substring `foo*feature` (eg. `foobarfeature`).
 * `feature_id: foo AND description: bar` --> Matches a Feature with ID
 containing the substring `foo` and description containing the substring
 `bar`.

 Besides field queries, the following exact-match filters are
 supported. The exact-match filters do not support wildcards. Unlike
 field-restricted queries, exact-match filters are case-sensitive.

 * `feature_id`: Supports = comparisons.
 * `description`: Supports = comparisons. Multi-token filters should be
 enclosed in quotes.
 * `entity_type_id`: Supports = comparisons.
 * `value_type`: Supports = and != comparisons.
 * `labels`: Supports key-value equality as well as key presence.
 * `featurestore_id`: Supports = comparisons.

 Examples:

 * `description = "foo bar"` --> Any Feature with description exactly equal
 to `foo bar`
 * `value_type = DOUBLE` --> Features whose type is DOUBLE.
 * `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 query = 3;
      Specified by:
      getQuery in interface SearchFeaturesRequestOrBuilder
      Returns:
      The query.

    • getQueryBytes

      public com.google.protobuf.ByteString getQueryBytes()
       Query string that is a conjunction of field-restricted queries and/or
 field-restricted filters.  Field-restricted queries and filters can be
 combined using `AND` to form a conjunction.

 A field query is in the form FIELD:QUERY. This implicitly checks if QUERY
 exists as a substring within Feature's FIELD. The QUERY
 and the FIELD are converted to a sequence of words (i.e. tokens) for
 comparison. This is done by:

 * Removing leading/trailing whitespace and tokenizing the search value.
 Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore
 `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated
 as a wildcard that matches characters within a token.
 * Ignoring case.
 * Prepending an asterisk to the first and appending an asterisk to the
 last token in QUERY.

 A QUERY must be either a singular token or a phrase. A phrase is one or
 multiple words enclosed in double quotation marks ("). With phrases, the
 order of the words is important. Words in the phrase must be matching in
 order and consecutively.

 Supported FIELDs for field-restricted queries:

 * `feature_id`
 * `description`
 * `entity_type_id`

 Examples:

 * `feature_id: foo` --> Matches a Feature with ID containing the substring
 `foo` (eg. `foo`, `foofeature`, `barfoo`).
 * `feature_id: foo*feature` --> Matches a Feature with ID containing the
 substring `foo*feature` (eg. `foobarfeature`).
 * `feature_id: foo AND description: bar` --> Matches a Feature with ID
 containing the substring `foo` and description containing the substring
 `bar`.

 Besides field queries, the following exact-match filters are
 supported. The exact-match filters do not support wildcards. Unlike
 field-restricted queries, exact-match filters are case-sensitive.

 * `feature_id`: Supports = comparisons.
 * `description`: Supports = comparisons. Multi-token filters should be
 enclosed in quotes.
 * `entity_type_id`: Supports = comparisons.
 * `value_type`: Supports = and != comparisons.
 * `labels`: Supports key-value equality as well as key presence.
 * `featurestore_id`: Supports = comparisons.

 Examples:

 * `description = "foo bar"` --> Any Feature with description exactly equal
 to `foo bar`
 * `value_type = DOUBLE` --> Features whose type is DOUBLE.
 * `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 query = 3;
      Specified by:
      getQueryBytes in interface SearchFeaturesRequestOrBuilder
      Returns:
      The bytes for query.

    • getPageSize

      public int getPageSize()
       The maximum number of Features to return. The service may return fewer
 than this value. If unspecified, at most 100 Features will be returned.
 The maximum value is 100; any value greater than 100 will be coerced to
 100.
      int32 page_size = 4;
      Specified by:
      getPageSize in interface SearchFeaturesRequestOrBuilder
      Returns:
      The pageSize.

    • getPageToken

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

 When paginating, all other parameters provided to
 [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures],
 except `page_size`, must match the call that provided the page token.
      string page_token = 5;
      Specified by:
      getPageToken in interface SearchFeaturesRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

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

 When paginating, all other parameters provided to
 [FeaturestoreService.SearchFeatures][google.cloud.aiplatform.v1.FeaturestoreService.SearchFeatures],
 except `page_size`, must match the call that provided the page token.
      string page_token = 5;
      Specified by:
      getPageTokenBytes in interface SearchFeaturesRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • 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 SearchFeaturesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SearchFeaturesRequest.Builder newBuilder()

    • newBuilder

      public static SearchFeaturesRequest.Builder newBuilder(SearchFeaturesRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SearchFeaturesRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<SearchFeaturesRequest> 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 SearchFeaturesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder