Class StreamingReadFeatureValuesRequest.Builder (3.38.0)

public static final class StreamingReadFeatureValuesRequest.Builder extends GeneratedMessageV3.Builder<StreamingReadFeatureValuesRequest.Builder> implements StreamingReadFeatureValuesRequestOrBuilder

Request message for [FeaturestoreOnlineServingService.StreamingFeatureValuesRead][].

Protobuf type google.cloud.aiplatform.v1.StreamingReadFeatureValuesRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllEntityIds(Iterable<String> values)

public StreamingReadFeatureValuesRequest.Builder addAllEntityIds(Iterable<String> values)

Required. IDs of entities to read Feature values of. The maximum number of IDs is 100. For example, for a machine learning model predicting user clicks on a website, an entity ID could be user_123.

repeated string entity_ids = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valuesIterable<String>

The entityIds to add.

Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder

This builder for chaining.

addEntityIds(String value)

public StreamingReadFeatureValuesRequest.Builder addEntityIds(String value)

Required. IDs of entities to read Feature values of. The maximum number of IDs is 100. For example, for a machine learning model predicting user clicks on a website, an entity ID could be user_123.

repeated string entity_ids = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueString

The entityIds to add.

Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder

This builder for chaining.

addEntityIdsBytes(ByteString value)

public StreamingReadFeatureValuesRequest.Builder addEntityIdsBytes(ByteString value)

Required. IDs of entities to read Feature values of. The maximum number of IDs is 100. For example, for a machine learning model predicting user clicks on a website, an entity ID could be user_123.

repeated string entity_ids = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueByteString

The bytes of the entityIds to add.

Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StreamingReadFeatureValuesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder
Overrides

build()

public StreamingReadFeatureValuesRequest build()
Returns
TypeDescription
StreamingReadFeatureValuesRequest

buildPartial()

public StreamingReadFeatureValuesRequest buildPartial()
Returns
TypeDescription
StreamingReadFeatureValuesRequest

clear()

public StreamingReadFeatureValuesRequest.Builder clear()
Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder
Overrides

clearEntityIds()

public StreamingReadFeatureValuesRequest.Builder clearEntityIds()

Required. IDs of entities to read Feature values of. The maximum number of IDs is 100. For example, for a machine learning model predicting user clicks on a website, an entity ID could be user_123.

repeated string entity_ids = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder

This builder for chaining.

clearEntityType()

public StreamingReadFeatureValuesRequest.Builder clearEntityType()

Required. The resource name of the entities' type. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

string entity_type = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder

This builder for chaining.

clearFeatureSelector()

public StreamingReadFeatureValuesRequest.Builder clearFeatureSelector()

Required. Selector choosing Features of the target EntityType. Feature IDs will be deduplicated.

.google.cloud.aiplatform.v1.FeatureSelector feature_selector = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public StreamingReadFeatureValuesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public StreamingReadFeatureValuesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder
Overrides

clone()

public StreamingReadFeatureValuesRequest.Builder clone()
Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder
Overrides

getDefaultInstanceForType()

public StreamingReadFeatureValuesRequest getDefaultInstanceForType()
Returns
TypeDescription
StreamingReadFeatureValuesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEntityIds(int index)

public String getEntityIds(int index)

Required. IDs of entities to read Feature values of. The maximum number of IDs is 100. For example, for a machine learning model predicting user clicks on a website, an entity ID could be user_123.

repeated string entity_ids = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The entityIds at the given index.

getEntityIdsBytes(int index)

public ByteString getEntityIdsBytes(int index)

Required. IDs of entities to read Feature values of. The maximum number of IDs is 100. For example, for a machine learning model predicting user clicks on a website, an entity ID could be user_123.

repeated string entity_ids = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the entityIds at the given index.

getEntityIdsCount()

public int getEntityIdsCount()

Required. IDs of entities to read Feature values of. The maximum number of IDs is 100. For example, for a machine learning model predicting user clicks on a website, an entity ID could be user_123.

repeated string entity_ids = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
int

The count of entityIds.

getEntityIdsList()

public ProtocolStringList getEntityIdsList()

