Package com.google.cloud.aiplatform.v1

Class StreamingReadFeatureValuesRequest

  • All Implemented Interfaces:
    StreamingReadFeatureValuesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class StreamingReadFeatureValuesRequest
extends com.google.protobuf.GeneratedMessageV3
implements StreamingReadFeatureValuesRequestOrBuilder
     Request message for
 [FeaturestoreOnlineServingService.StreamingFeatureValuesRead][].
    Protobuf type google.cloud.aiplatform.v1.StreamingReadFeatureValuesRequest
    See Also:
    Serialized Form

    • Field Detail

      • ENTITY_TYPE_FIELD_NUMBER

        public static final int ENTITY_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENTITY_IDS_FIELD_NUMBER

        public static final int ENTITY_IDS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FEATURE_SELECTOR_FIELD_NUMBER

        public static final int FEATURE_SELECTOR_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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) = { ... }
        Specified by:
        getEntityType in interface StreamingReadFeatureValuesRequestOrBuilder
        Returns:
        The entityType.

      • getEntityTypeBytes

        public com.google.protobuf.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) = { ... }
        Specified by:
        getEntityTypeBytes in interface StreamingReadFeatureValuesRequestOrBuilder
        Returns:
        The bytes for entityType.

      • getEntityIdsList

        public com.google.protobuf.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];
        Specified by:
        getEntityIdsList in interface StreamingReadFeatureValuesRequestOrBuilder
        Returns:
        A list containing the entityIds.

      • 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];
        Specified by:
        getEntityIdsCount in interface StreamingReadFeatureValuesRequestOrBuilder
        Returns:
        The count of entityIds.

      • getEntityIds

        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];
        Specified by:
        getEntityIds in interface StreamingReadFeatureValuesRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The entityIds at the given index.

      • getEntityIdsBytes

        public com.google.protobuf.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];
        Specified by:
        getEntityIdsBytes in interface StreamingReadFeatureValuesRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the entityIds at the given index.

      • 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];
        Specified by:
        hasFeatureSelector in interface StreamingReadFeatureValuesRequestOrBuilder
        Returns:
        Whether the featureSelector field is set.

      • 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];
        Specified by:
        getFeatureSelector in interface StreamingReadFeatureValuesRequestOrBuilder
        Returns:
        The featureSelector.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static StreamingReadFeatureValuesRequest parseFrom​(ByteBuffer data,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StreamingReadFeatureValuesRequest parseFrom​(com.google.protobuf.ByteString data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StreamingReadFeatureValuesRequest parseFrom​(com.google.protobuf.ByteString data,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StreamingReadFeatureValuesRequest parseFrom​(byte[] data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static StreamingReadFeatureValuesRequest parseFrom​(byte[] data,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public StreamingReadFeatureValuesRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public StreamingReadFeatureValuesRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected StreamingReadFeatureValuesRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<StreamingReadFeatureValuesRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public StreamingReadFeatureValuesRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder