Class: Google::Cloud::AIPlatform::V1::ImportFeatureValuesRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb

Overview

Request message for FeaturestoreService.ImportFeatureValues.

Defined Under Namespace

Classes: FeatureSpec

Instance Attribute Summary collapse

Instance Attribute Details

#avro_source ⇒ ::Google::Cloud::AIPlatform::V1::AvroSource

Returns:



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 217

class ImportFeatureValuesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines the Feature value(s) to import.
  # @!attribute [rw] id
  #   @return [::String]
  #     Required. ID of the Feature to import values of. This Feature must exist in the
  #     target EntityType, or the request will fail.
  # @!attribute [rw] source_field
  #   @return [::String]
  #     Source column to get the Feature values from. If not set, uses the column
  #     with the same name as the Feature ID.
  class FeatureSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#bigquery_source ⇒ ::Google::Cloud::AIPlatform::V1::BigQuerySource

Returns:



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 217

class ImportFeatureValuesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines the Feature value(s) to import.
  # @!attribute [rw] id
  #   @return [::String]
  #     Required. ID of the Feature to import values of. This Feature must exist in the
  #     target EntityType, or the request will fail.
  # @!attribute [rw] source_field
  #   @return [::String]
  #     Source column to get the Feature values from. If not set, uses the column
  #     with the same name as the Feature ID.
  class FeatureSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#csv_source ⇒ ::Google::Cloud::AIPlatform::V1::CsvSource

Returns:



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 217

class ImportFeatureValuesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines the Feature value(s) to import.
  # @!attribute [rw] id
  #   @return [::String]
  #     Required. ID of the Feature to import values of. This Feature must exist in the
  #     target EntityType, or the request will fail.
  # @!attribute [rw] source_field
  #   @return [::String]
  #     Source column to get the Feature values from. If not set, uses the column
  #     with the same name as the Feature ID.
  class FeatureSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#disable_ingestion_analysis ⇒ ::Boolean

Returns If true, API doesn't start ingestion analysis pipeline.

Returns:

  • (::Boolean) —

    If true, API doesn't start ingestion analysis pipeline.



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 217

class ImportFeatureValuesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines the Feature value(s) to import.
  # @!attribute [rw] id
  #   @return [::String]
  #     Required. ID of the Feature to import values of. This Feature must exist in the
  #     target EntityType, or the request will fail.
  # @!attribute [rw] source_field
  #   @return [::String]
  #     Source column to get the Feature values from. If not set, uses the column
  #     with the same name as the Feature ID.
  class FeatureSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#disable_online_serving ⇒ ::Boolean

Returns 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.

Returns:

  • (::Boolean) —

    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.



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 217

class ImportFeatureValuesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines the Feature value(s) to import.
  # @!attribute [rw] id
  #   @return [::String]
  #     Required. ID of the Feature to import values of. This Feature must exist in the
  #     target EntityType, or the request will fail.
  # @!attribute [rw] source_field
  #   @return [::String]
  #     Source column to get the Feature values from. If not set, uses the column
  #     with the same name as the Feature ID.
  class FeatureSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#entity_id_field ⇒ ::String

Returns Source column that holds entity IDs. If not provided, entity IDs are extracted from the column named entity_id.

Returns:

  • (::String) —

    Source column that holds entity IDs. If not provided, entity IDs are extracted from the column named entity_id.



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 217

class ImportFeatureValuesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines the Feature value(s) to import.
  # @!attribute [rw] id
  #   @return [::String]
  #     Required. ID of the Feature to import values of. This Feature must exist in the
  #     target EntityType, or the request will fail.
  # @!attribute [rw] source_field
  #   @return [::String]
  #     Source column to get the Feature values from. If not set, uses the column
  #     with the same name as the Feature ID.
  class FeatureSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#entity_type ⇒ ::String

Returns 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}.

Returns:

  • (::String) —

    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}



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 217

class ImportFeatureValuesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines the Feature value(s) to import.
  # @!attribute [rw] id
  #   @return [::String]
  #     Required. ID of the Feature to import values of. This Feature must exist in the
  #     target EntityType, or the request will fail.
  # @!attribute [rw] source_field
  #   @return [::String]
  #     Source column to get the Feature values from. If not set, uses the column
  #     with the same name as the Feature ID.
  class FeatureSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#feature_specs ⇒ ::Array<::Google::Cloud::AIPlatform::V1::ImportFeatureValuesRequest::FeatureSpec>

Returns 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.

Returns:



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 217

class ImportFeatureValuesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines the Feature value(s) to import.
  # @!attribute [rw] id
  #   @return [::String]
  #     Required. ID of the Feature to import values of. This Feature must exist in the
  #     target EntityType, or the request will fail.
  # @!attribute [rw] source_field
  #   @return [::String]
  #     Source column to get the Feature values from. If not set, uses the column
  #     with the same name as the Feature ID.
  class FeatureSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#feature_time ⇒ ::Google::Protobuf::Timestamp

Returns Single Feature timestamp for all entities being imported. The timestamp must not have higher than millisecond precision.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Single Feature timestamp for all entities being imported. The timestamp must not have higher than millisecond precision.



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 217

class ImportFeatureValuesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines the Feature value(s) to import.
  # @!attribute [rw] id
  #   @return [::String]
  #     Required. ID of the Feature to import values of. This Feature must exist in the
  #     target EntityType, or the request will fail.
  # @!attribute [rw] source_field
  #   @return [::String]
  #     Source column to get the Feature values from. If not set, uses the column
  #     with the same name as the Feature ID.
  class FeatureSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#feature_time_field ⇒ ::String

Returns Source column that holds the Feature timestamp for all Feature values in each entity.

Returns:

  • (::String) —

    Source column that holds the Feature timestamp for all Feature values in each entity.



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 217

class ImportFeatureValuesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines the Feature value(s) to import.
  # @!attribute [rw] id
  #   @return [::String]
  #     Required. ID of the Feature to import values of. This Feature must exist in the
  #     target EntityType, or the request will fail.
  # @!attribute [rw] source_field
  #   @return [::String]
  #     Source column to get the Feature values from. If not set, uses the column
  #     with the same name as the Feature ID.
  class FeatureSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#worker_count ⇒ ::Integer

Returns 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.

Returns:

  • (::Integer) —

    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.



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'proto_docs/google/cloud/aiplatform/v1/featurestore_service.rb', line 217

class ImportFeatureValuesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines the Feature value(s) to import.
  # @!attribute [rw] id
  #   @return [::String]
  #     Required. ID of the Feature to import values of. This Feature must exist in the
  #     target EntityType, or the request will fail.
  # @!attribute [rw] source_field
  #   @return [::String]
  #     Source column to get the Feature values from. If not set, uses the column
  #     with the same name as the Feature ID.
  class FeatureSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end