Class: OCI::ManagementDashboard::Models::ManagementDashboardSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/management_dashboard/models/management_dashboard_summary.rb

Overview

Summary of the properties of a dashboard.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ManagementDashboardSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :dashboard_id (String) —

    The value to assign to the #dashboard_id property

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :provider_id (String) —

    The value to assign to the #provider_id property

  • :provider_name (String) —

    The value to assign to the #provider_name property

  • :provider_version (String) —

    The value to assign to the #provider_version property

  • :is_oob_dashboard (BOOLEAN) —

    The value to assign to the #is_oob_dashboard property

  • :created_by (String) —

    The value to assign to the #created_by property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :updated_by (String) —

    The value to assign to the #updated_by property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :metadata_version (String) —

    The value to assign to the #metadata_version property

  • :screen_image (String) —

    The value to assign to the #screen_image property

  • :nls (Object) —

    The value to assign to the #nls property

  • :type (String) —

    The value to assign to the #type property

  • :features_config (Object) —

    The value to assign to the #features_config property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state 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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 190

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_id = attributes[:'dashboardId'] if attributes[:'dashboardId']

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

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

  self.id = attributes[:'id'] if attributes[:'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.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.provider_id = attributes[:'providerId'] if attributes[:'providerId']

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

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

  self.provider_name = attributes[:'providerName'] if attributes[:'providerName']

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

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

  self.provider_version = attributes[:'providerVersion'] if attributes[:'providerVersion']

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

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

  self.is_oob_dashboard = attributes[:'isOobDashboard'] unless attributes[:'isOobDashboard'].nil?

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

  self.is_oob_dashboard = attributes[:'is_oob_dashboard'] unless attributes[:'is_oob_dashboard'].nil?

  self.created_by = attributes[:'createdBy'] if attributes[:'createdBy']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.updated_by = attributes[:'updatedBy'] if attributes[:'updatedBy']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.metadata_version = attributes[:'metadataVersion'] if attributes[:'metadataVersion']

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

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

  self.screen_image = attributes[:'screenImage'] if attributes[:'screenImage']

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

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

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

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

  self.features_config = attributes[:'featuresConfig'] if attributes[:'featuresConfig']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  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

#compartment_id ⇒ String

[Required] OCID of the compartment in which the dashboard resides.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 35

def compartment_id
  @compartment_id
end

#created_by ⇒ String

[Required] User who created the dashboard.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 55

def created_by
  @created_by
end

#dashboard_id ⇒ String

[Required] ID of the dashboard. Same as id.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 19

def dashboard_id
  @dashboard_id
end

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

[Required] Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


103
104
105
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 103

def defined_tags
  @defined_tags
end

#description ⇒ String

[Required] Description of the dashboard.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 31

def description
  @description
end

#display_name ⇒ String

[Required] Display name of the dashboard.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 27

def display_name
  @display_name
end

#features_config ⇒ Object

Contains configuration for enabling features.

Returns:

  • (Object) 


87
88
89
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 87

def features_config
  @features_config
end

#freeform_tags ⇒ Hash<String, String>

[Required] Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


97
98
99
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 97

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] ID of the dashboard. Same as dashboardId.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 23

def id
  @id
end

#is_oob_dashboard ⇒ BOOLEAN

[Required] Determines whether the dashboard is an Out-of-the-Box (OOB) dashboard. Note that OOB dashboards are only provided by Oracle and cannot be modified.

Returns:

  • (BOOLEAN) 


51
52
53
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 51

def is_oob_dashboard
  @is_oob_dashboard
end

#lifecycle_state ⇒ String

[Required] Current lifecycle state of the dashboard.

Returns:

  • (String) 


91
92
93
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 91

def lifecycle_state
  @lifecycle_state
end

#metadata_version ⇒ String

[Required] The version of the metadata defined in the API. This is maintained and enforced by dashboard server. Currently it is 2.0.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 71

def metadata_version
  @metadata_version
end

#nls ⇒ Object

[Required] JSON that contains internationalization options.

Returns:

  • (Object) 


79
80
81
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 79

def nls
  @nls
end

#provider_id ⇒ String

[Required] ID of the service (for example, log-analytics) that owns the dashboard. Each service has a unique ID.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 39

def provider_id
  @provider_id
end

#provider_name ⇒ String

[Required] The user friendly name of the service (for example, Logging Analytics) that owns the dashboard.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 43

def provider_name
  @provider_name
end

#provider_version ⇒ String

[Required] The version of the metadata of the provider. This is useful for provider to version its features and metadata. Any newly created saved search (or dashboard) should use providerVersion 3.0.0.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 47

def provider_version
  @provider_version
end

#screen_image ⇒ String

[Required] Screen image of the dashboard.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 75

def screen_image
  @screen_image
end

#time_created ⇒ DateTime

[Required] Date and time the dashboard was created.

Returns:

  • (DateTime) 


59
60
61
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 59

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] Date and time the dashboard was updated.

Returns:

  • (DateTime) 


67
68
69
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 67

def time_updated
  @time_updated
end

#type ⇒ String

[Required] Type of dashboard. NORMAL denotes a single dashboard and SET denotes a dashboard set.

Returns:

  • (String) 


83
84
85
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 83

def type
  @type
end

#updated_by ⇒ String

[Required] User who updated the dashboard.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 63

def updated_by
  @updated_by
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 106

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'dashboard_id': :'dashboardId',
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'provider_id': :'providerId',
    'provider_name': :'providerName',
    'provider_version': :'providerVersion',
    'is_oob_dashboard': :'isOobDashboard',
    'created_by': :'createdBy',
    'time_created': :'timeCreated',
    'updated_by': :'updatedBy',
    'time_updated': :'timeUpdated',
    'metadata_version': :'metadataVersion',
    'screen_image': :'screenImage',
    'nls': :'nls',
    'type': :'type',
    'features_config': :'featuresConfig',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 135

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'dashboard_id': :'String',
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'provider_id': :'String',
    'provider_name': :'String',
    'provider_version': :'String',
    'is_oob_dashboard': :'BOOLEAN',
    'created_by': :'String',
    'time_created': :'DateTime',
    'updated_by': :'String',
    'time_updated': :'DateTime',
    'metadata_version': :'String',
    'screen_image': :'String',
    'nls': :'Object',
    'type': :'String',
    'features_config': :'Object',
    'lifecycle_state': :'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



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 327

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

  self.class == other.class &&
    dashboard_id == other.dashboard_id &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    provider_id == other.provider_id &&
    provider_name == other.provider_name &&
    provider_version == other.provider_version &&
    is_oob_dashboard == other.is_oob_dashboard &&
    created_by == other.created_by &&
    time_created == other.time_created &&
    updated_by == other.updated_by &&
    time_updated == other.time_updated &&
    metadata_version == other.metadata_version &&
    screen_image == other.screen_image &&
    nls == other.nls &&
    type == other.type &&
    features_config == other.features_config &&
    lifecycle_state == other.lifecycle_state &&
    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



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 377

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


357
358
359
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 357

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



366
367
368
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 366

def hash
  [dashboard_id, id, display_name, description, compartment_id, provider_id, provider_name, provider_version, is_oob_dashboard, created_by, time_created, updated_by, time_updated, metadata_version, screen_image, nls, type, features_config, lifecycle_state, 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



410
411
412
413
414
415
416
417
418
419
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 410

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



404
405
406
 
# File 'lib/oci/management_dashboard/models/management_dashboard_summary.rb', line 404

def to_s
  to_hash.to_s
end