- 3.49.0 (latest)
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public static final class SearchFeaturesRequest.Builder extends GeneratedMessageV3.Builder<SearchFeaturesRequest.Builder> implements SearchFeaturesRequestOrBuilder
Request message for FeaturestoreService.SearchFeatures.
Protobuf type google.cloud.aiplatform.v1beta1.SearchFeaturesRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchFeaturesRequest.BuilderImplements
SearchFeaturesRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchFeaturesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
SearchFeaturesRequest.Builder |
build()
public SearchFeaturesRequest build()
Returns | |
---|---|
Type | Description |
SearchFeaturesRequest |
buildPartial()
public SearchFeaturesRequest buildPartial()
Returns | |
---|---|
Type | Description |
SearchFeaturesRequest |
clear()
public SearchFeaturesRequest.Builder clear()
Returns | |
---|---|
Type | Description |
SearchFeaturesRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public SearchFeaturesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
SearchFeaturesRequest.Builder |
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 | |
---|---|
Type | Description |
SearchFeaturesRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchFeaturesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
SearchFeaturesRequest.Builder |
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 | |
---|---|
Type | Description |
SearchFeaturesRequest.Builder | This builder for chaining. |
clearPageToken()
public SearchFeaturesRequest.Builder clearPageToken()
A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
FeaturestoreService.SearchFeatures,
except page_size
, must match the call that provided the page token.
string page_token = 5;
Returns | |
---|---|
Type | Description |
SearchFeaturesRequest.Builder | 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 asteriskare 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 substringfoo
(eg.foo
,foofeature
,barfoo
).feature_id: foofeature
--> Matches a Feature with ID containing the substringfoofeature
(eg.foobarfeature
).feature_id: foo AND description: bar
--> Matches a Feature with ID containing the substringfoo
and description containing the substringbar
.
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 tofoo 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 withenv
as the key.
string query = 3;
Returns | |
---|---|
Type | Description |
SearchFeaturesRequest.Builder | This builder for chaining. |
clone()
public SearchFeaturesRequest.Builder clone()
Returns | |
---|---|
Type | Description |
SearchFeaturesRequest.Builder |
getDefaultInstanceForType()
public SearchFeaturesRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
SearchFeaturesRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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) = { ... }
Returns | |
---|---|
Type | Description |
String | The location. |
getLocationBytes()
public 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) = { ... }
Returns | |
---|---|
Type | Description |
ByteString | The bytes for location. |
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;
Returns | |
---|---|
Type | Description |
int | The pageSize. |
getPageToken()
public String getPageToken()
A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
FeaturestoreService.SearchFeatures,
except page_size
, must match the call that provided the page token.
string page_token = 5;
Returns | |
---|---|
Type | Description |
String | The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes()
A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
FeaturestoreService.SearchFeatures,
except page_size
, must match the call that provided the page token.
string page_token = 5;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for pageToken. |
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 asteriskare 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 substringfoo
(eg.foo
,foofeature
,barfoo
).feature_id: foofeature
--> Matches a Feature with ID containing the substringfoofeature
(eg.foobarfeature
).feature_id: foo AND description: bar
--> Matches a Feature with ID containing the substringfoo
and description containing the substringbar
.
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 tofoo 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 withenv
as the key.
string query = 3;
Returns | |
---|---|
Type | Description |
String | The query. |
getQueryBytes()
public 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 asteriskare 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 substringfoo
(eg.foo
,foofeature
,barfoo
).feature_id: foofeature
--> Matches a Feature with ID containing the substringfoofeature
(eg.foobarfeature
).feature_id: foo AND description: bar
--> Matches a Feature with ID containing the substringfoo
and description containing the substringbar
.
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 tofoo 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 withenv
as the key.
string query = 3;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for query. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(SearchFeaturesRequest other)
public SearchFeaturesRequest.Builder mergeFrom(SearchFeaturesRequest other)
Parameter | |
---|---|
Name | Description |
other | SearchFeaturesRequest |
Returns | |
---|---|
Type | Description |
SearchFeaturesRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchFeaturesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SearchFeaturesRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public SearchFeaturesRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
SearchFeaturesRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchFeaturesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
SearchFeaturesRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public SearchFeaturesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
SearchFeaturesRequest.Builder |
setLocation(String value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value | String The location to set. |
Returns | |
---|---|
Type | Description |
SearchFeaturesRequest.Builder | This builder for chaining. |
setLocationBytes(ByteString value)
public SearchFeaturesRequest.Builder setLocationBytes(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) = { ... }
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for location to set. |
Returns | |
---|---|
Type | Description |
SearchFeaturesRequest.Builder | This builder for chaining. |
setPageSize(int value)
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;
Parameter | |
---|---|
Name | Description |
value | int The pageSize to set. |
Returns | |
---|---|
Type | Description |
SearchFeaturesRequest.Builder | This builder for chaining. |
setPageToken(String value)
public SearchFeaturesRequest.Builder setPageToken(String value)
A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
FeaturestoreService.SearchFeatures,
except page_size
, must match the call that provided the page token.
string page_token = 5;
Parameter | |
---|---|
Name | Description |
value | String The pageToken to set. |
Returns | |
---|---|
Type | Description |
SearchFeaturesRequest.Builder | This builder for chaining. |
setPageTokenBytes(ByteString value)
public SearchFeaturesRequest.Builder setPageTokenBytes(ByteString value)
A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
FeaturestoreService.SearchFeatures,
except page_size
, must match the call that provided the page token.
string page_token = 5;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for pageToken to set. |
Returns | |
---|---|
Type | Description |
SearchFeaturesRequest.Builder | This builder for chaining. |
setQuery(String value)
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 asteriskare 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 substringfoo
(eg.foo
,foofeature
,barfoo
).feature_id: foofeature
--> Matches a Feature with ID containing the substringfoofeature
(eg.foobarfeature
).feature_id: foo AND description: bar
--> Matches a Feature with ID containing the substringfoo
and description containing the substringbar
.
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 tofoo 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 withenv
as the key.
string query = 3;
Parameter | |
---|---|
Name | Description |
value | String The query to set. |
Returns | |
---|---|
Type | Description |
SearchFeaturesRequest.Builder | This builder for chaining. |
setQueryBytes(ByteString value)
public SearchFeaturesRequest.Builder setQueryBytes(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 asteriskare 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 substringfoo
(eg.foo
,foofeature
,barfoo
).feature_id: foofeature
--> Matches a Feature with ID containing the substringfoofeature
(eg.foobarfeature
).feature_id: foo AND description: bar
--> Matches a Feature with ID containing the substringfoo
and description containing the substringbar
.
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 tofoo 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 withenv
as the key.
string query = 3;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for query to set. |
Returns | |
---|---|
Type | Description |
SearchFeaturesRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchFeaturesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
SearchFeaturesRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchFeaturesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
SearchFeaturesRequest.Builder |