Class: OCI::DashboardService::Models::CreateDashboardDetails

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

Overview

The base schema for creating a dashboard. Derived schemas have configurations and widgets specific to the `schemaVersion`.

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

CreateV1DashboardDetails

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateDashboardDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :dashboard_group_id (String) —

    The value to assign to the #dashboard_group_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :schema_version (String) —

    The value to assign to the #schema_version property

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

    The value to assign to the #freeform_tags property

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

    The value to assign to the #defined_tags property



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/dashboard_service/models/create_dashboard_details.rb', line 101

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.dashboard_group_id = attributes[:'dashboardGroupId'] if attributes[:'dashboardGroupId']

  raise 'You cannot provide both :dashboardGroupId and :dashboard_group_id' if attributes.key?(:'dashboardGroupId') && attributes.key?(:'dashboard_group_id')

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

  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.schema_version = attributes[:'schemaVersion'] if attributes[:'schemaVersion']

  raise 'You cannot provide both :schemaVersion and :schema_version' if attributes.key?(:'schemaVersion') && attributes.key?(:'schema_version')

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

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

Instance Attribute Details

#dashboard_group_id ⇒ String

**[Required]** The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dashboard group that the dashbaord is associated with.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/dashboard_service/models/create_dashboard_details.rb', line 15

def dashboard_group_id
  @dashboard_group_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}`

Returns:

  • (Hash<String, Hash<String, Object>>) 


44
45
46
 
# File 'lib/oci/dashboard_service/models/create_dashboard_details.rb', line 44

def defined_tags
  @defined_tags
end

#description ⇒ String

A short description of the dashboard. It can be changed. Avoid entering confidential information. The following special characters are not allowed: <>()=/'"&\

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/dashboard_service/models/create_dashboard_details.rb', line 27

def description
  @description
end

#display_name ⇒ String

A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information. Leading and trailing spaces and the following special characters are not allowed: <>()=/'"&\

Returns:

  • (String) 


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

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `"value"`

Returns:

  • (Hash<String, String>) 


38
39
40
 
# File 'lib/oci/dashboard_service/models/create_dashboard_details.rb', line 38

def freeform_tags
  @freeform_tags
end

#schema_version ⇒ String

**[Required]** The schema describing how to interpret the dashboard configuration and widgets.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/dashboard_service/models/create_dashboard_details.rb', line 32

def schema_version
  @schema_version
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/oci/dashboard_service/models/create_dashboard_details.rb', line 47

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'dashboard_group_id': :'dashboardGroupId',
    'display_name': :'displayName',
    'description': :'description',
    'schema_version': :'schemaVersion',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # 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.



79
80
81
82
83
84
85
86
 
# File 'lib/oci/dashboard_service/models/create_dashboard_details.rb', line 79

def self.get_subtype(object_hash)
  type = object_hash[:'schemaVersion'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::DashboardService::Models::CreateV1DashboardDetails' if type == 'V1'

  # TODO: Log a warning when the subtype is not found.
  'OCI::DashboardService::Models::CreateDashboardDetails'
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/oci/dashboard_service/models/create_dashboard_details.rb', line 61

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'dashboard_group_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'schema_version': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, 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



147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/dashboard_service/models/create_dashboard_details.rb', line 147

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

  self.class == other.class &&
    dashboard_group_id == other.dashboard_group_id &&
    display_name == other.display_name &&
    description == other.description &&
    schema_version == other.schema_version &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/oci/dashboard_service/models/create_dashboard_details.rb', line 182

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


162
163
164
 
# File 'lib/oci/dashboard_service/models/create_dashboard_details.rb', line 162

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



171
172
173
 
# File 'lib/oci/dashboard_service/models/create_dashboard_details.rb', line 171

def hash
  [dashboard_group_id, display_name, description, schema_version, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



215
216
217
218
219
220
221
222
223
224
 
# File 'lib/oci/dashboard_service/models/create_dashboard_details.rb', line 215

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



209
210
211
 
# File 'lib/oci/dashboard_service/models/create_dashboard_details.rb', line 209

def to_s
  to_hash.to_s
end