Package com.google.cloud.aiplatform.v1

Class BatchReadFeatureValuesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest
All Implemented Interfaces:
BatchReadFeatureValuesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class BatchReadFeatureValuesRequest extends com.google.protobuf.GeneratedMessage implements BatchReadFeatureValuesRequestOrBuilder
 Request message for
 [FeaturestoreService.BatchReadFeatureValues][google.cloud.aiplatform.v1.FeaturestoreService.BatchReadFeatureValues].
Protobuf type google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest
See Also:

  • Field Details

    • CSV_READ_INSTANCES_FIELD_NUMBER

      public static final int CSV_READ_INSTANCES_FIELD_NUMBER
      See Also:

    • BIGQUERY_READ_INSTANCES_FIELD_NUMBER

      public static final int BIGQUERY_READ_INSTANCES_FIELD_NUMBER
      See Also:

    • FEATURESTORE_FIELD_NUMBER

      public static final int FEATURESTORE_FIELD_NUMBER
      See Also:

    • DESTINATION_FIELD_NUMBER

      public static final int DESTINATION_FIELD_NUMBER
      See Also:

    • PASS_THROUGH_FIELDS_FIELD_NUMBER

      public static final int PASS_THROUGH_FIELDS_FIELD_NUMBER
      See Also:

    • ENTITY_TYPE_SPECS_FIELD_NUMBER

      public static final int ENTITY_TYPE_SPECS_FIELD_NUMBER
      See Also:

    • START_TIME_FIELD_NUMBER

      public static final int START_TIME_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getReadOptionCase

      public BatchReadFeatureValuesRequest.ReadOptionCase getReadOptionCase()
      Specified by:
      getReadOptionCase in interface BatchReadFeatureValuesRequestOrBuilder

    • hasCsvReadInstances

      public boolean hasCsvReadInstances()
       Each read instance consists of exactly one read timestamp and one or more
 entity IDs identifying entities of the corresponding EntityTypes whose
 Features are requested.

 Each output instance contains Feature values of requested entities
 concatenated together as of the read time.

 An example read instance may be `foo_entity_id, bar_entity_id,
 2020-01-01T10:00:00.123Z`.

 An example output instance may be `foo_entity_id, bar_entity_id,
 2020-01-01T10:00:00.123Z, foo_entity_feature1_value,
 bar_entity_feature2_value`.

 Timestamp in each read instance must be millisecond-aligned.

 `csv_read_instances` are read instances stored in a plain-text CSV file.
 The header should be:
 [ENTITY_TYPE_ID1], [ENTITY_TYPE_ID2], ..., timestamp

 The columns can be in any order.

 Values in the timestamp column must use the RFC 3339 format, e.g.
 `2012-07-30T10:43:17.123Z`.
      .google.cloud.aiplatform.v1.CsvSource csv_read_instances = 3;
      Specified by:
      hasCsvReadInstances in interface BatchReadFeatureValuesRequestOrBuilder
      Returns:
      Whether the csvReadInstances field is set.

    • getCsvReadInstances

      public CsvSource getCsvReadInstances()
       Each read instance consists of exactly one read timestamp and one or more
 entity IDs identifying entities of the corresponding EntityTypes whose
 Features are requested.

 Each output instance contains Feature values of requested entities
 concatenated together as of the read time.

 An example read instance may be `foo_entity_id, bar_entity_id,
 2020-01-01T10:00:00.123Z`.

 An example output instance may be `foo_entity_id, bar_entity_id,
 2020-01-01T10:00:00.123Z, foo_entity_feature1_value,
 bar_entity_feature2_value`.

 Timestamp in each read instance must be millisecond-aligned.

 `csv_read_instances` are read instances stored in a plain-text CSV file.
 The header should be:
 [ENTITY_TYPE_ID1], [ENTITY_TYPE_ID2], ..., timestamp

 The columns can be in any order.

 Values in the timestamp column must use the RFC 3339 format, e.g.
 `2012-07-30T10:43:17.123Z`.
      .google.cloud.aiplatform.v1.CsvSource csv_read_instances = 3;
      Specified by:
      getCsvReadInstances in interface BatchReadFeatureValuesRequestOrBuilder
      Returns:
      The csvReadInstances.

    • getCsvReadInstancesOrBuilder

      public CsvSourceOrBuilder getCsvReadInstancesOrBuilder()
       Each read instance consists of exactly one read timestamp and one or more
 entity IDs identifying entities of the corresponding EntityTypes whose
 Features are requested.

 Each output instance contains Feature values of requested entities
 concatenated together as of the read time.

 An example read instance may be `foo_entity_id, bar_entity_id,
 2020-01-01T10:00:00.123Z`.

 An example output instance may be `foo_entity_id, bar_entity_id,
 2020-01-01T10:00:00.123Z, foo_entity_feature1_value,
 bar_entity_feature2_value`.

 Timestamp in each read instance must be millisecond-aligned.

 `csv_read_instances` are read instances stored in a plain-text CSV file.
 The header should be:
 [ENTITY_TYPE_ID1], [ENTITY_TYPE_ID2], ..., timestamp

 The columns can be in any order.

 Values in the timestamp column must use the RFC 3339 format, e.g.
 `2012-07-30T10:43:17.123Z`.
      .google.cloud.aiplatform.v1.CsvSource csv_read_instances = 3;
      Specified by:
      getCsvReadInstancesOrBuilder in interface BatchReadFeatureValuesRequestOrBuilder

    • hasBigqueryReadInstances

      public boolean hasBigqueryReadInstances()
       Similar to csv_read_instances, but from BigQuery source.
      .google.cloud.aiplatform.v1.BigQuerySource bigquery_read_instances = 5;
      Specified by:
      hasBigqueryReadInstances in interface BatchReadFeatureValuesRequestOrBuilder
      Returns:
      Whether the bigqueryReadInstances field is set.

    • getBigqueryReadInstances

      public BigQuerySource getBigqueryReadInstances()
       Similar to csv_read_instances, but from BigQuery source.
      .google.cloud.aiplatform.v1.BigQuerySource bigquery_read_instances = 5;
      Specified by:
      getBigqueryReadInstances in interface BatchReadFeatureValuesRequestOrBuilder
      Returns:
      The bigqueryReadInstances.

    • getBigqueryReadInstancesOrBuilder

      public BigQuerySourceOrBuilder getBigqueryReadInstancesOrBuilder()
       Similar to csv_read_instances, but from BigQuery source.
      .google.cloud.aiplatform.v1.BigQuerySource bigquery_read_instances = 5;
      Specified by:
      getBigqueryReadInstancesOrBuilder in interface BatchReadFeatureValuesRequestOrBuilder

    • getFeaturestore

      public String getFeaturestore()
       Required. The resource name of the Featurestore from which to query Feature
 values. Format:
 `projects/{project}/locations/{location}/featurestores/{featurestore}`
      string featurestore = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getFeaturestore in interface BatchReadFeatureValuesRequestOrBuilder
      Returns:
      The featurestore.

    • getFeaturestoreBytes

      public com.google.protobuf.ByteString getFeaturestoreBytes()
       Required. The resource name of the Featurestore from which to query Feature
 values. Format:
 `projects/{project}/locations/{location}/featurestores/{featurestore}`
      string featurestore = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getFeaturestoreBytes in interface BatchReadFeatureValuesRequestOrBuilder
      Returns:
      The bytes for featurestore.

    • hasDestination

      public boolean hasDestination()
       Required. Specifies output location and format.
      .google.cloud.aiplatform.v1.FeatureValueDestination destination = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasDestination in interface BatchReadFeatureValuesRequestOrBuilder
      Returns:
      Whether the destination field is set.

    • getDestination

      public FeatureValueDestination getDestination()
       Required. Specifies output location and format.
      .google.cloud.aiplatform.v1.FeatureValueDestination destination = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDestination in interface BatchReadFeatureValuesRequestOrBuilder
      Returns:
      The destination.

    • getDestinationOrBuilder

      public FeatureValueDestinationOrBuilder getDestinationOrBuilder()
       Required. Specifies output location and format.
      .google.cloud.aiplatform.v1.FeatureValueDestination destination = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDestinationOrBuilder in interface BatchReadFeatureValuesRequestOrBuilder

    • getPassThroughFieldsList

      public List<BatchReadFeatureValuesRequest.PassThroughField> getPassThroughFieldsList()
       When not empty, the specified fields in the *_read_instances source will be
 joined as-is in the output, in addition to those fields from the
 Featurestore Entity.

 For BigQuery source, the type of the pass-through values will be
 automatically inferred. For CSV source, the pass-through values will be
 passed as opaque bytes.
      repeated .google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;
      Specified by:
      getPassThroughFieldsList in interface BatchReadFeatureValuesRequestOrBuilder

    • getPassThroughFieldsOrBuilderList

      public List<? extends BatchReadFeatureValuesRequest.PassThroughFieldOrBuilder> getPassThroughFieldsOrBuilderList()
       When not empty, the specified fields in the *_read_instances source will be
 joined as-is in the output, in addition to those fields from the
 Featurestore Entity.

 For BigQuery source, the type of the pass-through values will be
 automatically inferred. For CSV source, the pass-through values will be
 passed as opaque bytes.
      repeated .google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;
      Specified by:
      getPassThroughFieldsOrBuilderList in interface BatchReadFeatureValuesRequestOrBuilder

    • getPassThroughFieldsCount

      public int getPassThroughFieldsCount()
       When not empty, the specified fields in the *_read_instances source will be
 joined as-is in the output, in addition to those fields from the
 Featurestore Entity.

 For BigQuery source, the type of the pass-through values will be
 automatically inferred. For CSV source, the pass-through values will be
 passed as opaque bytes.
      repeated .google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;
      Specified by:
      getPassThroughFieldsCount in interface BatchReadFeatureValuesRequestOrBuilder

    • getPassThroughFields

      public BatchReadFeatureValuesRequest.PassThroughField getPassThroughFields(int index)
       When not empty, the specified fields in the *_read_instances source will be
 joined as-is in the output, in addition to those fields from the
 Featurestore Entity.

 For BigQuery source, the type of the pass-through values will be
 automatically inferred. For CSV source, the pass-through values will be
 passed as opaque bytes.
      repeated .google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;
      Specified by:
      getPassThroughFields in interface BatchReadFeatureValuesRequestOrBuilder

    • getPassThroughFieldsOrBuilder

      public BatchReadFeatureValuesRequest.PassThroughFieldOrBuilder getPassThroughFieldsOrBuilder(int index)
       When not empty, the specified fields in the *_read_instances source will be
 joined as-is in the output, in addition to those fields from the
 Featurestore Entity.

 For BigQuery source, the type of the pass-through values will be
 automatically inferred. For CSV source, the pass-through values will be
 passed as opaque bytes.
      repeated .google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.PassThroughField pass_through_fields = 8;
      Specified by:
      getPassThroughFieldsOrBuilder in interface BatchReadFeatureValuesRequestOrBuilder

    • getEntityTypeSpecsList

      public List<BatchReadFeatureValuesRequest.EntityTypeSpec> getEntityTypeSpecsList()
       Required. Specifies EntityType grouping Features to read values of and
 settings.
      repeated .google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getEntityTypeSpecsList in interface BatchReadFeatureValuesRequestOrBuilder

    • getEntityTypeSpecsOrBuilderList

      public List<? extends BatchReadFeatureValuesRequest.EntityTypeSpecOrBuilder> getEntityTypeSpecsOrBuilderList()
       Required. Specifies EntityType grouping Features to read values of and
 settings.
      repeated .google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getEntityTypeSpecsOrBuilderList in interface BatchReadFeatureValuesRequestOrBuilder

    • getEntityTypeSpecsCount

      public int getEntityTypeSpecsCount()
       Required. Specifies EntityType grouping Features to read values of and
 settings.
      repeated .google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getEntityTypeSpecsCount in interface BatchReadFeatureValuesRequestOrBuilder

    • getEntityTypeSpecs

      public BatchReadFeatureValuesRequest.EntityTypeSpec getEntityTypeSpecs(int index)
       Required. Specifies EntityType grouping Features to read values of and
 settings.
      repeated .google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getEntityTypeSpecs in interface BatchReadFeatureValuesRequestOrBuilder

    • getEntityTypeSpecsOrBuilder

      public BatchReadFeatureValuesRequest.EntityTypeSpecOrBuilder getEntityTypeSpecsOrBuilder(int index)
       Required. Specifies EntityType grouping Features to read values of and
 settings.
      repeated .google.cloud.aiplatform.v1.BatchReadFeatureValuesRequest.EntityTypeSpec entity_type_specs = 7 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getEntityTypeSpecsOrBuilder in interface BatchReadFeatureValuesRequestOrBuilder

    • hasStartTime

      public boolean hasStartTime()
       Optional. Excludes Feature values with feature generation timestamp before
 this timestamp. If not set, retrieve oldest values kept in Feature Store.
 Timestamp, if present, must not have higher than millisecond precision.
      .google.protobuf.Timestamp start_time = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasStartTime in interface BatchReadFeatureValuesRequestOrBuilder
      Returns:
      Whether the startTime field is set.

    • getStartTime

      public com.google.protobuf.Timestamp getStartTime()
       Optional. Excludes Feature values with feature generation timestamp before
 this timestamp. If not set, retrieve oldest values kept in Feature Store.
 Timestamp, if present, must not have higher than millisecond precision.
      .google.protobuf.Timestamp start_time = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getStartTime in interface BatchReadFeatureValuesRequestOrBuilder
      Returns:
      The startTime.

    • getStartTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
       Optional. Excludes Feature values with feature generation timestamp before
 this timestamp. If not set, retrieve oldest values kept in Feature Store.
 Timestamp, if present, must not have higher than millisecond precision.
      .google.protobuf.Timestamp start_time = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getStartTimeOrBuilder in interface BatchReadFeatureValuesRequestOrBuilder

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static BatchReadFeatureValuesRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BatchReadFeatureValuesRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static BatchReadFeatureValuesRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static BatchReadFeatureValuesRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BatchReadFeatureValuesRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BatchReadFeatureValuesRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static BatchReadFeatureValuesRequest.Builder newBuilder()

    • newBuilder

      public static BatchReadFeatureValuesRequest.Builder newBuilder(BatchReadFeatureValuesRequest prototype)

    • toBuilder

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

    • newBuilderForType

      protected BatchReadFeatureValuesRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static BatchReadFeatureValuesRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<BatchReadFeatureValuesRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<BatchReadFeatureValuesRequest> 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.GeneratedMessage

    • getDefaultInstanceForType

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