public final class ListFeaturesRequest extends GeneratedMessageV3 implements ListFeaturesRequestOrBuilder
Request message for
FeaturestoreService.ListFeatures.
Request message for
FeatureRegistryService.ListFeatures.
Protobuf type google.cloud.aiplatform.v1.ListFeaturesRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int LATEST_STATS_COUNT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int ORDER_BY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int PARENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int READ_MASK_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static ListFeaturesRequest getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static ListFeaturesRequest.Builder newBuilder()
public static ListFeaturesRequest.Builder newBuilder(ListFeaturesRequest prototype)
public static ListFeaturesRequest parseDelimitedFrom(InputStream input)
public static ListFeaturesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListFeaturesRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static ListFeaturesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListFeaturesRequest parseFrom(ByteString data)
public static ListFeaturesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListFeaturesRequest parseFrom(CodedInputStream input)
public static ListFeaturesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListFeaturesRequest parseFrom(InputStream input)
public static ListFeaturesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ListFeaturesRequest parseFrom(ByteBuffer data)
public static ListFeaturesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<ListFeaturesRequest> parser()
Methods
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public ListFeaturesRequest getDefaultInstanceForType()
public String getFilter()
Lists the Features that match the filter expression. The following
filters are supported:
string filter = 2;
| Returns |
|---|
| Type | Description |
String | The filter.
|
public ByteString getFilterBytes()
Lists the Features that match the filter expression. The following
filters are supported:
string filter = 2;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for filter.
|
public int getLatestStatsCount()
Only applicable for Vertex AI Feature Store (Legacy).
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;
| Returns |
|---|
| 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_type (Not supported for FeatureRegistry Feature)create_timeupdate_time
string order_by = 5;
| Returns |
|---|
| 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_type (Not supported for FeatureRegistry Feature)create_timeupdate_time
string order_by = 5;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for orderBy.
|
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;
| Returns |
|---|
| Type | Description |
int | The pageSize.
|
getPageToken()
public String getPageToken()
A page token, received from a previous
FeaturestoreService.ListFeatures
call or
FeatureRegistryService.ListFeatures
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
FeaturestoreService.ListFeatures
or or
FeatureRegistryService.ListFeatures
must match the call that provided the page token.
string page_token = 4;
| Returns |
|---|
| Type | Description |
String | The pageToken.
|
getPageTokenBytes()
public ByteString getPageTokenBytes()
A page token, received from a previous
FeaturestoreService.ListFeatures
call or
FeatureRegistryService.ListFeatures
call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to
FeaturestoreService.ListFeatures
or or
FeatureRegistryService.ListFeatures
must match the call that provided the page token.
string page_token = 4;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for pageToken.
|
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) = { ... }
| Returns |
|---|
| Type | Description |
String | The parent.
|
public 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) = { ... }
| Returns |
|---|
| Type | Description |
ByteString | The bytes for parent.
|
public Parser<ListFeaturesRequest> getParserForType()
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 |
|---|
| Type | Description |
int | |
Overrides
public boolean hasReadMask()
Mask specifying which fields to read.
.google.protobuf.FieldMask read_mask = 6;
| Returns |
|---|
| Type | Description |
boolean | Whether the readMask field is set.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public ListFeaturesRequest.Builder newBuilderForType()
protected ListFeaturesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public ListFeaturesRequest.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
