Class: OCI::Opsi::Models::OpsiDataObject
- Inherits:
-
Object
- Object
- OCI::Opsi::Models::OpsiDataObject
- Defined in:
- lib/oci/opsi/models/opsi_data_object.rb
Overview
OPSI data object. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class
Direct Known Subclasses
DatabaseInsightsDataObject, ExadataInsightsDataObject, HostInsightsDataObject
Constant Summary collapse
- DATA_OBJECT_TYPE_ENUM =
[ DATA_OBJECT_TYPE_DATABASE_INSIGHTS_DATA_OBJECT = 'DATABASE_INSIGHTS_DATA_OBJECT'.freeze, DATA_OBJECT_TYPE_HOST_INSIGHTS_DATA_OBJECT = 'HOST_INSIGHTS_DATA_OBJECT'.freeze, DATA_OBJECT_TYPE_EXADATA_INSIGHTS_DATA_OBJECT = 'EXADATA_INSIGHTS_DATA_OBJECT'.freeze, DATA_OBJECT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#columns_metadata ⇒ Array<OCI::Opsi::Models::DataObjectColumnMetadata>
[Required] Metadata of columns in a data object.
-
#data_object_type ⇒ String
[Required] Type of OPSI data object.
-
#description ⇒ String
Description of OPSI data object.
-
#display_name ⇒ String
[Required] User-friendly name of OPSI data object.
-
#group_names ⇒ Array<String>
Names of all the groups to which the data object belongs to.
-
#identifier ⇒ String
[Required] Unique identifier of OPSI data object.
-
#name ⇒ String
Name of the data object, which can be used in data object queries just like how view names are used in a query.
-
#supported_query_params ⇒ Array<OCI::Opsi::Models::OpsiDataObjectSupportedQueryParam>
Supported query parameters by this OPSI data object that can be configured while a data object query involving this data object is executed.
-
#supported_query_time_period ⇒ String
Time period supported by the data object for quering data.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.get_subtype(object_hash) ⇒ Object
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ OpsiDataObject
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ OpsiDataObject
Initializes the object
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/oci/opsi/models/opsi_data_object.rb', line 125 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.identifier = attributes[:'identifier'] if attributes[:'identifier'] self.data_object_type = attributes[:'dataObjectType'] if attributes[:'dataObjectType'] raise 'You cannot provide both :dataObjectType and :data_object_type' if attributes.key?(:'dataObjectType') && attributes.key?(:'data_object_type') self.data_object_type = attributes[:'data_object_type'] if attributes[:'data_object_type'] self.display_name = attributes[:'displayName'] if attributes[:'displayName'] raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name') self.display_name = attributes[:'display_name'] if attributes[:'display_name'] self.description = attributes[:'description'] if attributes[:'description'] self.name = attributes[:'name'] if attributes[:'name'] self.group_names = attributes[:'groupNames'] if attributes[:'groupNames'] raise 'You cannot provide both :groupNames and :group_names' if attributes.key?(:'groupNames') && attributes.key?(:'group_names') self.group_names = attributes[:'group_names'] if attributes[:'group_names'] self.supported_query_time_period = attributes[:'supportedQueryTimePeriod'] if attributes[:'supportedQueryTimePeriod'] raise 'You cannot provide both :supportedQueryTimePeriod and :supported_query_time_period' if attributes.key?(:'supportedQueryTimePeriod') && attributes.key?(:'supported_query_time_period') self.supported_query_time_period = attributes[:'supported_query_time_period'] if attributes[:'supported_query_time_period'] self. = attributes[:'columnsMetadata'] if attributes[:'columnsMetadata'] raise 'You cannot provide both :columnsMetadata and :columns_metadata' if attributes.key?(:'columnsMetadata') && attributes.key?(:'columns_metadata') self. = attributes[:'columns_metadata'] if attributes[:'columns_metadata'] self.supported_query_params = attributes[:'supportedQueryParams'] if attributes[:'supportedQueryParams'] raise 'You cannot provide both :supportedQueryParams and :supported_query_params' if attributes.key?(:'supportedQueryParams') && attributes.key?(:'supported_query_params') self.supported_query_params = attributes[:'supported_query_params'] if attributes[:'supported_query_params'] end |
Instance Attribute Details
#columns_metadata ⇒ Array<OCI::Opsi::Models::DataObjectColumnMetadata>
[Required] Metadata of columns in a data object.
53 54 55 |
# File 'lib/oci/opsi/models/opsi_data_object.rb', line 53 def @columns_metadata end |
#data_object_type ⇒ String
[Required] Type of OPSI data object.
26 27 28 |
# File 'lib/oci/opsi/models/opsi_data_object.rb', line 26 def data_object_type @data_object_type end |
#description ⇒ String
Description of OPSI data object.
34 35 36 |
# File 'lib/oci/opsi/models/opsi_data_object.rb', line 34 def description @description end |
#display_name ⇒ String
[Required] User-friendly name of OPSI data object.
30 31 32 |
# File 'lib/oci/opsi/models/opsi_data_object.rb', line 30 def display_name @display_name end |
#group_names ⇒ Array<String>
Names of all the groups to which the data object belongs to.
42 43 44 |
# File 'lib/oci/opsi/models/opsi_data_object.rb', line 42 def group_names @group_names end |
#identifier ⇒ String
[Required] Unique identifier of OPSI data object.
22 23 24 |
# File 'lib/oci/opsi/models/opsi_data_object.rb', line 22 def identifier @identifier end |
#name ⇒ String
Name of the data object, which can be used in data object queries just like how view names are used in a query.
38 39 40 |
# File 'lib/oci/opsi/models/opsi_data_object.rb', line 38 def name @name end |
#supported_query_params ⇒ Array<OCI::Opsi::Models::OpsiDataObjectSupportedQueryParam>
Supported query parameters by this OPSI data object that can be configured while a data object query involving this data object is executed.
57 58 59 |
# File 'lib/oci/opsi/models/opsi_data_object.rb', line 57 def supported_query_params @supported_query_params end |
#supported_query_time_period ⇒ String
Time period supported by the data object for quering data. Time period is in ISO 8601 format with respect to current time. Default is last 30 days represented by P30D. Examples: P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months).
49 50 51 |
# File 'lib/oci/opsi/models/opsi_data_object.rb', line 49 def supported_query_time_period @supported_query_time_period end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
# File 'lib/oci/opsi/models/opsi_data_object.rb', line 60 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'identifier': :'identifier', 'data_object_type': :'dataObjectType', 'display_name': :'displayName', 'description': :'description', 'name': :'name', 'group_names': :'groupNames', 'supported_query_time_period': :'supportedQueryTimePeriod', 'columns_metadata': :'columnsMetadata', 'supported_query_params': :'supportedQueryParams' # rubocop:enable Style/SymbolLiteral } end |
.get_subtype(object_hash) ⇒ Object
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
98 99 100 101 102 103 104 105 106 107 |
# File 'lib/oci/opsi/models/opsi_data_object.rb', line 98 def self.get_subtype(object_hash) type = object_hash[:'dataObjectType'] # rubocop:disable Style/SymbolLiteral return 'OCI::Opsi::Models::HostInsightsDataObject' if type == 'HOST_INSIGHTS_DATA_OBJECT' return 'OCI::Opsi::Models::ExadataInsightsDataObject' if type == 'EXADATA_INSIGHTS_DATA_OBJECT' return 'OCI::Opsi::Models::DatabaseInsightsDataObject' if type == 'DATABASE_INSIGHTS_DATA_OBJECT' # TODO: Log a warning when the subtype is not found. 'OCI::Opsi::Models::OpsiDataObject' end |
.swagger_types ⇒ Object
Attribute type mapping.
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/oci/opsi/models/opsi_data_object.rb', line 77 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'identifier': :'String', 'data_object_type': :'String', 'display_name': :'String', 'description': :'String', 'name': :'String', 'group_names': :'Array<String>', 'supported_query_time_period': :'String', 'columns_metadata': :'Array<OCI::Opsi::Models::DataObjectColumnMetadata>', 'supported_query_params': :'Array<OCI::Opsi::Models::OpsiDataObjectSupportedQueryParam>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
194 195 196 197 198 199 200 201 202 203 204 205 206 207 |
# File 'lib/oci/opsi/models/opsi_data_object.rb', line 194 def ==(other) return true if equal?(other) self.class == other.class && identifier == other.identifier && data_object_type == other.data_object_type && display_name == other.display_name && description == other.description && name == other.name && group_names == other.group_names && supported_query_time_period == other.supported_query_time_period && == other. && supported_query_params == other.supported_query_params end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 |
# File 'lib/oci/opsi/models/opsi_data_object.rb', line 232 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? public_method("#{key}=").call( OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]) ) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(other) ⇒ Boolean
212 213 214 |
# File 'lib/oci/opsi/models/opsi_data_object.rb', line 212 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
221 222 223 |
# File 'lib/oci/opsi/models/opsi_data_object.rb', line 221 def hash [identifier, data_object_type, display_name, description, name, group_names, supported_query_time_period, , supported_query_params].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
265 266 267 268 269 270 271 272 273 274 |
# File 'lib/oci/opsi/models/opsi_data_object.rb', line 265 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = public_method(attr).call next if value.nil? && !instance_variable_defined?("@#{attr}") hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
259 260 261 |
# File 'lib/oci/opsi/models/opsi_data_object.rb', line 259 def to_s to_hash.to_s end |