Class: OCI::ManagementDashboard::Models::CreateManagementDashboardDetails

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

Overview

Properties of a dashboard. ID of the dashboard must only be provided for Out-of-the-Box (OOB) dashboards.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateManagementDashboardDetails

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

  • :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

  • :tiles (Array<OCI::ManagementDashboard::Models::ManagementDashboardTileDetails>) —

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

  • :is_oob_dashboard (BOOLEAN) —

    The value to assign to the #is_oob_dashboard property

  • :is_show_in_home (BOOLEAN) —

    The value to assign to the #is_show_in_home property

  • :metadata_version (String) —

    The value to assign to the #metadata_version property

  • :is_show_description (BOOLEAN) —

    The value to assign to the #is_show_description property

  • :screen_image (String) —

    The value to assign to the #screen_image property

  • :nls (Object) —

    The value to assign to the #nls property

  • :ui_config (Object) —

    The value to assign to the #ui_config property

  • :data_config (Array<Object>) —

    The value to assign to the #data_config property

  • :type (String) —

    The value to assign to the #type property

  • :is_favorite (BOOLEAN) —

    The value to assign to the #is_favorite property

  • :parameters_config (Array<Object>) —

    The value to assign to the #parameters_config property

  • :features_config (Object) —

    The value to assign to the #features_config property

  • :drilldown_config (Array<Object>) —

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



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
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 198

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

  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.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.is_show_in_home = attributes[:'isShowInHome'] unless attributes[:'isShowInHome'].nil?

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

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

  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.is_show_description = attributes[:'isShowDescription'] unless attributes[:'isShowDescription'].nil?

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

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

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

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

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

  self.data_config = attributes[:'dataConfig'] if attributes[:'dataConfig']

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

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

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

  self.is_favorite = attributes[:'isFavorite'] unless attributes[:'isFavorite'].nil?

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

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

  self.parameters_config = attributes[:'parametersConfig'] if attributes[:'parametersConfig']

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

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

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

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

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

  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) 


41
42
43
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 41

def compartment_id
  @compartment_id
end

#dashboard_id ⇒ String

ID of the dashboard, which must only be provided for Out-of-the-Box (OOB) dashboards.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 13

def dashboard_id
  @dashboard_id
end

#data_config ⇒ Array<Object>

[Required] Array of JSON that contain data source options.

Returns:

  • (Array<Object>) 


73
74
75
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 73

def data_config
  @data_config
end

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

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>>) 


105
106
107
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 105

def defined_tags
  @defined_tags
end

#description ⇒ String

[Required] Description of the dashboard.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 37

def description
  @description
end

#display_name ⇒ String

[Required] Display name of the dashboard.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 33

def display_name
  @display_name
end

#drilldown_config ⇒ Array<Object>

Drill-down configuration to define the destination of a drill-down action.

Returns:

  • (Array<Object>) 


93
94
95
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 93

def drilldown_config
  @drilldown_config
end

#features_config ⇒ Object

Contains configuration for enabling features.

Returns:

  • (Object) 


89
90
91
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 89

def features_config
  @features_config
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: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


99
100
101
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 99

def freeform_tags
  @freeform_tags
end

#is_favorite ⇒ BOOLEAN

[Required] Determines whether the dashboard is set as favorite.

Returns:

  • (BOOLEAN) 


81
82
83
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 81

def is_favorite
  @is_favorite
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) 


45
46
47
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 45

def is_oob_dashboard
  @is_oob_dashboard
end

#is_show_description ⇒ BOOLEAN

[Required] Determines whether the description of the dashboard is displayed.

Returns:

  • (BOOLEAN) 


57
58
59
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 57

def is_show_description
  @is_show_description
end

#is_show_in_home ⇒ BOOLEAN

[Required] Determines whether the dashboard will be displayed in Dashboard Home.

Returns:

  • (BOOLEAN) 


49
50
51
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 49

def is_show_in_home
  @is_show_in_home
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) 


