Class StreamingReadFeatureValuesRequest (3.25.0)

public final class StreamingReadFeatureValuesRequest extends GeneratedMessageV3 implements StreamingReadFeatureValuesRequestOrBuilder

Request message for [FeaturestoreOnlineServingService.StreamingFeatureValuesRead][].

Protobuf type google.cloud.aiplatform.v1.StreamingReadFeatureValuesRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > StreamingReadFeatureValuesRequest

Static Fields

ENTITY_IDS_FIELD_NUMBER

public static final int ENTITY_IDS_FIELD_NUMBER
Field Value
TypeDescription
int

ENTITY_TYPE_FIELD_NUMBER

public static final int ENTITY_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

FEATURE_SELECTOR_FIELD_NUMBER

public static final int FEATURE_SELECTOR_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static StreamingReadFeatureValuesRequest getDefaultInstance()
Returns
TypeDescription
StreamingReadFeatureValuesRequest

getDescriptor()

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

newBuilder()

public static StreamingReadFeatureValuesRequest.Builder newBuilder()
Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder

newBuilder(StreamingReadFeatureValuesRequest prototype)

public static StreamingReadFeatureValuesRequest.Builder newBuilder(StreamingReadFeatureValuesRequest prototype)
Parameter
NameDescription
prototypeStreamingReadFeatureValuesRequest
Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder

parseDelimitedFrom(InputStream input)

public static StreamingReadFeatureValuesRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StreamingReadFeatureValuesRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamingReadFeatureValuesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StreamingReadFeatureValuesRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static StreamingReadFeatureValuesRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
StreamingReadFeatureValuesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static StreamingReadFeatureValuesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StreamingReadFeatureValuesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static StreamingReadFeatureValuesRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
StreamingReadFeatureValuesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static StreamingReadFeatureValuesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StreamingReadFeatureValuesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static StreamingReadFeatureValuesRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
StreamingReadFeatureValuesRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamingReadFeatureValuesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StreamingReadFeatureValuesRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static StreamingReadFeatureValuesRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StreamingReadFeatureValuesRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static StreamingReadFeatureValuesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StreamingReadFeatureValuesRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static StreamingReadFeatureValuesRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
StreamingReadFeatureValuesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static StreamingReadFeatureValuesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
StreamingReadFeatureValuesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<StreamingReadFeatureValuesRequest> parser()
Returns
TypeDescription
Parser<StreamingReadFeatureValuesRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public StreamingReadFeatureValuesRequest getDefaultInstanceForType()
Returns
TypeDescription
StreamingReadFeatureValuesRequest

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.

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

getParserForType()

public Parser<StreamingReadFeatureValuesRequest> getParserForType()
Returns
TypeDescription
Parser<StreamingReadFeatureValuesRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public StreamingReadFeatureValuesRequest.Builder newBuilderForType()
Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StreamingReadFeatureValuesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public StreamingReadFeatureValuesRequest.Builder toBuilder()
Returns
TypeDescription
StreamingReadFeatureValuesRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException