Class ListFeaturesRequest.Builder (2.9.5)

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

Request message for FeaturestoreService.ListFeatures.

Protobuf type google.cloud.aiplatform.v1.ListFeaturesRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListFeaturesRequest.Builder

Implements

ListFeaturesRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public ListFeaturesRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
ListFeaturesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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()

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

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: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

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

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ListFeaturesRequest getDefaultInstanceForType()

Returns

Type	Description
ListFeaturesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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()

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
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
create_time
update_time

string order_by = 5;

Returns

Type	Description
ByteString	The bytes for orderBy.

getPageSize()

public int getPageSize()

int32 page_size = 3;

Returns

Type	Description
int	The pageSize.

getPageToken()

public String getPageToken()

string page_token = 4;

Returns

Type	Description
String	The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

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: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public ListFeaturesRequest.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
ListFeaturesRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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)

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
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
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)

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)

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)

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: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

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: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ListFeaturesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
ListFeaturesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)