53
54
55
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 53

def metadata_version
  @metadata_version
end

#nls ⇒ Object

[Required] JSON that contains internationalization options.

Returns:

  • (Object) 


65
66
67
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 65

def nls
  @nls
end

#parameters_config ⇒ Array<Object>

Defines parameters for the dashboard.

Returns:

  • (Array<Object>) 


85
86
87
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 85

def parameters_config
  @parameters_config
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) 


17
18
19
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 17

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) 


21
22
23
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 21

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) 


25
26
27
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 25

def provider_version
  @provider_version
end

#screen_image ⇒ String

[Required] Screen image of the dashboard.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 61

def screen_image
  @screen_image
end

#tiles ⇒ Array<OCI::ManagementDashboard::Models::ManagementDashboardTileDetails>

[Required] Array of dashboard tiles.

Returns:



29
30
31
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 29

def tiles
  @tiles
end

#type ⇒ String

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

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 77

def type
  @type
end

#ui_config ⇒ Object

[Required] JSON that contains user interface options.

Returns:

  • (Object) 


69
70
71
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 69

def ui_config
  @ui_config
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'dashboard_id': :'dashboardId',
    'provider_id': :'providerId',
    'provider_name': :'providerName',
    'provider_version': :'providerVersion',
    'tiles': :'tiles',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'is_oob_dashboard': :'isOobDashboard',
    'is_show_in_home': :'isShowInHome',
    'metadata_version': :'metadataVersion',
    'is_show_description': :'isShowDescription',
    'screen_image': :'screenImage',
    'nls': :'nls',
    'ui_config': :'uiConfig',
    'data_config': :'dataConfig',
    'type': :'type',
    'is_favorite': :'isFavorite',
    'parameters_config': :'parametersConfig',
    'features_config': :'featuresConfig',
    'drilldown_config': :'drilldownConfig',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'dashboard_id': :'String',
    'provider_id': :'String',
    'provider_name': :'String',
    'provider_version': :'String',
    'tiles': :'Array<OCI::ManagementDashboard::Models::ManagementDashboardTileDetails>',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'is_oob_dashboard': :'BOOLEAN',
    'is_show_in_home': :'BOOLEAN',
    'metadata_version': :'String',
    'is_show_description': :'BOOLEAN',
    'screen_image': :'String',
    'nls': :'Object',
    'ui_config': :'Object',
    'data_config': :'Array<Object>',
    'type': :'String',
    'is_favorite': :'BOOLEAN',
    'parameters_config': :'Array<Object>',
    'features_config': :'Object',
    'drilldown_config': :'Array<Object>',
    '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



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 334

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

  self.class == other.class &&
    dashboard_id == other.dashboard_id &&
    provider_id == other.provider_id &&
    provider_name == other.provider_name &&
    provider_version == other.provider_version &&
    tiles == other.tiles &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    is_oob_dashboard == other.is_oob_dashboard &&
    is_show_in_home == other.is_show_in_home &&
    metadata_version == other.metadata_version &&
    is_show_description == other.is_show_description &&
    screen_image == other.screen_image &&
    nls == other.nls &&
    ui_config == other.ui_config &&
    data_config == other.data_config &&
    type == other.type &&
    is_favorite == other.is_favorite &&
    parameters_config == other.parameters_config &&
    features_config == other.features_config &&
    drilldown_config == other.drilldown_config &&
    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



386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 386

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



375
376
377
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 375

def hash
  [dashboard_id, provider_id, provider_name, provider_version, tiles, display_name, description, compartment_id, is_oob_dashboard, is_show_in_home, metadata_version, is_show_description, screen_image, nls, ui_config, data_config, type, is_favorite, parameters_config, features_config, drilldown_config, 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



419
420
421
422
423
424
425
426
427
428
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 419

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



413
414
415
 
# File 'lib/oci/management_dashboard/models/create_management_dashboard_details.rb', line 413

def to_s
  to_hash.to_s
end