Required. IDs of entities to read Feature values of. The maximum number of IDs is 100. For example, for a machine learning model predicting user clicks on a website, an entity ID could be user_123.

repeated string entity_ids = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ProtocolStringList

A list containing the entityIds.

getEntityType()

public String getEntityType()

Required. The resource name of the entities' type. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

string entity_type = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The entityType.

getEntityTypeBytes()

public ByteString getEntityTypeBytes()

Required. The resource name of the entities' type. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

string entity_type = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for entityType.

getFeatureSelector()

public FeatureSelector getFeatureSelector()

Required. Selector choosing Features of the target EntityType. Feature IDs will be deduplicated.

.google.cloud.aiplatform.v1.FeatureSelector feature_selector = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
FeatureSelector

The featureSelector.

getFeatureSelectorBuilder()

public FeatureSelector.Builder getFeatureSelectorBuilder()

Required. Selector choosing Features of the target EntityType. Feature IDs will be deduplicated.

.google.cloud.aiplatform.v1.FeatureSelector feature_selector = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
FeatureSelector.Builder

getFeatureSelectorOrBuilder()

public FeatureSelectorOrBuilder getFeatureSelectorOrBuilder()

Required. Selector choosing Features of the target EntityType. Feature IDs will be deduplicated.

.google.cloud.aiplatform.v1.FeatureSelector feature_selector = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
FeatureSelectorOrBuilder

hasFeatureSelector()

public boolean hasFeatureSelector()

Required. Selector choosing Features of the target EntityType. Feature IDs will be deduplicated.

.google.cloud.aiplatform.v1.FeatureSelector feature_selector = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the featureSelector field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFeatureSelector(FeatureSelector value)

public StreamingReadFeatureValuesRequest.Builder mergeFeatureSelector(FeatureSelector value)

Required. Selector choosing Features of the target EntityType. Feature IDs will be deduplicated.

.google.cloud.aiplatform.v1.FeatureSelector feature_selector = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueFeatureSelector
Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder

mergeFrom(StreamingReadFeatureValuesRequest other)

public StreamingReadFeatureValuesRequest.Builder mergeFrom(StreamingReadFeatureValuesRequest other)
Parameter
NameDescription
otherStreamingReadFeatureValuesRequest
Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StreamingReadFeatureValuesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public StreamingReadFeatureValuesRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StreamingReadFeatureValuesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder
Overrides

setEntityIds(int index, String value)

public StreamingReadFeatureValuesRequest.Builder setEntityIds(int index, String value)

Required. IDs of entities to read Feature values of. The maximum number of IDs is 100. For example, for a machine learning model predicting user clicks on a website, an entity ID could be user_123.

repeated string entity_ids = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The entityIds to set.

Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder

This builder for chaining.

setEntityType(String value)

public StreamingReadFeatureValuesRequest.Builder setEntityType(String value)

Required. The resource name of the entities' type. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

string entity_type = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueString

The entityType to set.

Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder

This builder for chaining.

setEntityTypeBytes(ByteString value)

public StreamingReadFeatureValuesRequest.Builder setEntityTypeBytes(ByteString value)

Required. The resource name of the entities' type. Value format: projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be user.

string entity_type = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueByteString

The bytes for entityType to set.

Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder

This builder for chaining.

setFeatureSelector(FeatureSelector value)

public StreamingReadFeatureValuesRequest.Builder setFeatureSelector(FeatureSelector value)

Required. Selector choosing Features of the target EntityType. Feature IDs will be deduplicated.

.google.cloud.aiplatform.v1.FeatureSelector feature_selector = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
valueFeatureSelector
Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder

setFeatureSelector(FeatureSelector.Builder builderForValue)

public StreamingReadFeatureValuesRequest.Builder setFeatureSelector(FeatureSelector.Builder builderForValue)

Required. Selector choosing Features of the target EntityType. Feature IDs will be deduplicated.

.google.cloud.aiplatform.v1.FeatureSelector feature_selector = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
builderForValueFeatureSelector.Builder
Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public StreamingReadFeatureValuesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder
Overrides

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

public StreamingReadFeatureValuesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final StreamingReadFeatureValuesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder
Overrides