Class ListFeaturesRequest.Builder (3.47.0)

public static final class ListFeaturesRequest.Builder extends GeneratedMessageV3.Builder<ListFeaturesRequest.Builder> implements ListFeaturesRequestOrBuilder

Request message for FeaturestoreService.ListFeatures. Request message for FeatureRegistryService.ListFeatures.

Protobuf type google.cloud.aiplatform.v1beta1.ListFeaturesRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListFeaturesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListFeaturesRequest.Builder
Overrides

build()

public ListFeaturesRequest build()
Returns
Type Description
ListFeaturesRequest

buildPartial()

public ListFeaturesRequest buildPartial()
Returns
Type Description
ListFeaturesRequest

clear()

public ListFeaturesRequest.Builder clear()
Returns
Type Description
ListFeaturesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListFeaturesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListFeaturesRequest.Builder
Overrides

clearFilter()

public ListFeaturesRequest.Builder clearFilter()

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;

Returns
Type Description
ListFeaturesRequest.Builder

This builder for chaining.

clearLatestStatsCount()

public ListFeaturesRequest.Builder clearLatestStatsCount()

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
ListFeaturesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListFeaturesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListFeaturesRequest.Builder
Overrides

clearOrderBy()

public ListFeaturesRequest.Builder clearOrderBy()

A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:

  • feature_id
  • value_type (Not supported for FeatureRegistry Feature)
  • create_time
  • update_time

string order_by = 5;

Returns
Type Description
ListFeaturesRequest.Builder

This builder for chaining.

clearPageSize()

public ListFeaturesRequest.Builder clearPageSize()

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
ListFeaturesRequest.Builder

This builder for chaining.

clearPageToken()

public ListFeaturesRequest.Builder clearPageToken()

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 FeatureRegistryService.ListFeatures must match the call that provided the page token.

string page_token = 4;

Returns
Type Description
ListFeaturesRequest.Builder

This builder for chaining.

clearParent()

public ListFeaturesRequest.Builder clearParent()

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
ListFeaturesRequest.Builder

This builder for chaining.

clearReadMask()

public ListFeaturesRequest.Builder clearReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Returns
Type Description
ListFeaturesRequest.Builder

clone()

public ListFeaturesRequest.Builder clone()
Returns
Type Description
ListFeaturesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListFeaturesRequest getDefaultInstanceForType()
Returns
Type Description
ListFeaturesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

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;

Returns
Type Description
String

The filter.

getFilterBytes()

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;

Returns
Type Description
ByteString

The bytes for filter.

getLatestStatsCount()

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.

getOrderBy()

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_id
  • value_type (Not supported for FeatureRegistry Feature)
  • create_time
  • update_time

string order_by = 5;

Returns
Type Description
String

The orderBy.

getOrderByBytes()

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_id
  • value_type (Not supported for FeatureRegistry Feature)
  • create_time
  • update_time

string order_by = 5;

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public int 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 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 FeatureRegistryService.ListFeatures must match the call that provided the page token.

string page_token = 4;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

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.

getParentBytes()

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.

getReadMask()

public FieldMask getReadMask()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Returns
Type Description
FieldMask

The readMask.

getReadMaskBuilder()

public FieldMask.Builder getReadMaskBuilder()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Returns
Type Description
Builder

getReadMaskOrBuilder()

public FieldMaskOrBuilder getReadMaskOrBuilder()

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Returns
Type Description
FieldMaskOrBuilder

hasReadMask()

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListFeaturesRequest other)

public ListFeaturesRequest.Builder mergeFrom(ListFeaturesRequest other)
Parameter
Name Description
other ListFeaturesRequest
Returns
Type Description
ListFeaturesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListFeaturesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListFeaturesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListFeaturesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListFeaturesRequest.Builder
Overrides

mergeReadMask(FieldMask value)

public ListFeaturesRequest.Builder mergeReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Parameter
Name Description
value FieldMask
Returns
Type Description
ListFeaturesRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListFeaturesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListFeaturesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListFeaturesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListFeaturesRequest.Builder
Overrides

setFilter(String value)

public ListFeaturesRequest.Builder setFilter(String value)

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;

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListFeaturesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListFeaturesRequest.Builder setFilterBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListFeaturesRequest.Builder

This builder for chaining.

setLatestStatsCount(int value)

public ListFeaturesRequest.Builder setLatestStatsCount(int value)

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;

Parameter
Name Description
value int

The latestStatsCount to set.

Returns
Type Description
ListFeaturesRequest.Builder

This builder for chaining.

setOrderBy(String value)

public ListFeaturesRequest.Builder setOrderBy(String value)

A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:

  • feature_id
  • value_type (Not supported for FeatureRegistry Feature)
  • create_time
  • update_time

string order_by = 5;

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
ListFeaturesRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public ListFeaturesRequest.Builder setOrderByBytes(ByteString value)

A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields:

  • feature_id
  • value_type (Not supported for FeatureRegistry Feature)
  • create_time
  • update_time

string order_by = 5;

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
ListFeaturesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListFeaturesRequest.Builder setPageSize(int value)

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;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListFeaturesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListFeaturesRequest.Builder setPageToken(String value)

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 FeatureRegistryService.ListFeatures must match the call that provided the page token.

string page_token = 4;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListFeaturesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListFeaturesRequest.Builder setPageTokenBytes(ByteString value)

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 FeatureRegistryService.ListFeatures must match the call that provided the page token.

string page_token = 4;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListFeaturesRequest.Builder

This builder for chaining.

setParent(String value)

public ListFeaturesRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListFeaturesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListFeaturesRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListFeaturesRequest.Builder

This builder for chaining.

setReadMask(FieldMask value)

public ListFeaturesRequest.Builder setReadMask(FieldMask value)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Parameter
Name Description
value FieldMask
Returns
Type Description
ListFeaturesRequest.Builder

setReadMask(FieldMask.Builder builderForValue)

public ListFeaturesRequest.Builder setReadMask(FieldMask.Builder builderForValue)

Mask specifying which fields to read.

.google.protobuf.FieldMask read_mask = 6;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ListFeaturesRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListFeaturesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListFeaturesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListFeaturesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListFeaturesRequest.Builder
Overrides