Package com.google.cloud.aiplatform.v1

Class ImportFeatureValuesRequest

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

    • Field Detail

      • AVRO_SOURCE_FIELD_NUMBER

        public static final int AVRO_SOURCE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • BIGQUERY_SOURCE_FIELD_NUMBER

        public static final int BIGQUERY_SOURCE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CSV_SOURCE_FIELD_NUMBER

        public static final int CSV_SOURCE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FEATURE_TIME_FIELD_FIELD_NUMBER

        public static final int FEATURE_TIME_FIELD_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FEATURE_TIME_FIELD_NUMBER

        public static final int FEATURE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENTITY_TYPE_FIELD_NUMBER

        public static final int ENTITY_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENTITY_ID_FIELD_FIELD_NUMBER

        public static final int ENTITY_ID_FIELD_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FEATURE_SPECS_FIELD_NUMBER

        public static final int FEATURE_SPECS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISABLE_ONLINE_SERVING_FIELD_NUMBER

        public static final int DISABLE_ONLINE_SERVING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKER_COUNT_FIELD_NUMBER

        public static final int WORKER_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DISABLE_INGESTION_ANALYSIS_FIELD_NUMBER

        public static final int DISABLE_INGESTION_ANALYSIS_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

      • hasFeatureTimeField

        public boolean hasFeatureTimeField()
         Source column that holds the Feature timestamp for all Feature
 values in each entity.
        string feature_time_field = 6;
        Specified by:
        hasFeatureTimeField in interface ImportFeatureValuesRequestOrBuilder
        Returns:
        Whether the featureTimeField field is set.

      • getFeatureTimeFieldBytes

        public com.google.protobuf.ByteString getFeatureTimeFieldBytes()
         Source column that holds the Feature timestamp for all Feature
 values in each entity.
        string feature_time_field = 6;
        Specified by:
        getFeatureTimeFieldBytes in interface ImportFeatureValuesRequestOrBuilder
        Returns:
        The bytes for featureTimeField.

      • hasFeatureTime

        public boolean hasFeatureTime()
         Single Feature timestamp for all entities being imported. The
 timestamp must not have higher than millisecond precision.
        .google.protobuf.Timestamp feature_time = 7;
        Specified by:
        hasFeatureTime in interface ImportFeatureValuesRequestOrBuilder
        Returns:
        Whether the featureTime field is set.

      • getFeatureTime

        public com.google.protobuf.Timestamp getFeatureTime()
         Single Feature timestamp for all entities being imported. The
 timestamp must not have higher than millisecond precision.
        .google.protobuf.Timestamp feature_time = 7;
        Specified by:
        getFeatureTime in interface ImportFeatureValuesRequestOrBuilder
        Returns:
        The featureTime.

      • getFeatureTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getFeatureTimeOrBuilder()
         Single Feature timestamp for all entities being imported. The
 timestamp must not have higher than millisecond precision.
        .google.protobuf.Timestamp feature_time = 7;
        Specified by:
        getFeatureTimeOrBuilder in interface ImportFeatureValuesRequestOrBuilder

      • getEntityType

        public String getEntityType()
         Required. The resource name of the EntityType grouping the Features for
 which values are being imported. Format:
 `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`
        string entity_type = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getEntityType in interface ImportFeatureValuesRequestOrBuilder
        Returns:
        The entityType.

      • getEntityTypeBytes

        public com.google.protobuf.ByteString getEntityTypeBytes()
         Required. The resource name of the EntityType grouping the Features for
 which values are being imported. Format:
 `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`
        string entity_type = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getEntityTypeBytes in interface ImportFeatureValuesRequestOrBuilder
        Returns:
        The bytes for entityType.

      • getEntityIdField

        public String getEntityIdField()
         Source column that holds entity IDs. If not provided, entity IDs are
 extracted from the column named entity_id.
        string entity_id_field = 5;
        Specified by:
        getEntityIdField in interface ImportFeatureValuesRequestOrBuilder
        Returns:
        The entityIdField.

      • getEntityIdFieldBytes

        public com.google.protobuf.ByteString getEntityIdFieldBytes()
         Source column that holds entity IDs. If not provided, entity IDs are
 extracted from the column named entity_id.
        string entity_id_field = 5;
        Specified by:
        getEntityIdFieldBytes in interface ImportFeatureValuesRequestOrBuilder
        Returns:
        The bytes for entityIdField.

      • getFeatureSpecsList

        public List<ImportFeatureValuesRequest.FeatureSpec> getFeatureSpecsList()
         Required. Specifications defining which Feature values to import from the
 entity. The request fails if no feature_specs are provided, and having
 multiple feature_specs for one Feature is not allowed.
        repeated .google.cloud.aiplatform.v1.ImportFeatureValuesRequest.FeatureSpec feature_specs = 8 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFeatureSpecsList in interface ImportFeatureValuesRequestOrBuilder

      • getFeatureSpecsCount

        public int getFeatureSpecsCount()
         Required. Specifications defining which Feature values to import from the
 entity. The request fails if no feature_specs are provided, and having
 multiple feature_specs for one Feature is not allowed.
        repeated .google.cloud.aiplatform.v1.ImportFeatureValuesRequest.FeatureSpec feature_specs = 8 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFeatureSpecsCount in interface ImportFeatureValuesRequestOrBuilder

      • getFeatureSpecs

        public ImportFeatureValuesRequest.FeatureSpec getFeatureSpecs​(int index)
         Required. Specifications defining which Feature values to import from the
 entity. The request fails if no feature_specs are provided, and having
 multiple feature_specs for one Feature is not allowed.
        repeated .google.cloud.aiplatform.v1.ImportFeatureValuesRequest.FeatureSpec feature_specs = 8 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFeatureSpecs in interface ImportFeatureValuesRequestOrBuilder

      • getFeatureSpecsOrBuilder

        public ImportFeatureValuesRequest.FeatureSpecOrBuilder getFeatureSpecsOrBuilder​(int index)
         Required. Specifications defining which Feature values to import from the
 entity. The request fails if no feature_specs are provided, and having
 multiple feature_specs for one Feature is not allowed.
        repeated .google.cloud.aiplatform.v1.ImportFeatureValuesRequest.FeatureSpec feature_specs = 8 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFeatureSpecsOrBuilder in interface ImportFeatureValuesRequestOrBuilder

      • getDisableOnlineServing

        public boolean getDisableOnlineServing()
         If set, data will not be imported for online serving. This
 is typically used for backfilling, where Feature generation timestamps are
 not in the timestamp range needed for online serving.
        bool disable_online_serving = 9;
        Specified by:
        getDisableOnlineServing in interface ImportFeatureValuesRequestOrBuilder
        Returns:
        The disableOnlineServing.

      • getWorkerCount

        public int getWorkerCount()
         Specifies the number of workers that are used to write data to the
 Featurestore. Consider the online serving capacity that you require to
 achieve the desired import throughput without interfering with online
 serving. The value must be positive, and less than or equal to 100.
 If not set, defaults to using 1 worker. The low count ensures minimal
 impact on online serving performance.
        int32 worker_count = 11;
        Specified by:
        getWorkerCount in interface ImportFeatureValuesRequestOrBuilder
        Returns:
        The workerCount.

      • 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 ImportFeatureValuesRequest parseFrom​(ByteBuffer data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<ImportFeatureValuesRequest> 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 ImportFeatureValuesRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder