Class: Google::Cloud::AIPlatform::V1::FeatureGroup

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

Overview

Vertex AI Feature Group.

Defined Under Namespace

Classes: BigQuery, LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#big_query ⇒ ::Google::Cloud::AIPlatform::V1::FeatureGroup::BigQuery

Returns Indicates that features for this group come from BigQuery Table/View. By default treats the source as a sparse time series source. The BigQuery source table or view must have at least one entity ID column and a column named feature_timestamp.

Returns:

  • (::Google::Cloud::AIPlatform::V1::FeatureGroup::BigQuery) —

    Indicates that features for this group come from BigQuery Table/View. By default treats the source as a sparse time series source. The BigQuery source table or view must have at least one entity ID column and a column named feature_timestamp.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/aiplatform/v1/feature_group.rb', line 61

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

  # Input source type for BigQuery Tables and Views.
  # @!attribute [rw] big_query_source
  #   @return [::Google::Cloud::AIPlatform::V1::BigQuerySource]
  #     Required. Immutable. The BigQuery source URI that points to either a
  #     BigQuery Table or View.
  # @!attribute [rw] entity_id_columns
  #   @return [::Array<::String>]
  #     Optional. Columns to construct entity_id / row keys.
  #     If not provided defaults to `entity_id`.
  # @!attribute [rw] time_series
  #   @return [::Google::Cloud::AIPlatform::V1::FeatureGroup::BigQuery::TimeSeries]
  #     Optional. If the source is a time-series source, this can be set to
  #     control how downstream sources (ex:
  #     {::Google::Cloud::AIPlatform::V1::FeatureView FeatureView} ) will treat
  #     time-series sources. If not set, will treat the source as a time-series
  #     source with `feature_timestamp` as timestamp column and no scan boundary.
  class BigQuery
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] timestamp_column
    #   @return [::String]
    #     Optional. Column hosting timestamp values for a time-series source.
    #     Will be used to determine the latest `feature_values` for each entity.
    #     Optional. If not provided, column named `feature_timestamp` of
    #     type `TIMESTAMP` will be used.
    class TimeSeries
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when this FeatureGroup was created.

Returns:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/aiplatform/v1/feature_group.rb', line 61

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

  # Input source type for BigQuery Tables and Views.
  # @!attribute [rw] big_query_source
  #   @return [::Google::Cloud::AIPlatform::V1::BigQuerySource]
  #     Required. Immutable. The BigQuery source URI that points to either a
  #     BigQuery Table or View.
  # @!attribute [rw] entity_id_columns
  #   @return [::Array<::String>]
  #     Optional. Columns to construct entity_id / row keys.
  #     If not provided defaults to `entity_id`.
  # @!attribute [rw] time_series
  #   @return [::Google::Cloud::AIPlatform::V1::FeatureGroup::BigQuery::TimeSeries]
  #     Optional. If the source is a time-series source, this can be set to
  #     control how downstream sources (ex:
  #     {::Google::Cloud::AIPlatform::V1::FeatureView FeatureView} ) will treat
  #     time-series sources. If not set, will treat the source as a time-series
  #     source with `feature_timestamp` as timestamp column and no scan boundary.
  class BigQuery
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] timestamp_column
    #   @return [::String]
    #     Optional. Column hosting timestamp values for a time-series source.
    #     Will be used to determine the latest `feature_values` for each entity.
    #     Optional. If not provided, column named `feature_timestamp` of
    #     type `TIMESTAMP` will be used.
    class TimeSeries
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#description ⇒ ::String

Returns Optional. Description of the FeatureGroup.

Returns:

  • (::String) —

    Optional. Description of the FeatureGroup.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/aiplatform/v1/feature_group.rb', line 61

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

  # Input source type for BigQuery Tables and Views.
  # @!attribute [rw] big_query_source
  #   @return [::Google::Cloud::AIPlatform::V1::BigQuerySource]
  #     Required. Immutable. The BigQuery source URI that points to either a
  #     BigQuery Table or View.
  # @!attribute [rw] entity_id_columns
  #   @return [::Array<::String>]
  #     Optional. Columns to construct entity_id / row keys.
  #     If not provided defaults to `entity_id`.
  # @!attribute [rw] time_series
  #   @return [::Google::Cloud::AIPlatform::V1::FeatureGroup::BigQuery::TimeSeries]
  #     Optional. If the source is a time-series source, this can be set to
  #     control how downstream sources (ex:
  #     {::Google::Cloud::AIPlatform::V1::FeatureView FeatureView} ) will treat
  #     time-series sources. If not set, will treat the source as a time-series
  #     source with `feature_timestamp` as timestamp column and no scan boundary.
  class BigQuery
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] timestamp_column
    #   @return [::String]
    #     Optional. Column hosting timestamp values for a time-series source.
    #     Will be used to determine the latest `feature_values` for each entity.
    #     Optional. If not provided, column named `feature_timestamp` of
    #     type `TIMESTAMP` will be used.
    class TimeSeries
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#etag ⇒ ::String

