public final class ListFeaturesRequest extends GeneratedMessageV3 implements ListFeaturesRequestOrBuilder
Request message for FeaturestoreService.ListFeatures.
Protobuf type google.cloud.aiplatform.v1beta1.ListFeaturesRequest
Fields
public static final int FILTER_FIELD_NUMBER
Field Value
public static final int LATEST_STATS_COUNT_FIELD_NUMBER
Field Value
public static final int ORDER_BY_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
public static final int PARENT_FIELD_NUMBER
Field Value
public static final int READ_MASK_FIELD_NUMBER
Field Value
Methods
public boolean equals(Object obj)
Parameter
Returns
Overrides
public static ListFeaturesRequest getDefaultInstance()
Returns
public ListFeaturesRequest getDefaultInstanceForType()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
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;
| Type | Description |
| String | The filter.
|
public 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;
public int getLatestStatsCount()
If set, return the most recent 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, return all
existing stats.
int32 latest_stats_count = 7;
| Type | Description |
| int | The latestStatsCount.
|
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_idvalue_typecreate_timeupdate_time
string order_by = 5;
| Type | Description |
| String | The orderBy.
|
public 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_idvalue_typecreate_timeupdate_time
string order_by = 5;
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;
| Type | Description |
| int | The pageSize.
|
getPageToken()
public String getPageToken()
A page token, received from a previous
FeaturestoreService.ListFeatures call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
FeaturestoreService.ListFeatures must
match the call that provided the page token.
string page_token = 4;
| Type | Description |
| String | The pageToken.
|
getPageTokenBytes()
public ByteString getPageTokenBytes()
A page token, received from a previous
FeaturestoreService.ListFeatures call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
FeaturestoreService.ListFeatures must
match the call that provided the page token.
string page_token = 4;
public String getParent()
Required. The resource name of the Location to list Features.
Format:
projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Type | Description |
| String | The parent.
|
public ByteString getParentBytes()
Required. The resource name of the Location to list Features.
Format:
projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
public Parser<ListFeaturesRequest> getParserForType()
Returns
Overrides
public FieldMask getReadMask()
Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 6;
public FieldMaskOrBuilder getReadMaskOrBuilder()
Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 6;
public int getSerializedSize()
Returns
Overrides
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
public boolean hasReadMask()
Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 6;
| Type | Description |
| boolean | Whether the readMask field is set.
|
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public static ListFeaturesRequest.Builder newBuilder()
Returns
public static ListFeaturesRequest.Builder newBuilder(ListFeaturesRequest prototype)
Parameter
Returns
public ListFeaturesRequest.Builder newBuilderForType()
Returns
protected ListFeaturesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static ListFeaturesRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListFeaturesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListFeaturesRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
public static ListFeaturesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListFeaturesRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static ListFeaturesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListFeaturesRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListFeaturesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListFeaturesRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListFeaturesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListFeaturesRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static ListFeaturesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<ListFeaturesRequest> parser()
Returns
public ListFeaturesRequest.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
