Class: OCI::DashboardService::Models::V1Dashboard

Inherits:
Dashboard
  • Object
show all
Defined in:
lib/oci/dashboard_service/models/v1_dashboard.rb

Overview

A version 1 dashboard. The interpretation of the config and widgets fields depends on the runtime behavior of the Oracle Cloud Infrastructure Console. The sum of the config and widget fields JSON text representation cannot exceed 200 KB.

Constant Summary

Constants inherited from Dashboard

Dashboard::LIFECYCLE_STATE_ENUM, Dashboard::SCHEMA_VERSION_ENUM

Instance Attribute Summary collapse

Attributes inherited from Dashboard

#compartment_id, #dashboard_group_id, #defined_tags, #description, #display_name, #freeform_tags, #id, #lifecycle_state, #schema_version, #system_tags, #time_created, #time_updated

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Dashboard

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ V1Dashboard

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id proprety

  • :dashboard_group_id (String) —

    The value to assign to the #dashboard_group_id proprety

  • :display_name (String) —

    The value to assign to the #display_name proprety

  • :description (String) —

    The value to assign to the #description proprety

  • :compartment_id (String) —

    The value to assign to the #compartment_id proprety

  • :time_created (DateTime) —

    The value to assign to the #time_created proprety

  • :time_updated (DateTime) —

    The value to assign to the #time_updated proprety

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state proprety

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags proprety

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags proprety

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags proprety

  • :config (Object) —

    The value to assign to the #config property

  • :widgets (Array<Object>) —

    The value to assign to the #widgets property



86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/dashboard_service/models/v1_dashboard.rb', line 86

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['schemaVersion'] = 'V1'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.config = attributes[:'config'] if attributes[:'config']

  self.widgets = attributes[:'widgets'] if attributes[:'widgets']
end

Instance Attribute Details

#config ⇒ Object

The dashboard configuration. For example, the layout and widget placement.

Returns:

  • (Object) 


17
18
19
 
# File 'lib/oci/dashboard_service/models/v1_dashboard.rb', line 17

def config
  @config
end

#widgets ⇒ Array<Object>

[Required] The visualization building blocks of the dashboard.

Returns:

  • (Array<Object>) 


21
22
23
 
# File 'lib/oci/dashboard_service/models/v1_dashboard.rb', line 21

def widgets
  @widgets
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/oci/dashboard_service/models/v1_dashboard.rb', line 24

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'dashboard_group_id': :'dashboardGroupId',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'schema_version': :'schemaVersion',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'config': :'config',
    'widgets': :'widgets'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/dashboard_service/models/v1_dashboard.rb', line 46

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'dashboard_group_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'schema_version': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'config': :'Object',
    'widgets': :'Array<Object>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/oci/dashboard_service/models/v1_dashboard.rb', line 108

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    dashboard_group_id == other.dashboard_group_id &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    schema_version == other.schema_version &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    config == other.config &&
    widgets == other.widgets
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/dashboard_service/models/v1_dashboard.rb', line 151

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


131
132
133
 
# File 'lib/oci/dashboard_service/models/v1_dashboard.rb', line 131

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



140
141
142
 
# File 'lib/oci/dashboard_service/models/v1_dashboard.rb', line 140

def hash
  [id, dashboard_group_id, display_name, description, compartment_id, schema_version, time_created, time_updated, lifecycle_state, freeform_tags, defined_tags, system_tags, config, widgets].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/dashboard_service/models/v1_dashboard.rb', line 184

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

Returns:

  • (String) —

    String presentation of the object



178
179
180
 
# File 'lib/oci/dashboard_service/models/v1_dashboard.rb', line 178

def to_s
  to_hash.to_s
end