Package com.google.cloud.aiplatform.v1

Class SearchFeaturesRequest.Builder

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

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

    • clear

      public SearchFeaturesRequest.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<SearchFeaturesRequest.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<SearchFeaturesRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public SearchFeaturesRequest.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<SearchFeaturesRequest.Builder>

    • mergeFrom

      public SearchFeaturesRequest.Builder mergeFrom(SearchFeaturesRequest other)

    • isInitialized

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

    • mergeFrom

      public SearchFeaturesRequest.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<SearchFeaturesRequest.Builder>
      Throws:
      IOException

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

    • setLocation

      public SearchFeaturesRequest.Builder setLocation(String value)
       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) = { ... }
      Parameters:
      value - The location to set.
      Returns:
      This builder for chaining.

    • clearLocation

      public SearchFeaturesRequest.Builder clearLocation()
       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) = { ... }
      Returns:
      This builder for chaining.

    • setLocationBytes

      public SearchFeaturesRequest.Builder setLocationBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for location to set.
      Returns:
      This builder for chaining.

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

    • setQuery

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

    • clearQuery

      public SearchFeaturesRequest.Builder clearQuery()
       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;
      Returns:
      This builder for chaining.

    • setQueryBytes

      public SearchFeaturesRequest.Builder setQueryBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for query 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 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.

    • setPageSize

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

    • clearPageSize

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

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

    • setPageToken

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

    • clearPageToken

      public SearchFeaturesRequest.Builder clearPageToken()
       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;
      Returns:
      This builder for chaining.

    • setPageTokenBytes

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