Returns Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Returns:

  • (::String) —

    Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/aiplatform/v1/feature_group.rb', line 61

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

  # Input source type for BigQuery Tables and Views.
  # @!attribute [rw] big_query_source
  #   @return [::Google::Cloud::AIPlatform::V1::BigQuerySource]
  #     Required. Immutable. The BigQuery source URI that points to either a
  #     BigQuery Table or View.
  # @!attribute [rw] entity_id_columns
  #   @return [::Array<::String>]
  #     Optional. Columns to construct entity_id / row keys.
  #     If not provided defaults to `entity_id`.
  # @!attribute [rw] time_series
  #   @return [::Google::Cloud::AIPlatform::V1::FeatureGroup::BigQuery::TimeSeries]
  #     Optional. If the source is a time-series source, this can be set to
  #     control how downstream sources (ex:
  #     {::Google::Cloud::AIPlatform::V1::FeatureView FeatureView} ) will treat
  #     time-series sources. If not set, will treat the source as a time-series
  #     source with `feature_timestamp` as timestamp column and no scan boundary.
  class BigQuery
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] timestamp_column
    #   @return [::String]
    #     Optional. Column hosting timestamp values for a time-series source.
    #     Will be used to determine the latest `feature_values` for each entity.
    #     Optional. If not provided, column named `feature_timestamp` of
    #     type `TIMESTAMP` will be used.
    class TimeSeries
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. The labels with user-defined metadata to organize your FeatureGroup.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureGroup(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Optional. The labels with user-defined metadata to organize your FeatureGroup.

    Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

    See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureGroup(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/aiplatform/v1/feature_group.rb', line 61

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

  # Input source type for BigQuery Tables and Views.
  # @!attribute [rw] big_query_source
  #   @return [::Google::Cloud::AIPlatform::V1::BigQuerySource]
  #     Required. Immutable. The BigQuery source URI that points to either a
  #     BigQuery Table or View.
  # @!attribute [rw] entity_id_columns
  #   @return [::Array<::String>]
  #     Optional. Columns to construct entity_id / row keys.
  #     If not provided defaults to `entity_id`.
  # @!attribute [rw] time_series
  #   @return [::Google::Cloud::AIPlatform::V1::FeatureGroup::BigQuery::TimeSeries]
  #     Optional. If the source is a time-series source, this can be set to
  #     control how downstream sources (ex:
  #     {::Google::Cloud::AIPlatform::V1::FeatureView FeatureView} ) will treat
  #     time-series sources. If not set, will treat the source as a time-series
  #     source with `feature_timestamp` as timestamp column and no scan boundary.
  class BigQuery
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] timestamp_column
    #   @return [::String]
    #     Optional. Column hosting timestamp values for a time-series source.
    #     Will be used to determine the latest `feature_values` for each entity.
    #     Optional. If not provided, column named `feature_timestamp` of
    #     type `TIMESTAMP` will be used.
    class TimeSeries
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Identifier. Name of the FeatureGroup. Format: projects/{project}/locations/{location}/featureGroups/{featureGroup}.

Returns:

  • (::String) —

    Identifier. Name of the FeatureGroup. Format: projects/{project}/locations/{location}/featureGroups/{featureGroup}



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/aiplatform/v1/feature_group.rb', line 61

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

  # Input source type for BigQuery Tables and Views.
  # @!attribute [rw] big_query_source
  #   @return [::Google::Cloud::AIPlatform::V1::BigQuerySource]
  #     Required. Immutable. The BigQuery source URI that points to either a
  #     BigQuery Table or View.
  # @!attribute [rw] entity_id_columns
  #   @return [::Array<::String>]
  #     Optional. Columns to construct entity_id / row keys.
  #     If not provided defaults to `entity_id`.
  # @!attribute [rw] time_series
  #   @return [::Google::Cloud::AIPlatform::V1::FeatureGroup::BigQuery::TimeSeries]
  #     Optional. If the source is a time-series source, this can be set to
  #     control how downstream sources (ex:
  #     {::Google::Cloud::AIPlatform::V1::FeatureView FeatureView} ) will treat
  #     time-series sources. If not set, will treat the source as a time-series
  #     source with `feature_timestamp` as timestamp column and no scan boundary.
  class BigQuery
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] timestamp_column
    #   @return [::String]
    #     Optional. Column hosting timestamp values for a time-series source.
    #     Will be used to determine the latest `feature_values` for each entity.
    #     Optional. If not provided, column named `feature_timestamp` of
    #     type `TIMESTAMP` will be used.
    class TimeSeries
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when this FeatureGroup was last updated.

Returns:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/aiplatform/v1/feature_group.rb', line 61

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

  # Input source type for BigQuery Tables and Views.
  # @!attribute [rw] big_query_source
  #   @return [::Google::Cloud::AIPlatform::V1::BigQuerySource]
  #     Required. Immutable. The BigQuery source URI that points to either a
  #     BigQuery Table or View.
  # @!attribute [rw] entity_id_columns
  #   @return [::Array<::String>]
  #     Optional. Columns to construct entity_id / row keys.
  #     If not provided defaults to `entity_id`.
  # @!attribute [rw] time_series
  #   @return [::Google::Cloud::AIPlatform::V1::FeatureGroup::BigQuery::TimeSeries]
  #     Optional. If the source is a time-series source, this can be set to
  #     control how downstream sources (ex:
  #     {::Google::Cloud::AIPlatform::V1::FeatureView FeatureView} ) will treat
  #     time-series sources. If not set, will treat the source as a time-series
  #     source with `feature_timestamp` as timestamp column and no scan boundary.
  class BigQuery
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] timestamp_column
    #   @return [::String]
    #     Optional. Column hosting timestamp values for a time-series source.
    #     Will be used to determine the latest `feature_values` for each entity.
    #     Optional. If not provided, column named `feature_timestamp` of
    #     type `TIMESTAMP` will be used.
    class TimeSeries
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end