Class: OCI::ManagementDashboard::Models::ManagementSavedSearchForImportDetails

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

Overview

Properties of a saved search.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_SEARCH_SHOW_IN_DASHBOARD = 'SEARCH_SHOW_IN_DASHBOARD'.freeze,
  TYPE_SEARCH_DONT_SHOW_IN_DASHBOARD = 'SEARCH_DONT_SHOW_IN_DASHBOARD'.freeze,
  TYPE_WIDGET_SHOW_IN_DASHBOARD = 'WIDGET_SHOW_IN_DASHBOARD'.freeze,
  TYPE_WIDGET_DONT_SHOW_IN_DASHBOARD = 'WIDGET_DONT_SHOW_IN_DASHBOARD'.freeze,
  TYPE_FILTER_SHOW_IN_DASHBOARD = 'FILTER_SHOW_IN_DASHBOARD'.freeze,
  TYPE_FILTER_DONT_SHOW_IN_DASHBOARD = 'FILTER_DONT_SHOW_IN_DASHBOARD'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ManagementSavedSearchForImportDetails

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 property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :provider_id (String) —

    The value to assign to the #provider_id property

  • :provider_version (String) —

    The value to assign to the #provider_version property

  • :provider_name (String) —

    The value to assign to the #provider_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :is_oob_saved_search (BOOLEAN) —

    The value to assign to the #is_oob_saved_search property

  • :description (String) —

    The value to assign to the #description property

  • :nls (Object) —

    The value to assign to the #nls property

  • :type (String) —

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

  • :screen_image (String) —

    The value to assign to the #screen_image property

  • :metadata_version (String) —

    The value to assign to the #metadata_version property

  • :widget_template (String) —

    The value to assign to the #widget_template property

  • :widget_vm (String) —

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

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



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
306
307
308
309
310
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 195

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.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.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_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.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.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_saved_search = attributes[:'isOobSavedSearch'] unless attributes[:'isOobSavedSearch'].nil?

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

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

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

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

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

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

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

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

  self.widget_vm = attributes[:'widgetVM'] if attributes[:'widgetVM']

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

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

  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']

  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']
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] OCID of the compartment in which the saved search resides.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 44

def compartment_id
  @compartment_id
end

#data_config ⇒ Array<Object>

[Required] It defines how data is fetched. A functional saved search needs a valid dataConfig. See examples on how it can be constructed for various data sources.

Returns:

  • (Array<Object>) 


68
69
70
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 68

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


96
97
98
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 96

def defined_tags
  @defined_tags
end

#description ⇒ String

[Required] Description of the saved search.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 52

def description
  @description
end

#display_name ⇒ String

[Required] Display name of the saved search.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 28

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


108
109
110
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 108

def drilldown_config
  @drilldown_config
end

#features_config ⇒ Object

Contains configuration for enabling features.

Returns:

  • (Object) 


104
105
106
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 104

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


90
91
92
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 90

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] ID of the saved search.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 24

def id
  @id
end

#is_oob_saved_search ⇒ BOOLEAN

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

Returns:

  • (BOOLEAN) 


48
49
50
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 48

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


76
77
78
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 76

def metadata_version
  @metadata_version
end

#nls ⇒ Object

[Required] JSON that contains internationalization options.

Returns:

  • (Object) 


56
57
58
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 56

def nls
  @nls
end

#parameters_config ⇒ Array<Object>

Defines parameters for the saved search.

Returns:

  • (Array<Object>) 


100
101
102
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 100

def parameters_config
  @parameters_config
end

#provider_id ⇒ String

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

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 32

def provider_id
  @provider_id
end

#provider_name ⇒ String

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

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 40

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) 


36
37
38
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 36

def provider_version
  @provider_version
end

#screen_image ⇒ String

[Required] Screen image of the saved search.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 72

def screen_image
  @screen_image
end

#type ⇒ String

[Required] Determines how the saved search is displayed in a dashboard.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 60

def type
  @type
end

#ui_config ⇒ Object

[Required] It defines the visualization type of the widget saved search, the UI options of that visualization type, the binding of data to the visualization.

Returns:

  • (Object) 


64
65
66
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 64

def ui_config
  @ui_config
end

#widget_template ⇒ String

[Required] The UI template that the saved search uses to render itself.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 80

def widget_template
  @widget_template
end

#widget_vm ⇒ String

[Required] The View Model that the saved search uses to render itself.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 84

def widget_vm
  @widget_vm
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'provider_id': :'providerId',
    'provider_version': :'providerVersion',
    'provider_name': :'providerName',
    'compartment_id': :'compartmentId',
    'is_oob_saved_search': :'isOobSavedSearch',
    'description': :'description',
    'nls': :'nls',
    'type': :'type',
    'ui_config': :'uiConfig',
    'data_config': :'dataConfig',
    'screen_image': :'screenImage',
    'metadata_version': :'metadataVersion',
    'widget_template': :'widgetTemplate',
    'widget_vm': :'widgetVM',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'parameters_config': :'parametersConfig',
    'features_config': :'featuresConfig',
    'drilldown_config': :'drilldownConfig'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'provider_id': :'String',
    'provider_version': :'String',
    'provider_name': :'String',
    'compartment_id': :'String',
    'is_oob_saved_search': :'BOOLEAN',
    'description': :'String',
    'nls': :'Object',
    'type': :'String',
    'ui_config': :'Object',
    'data_config': :'Array<Object>',
    'screen_image': :'String',
    'metadata_version': :'String',
    'widget_template': :'String',
    'widget_vm': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'parameters_config': :'Array<Object>',
    'features_config': :'Object',
    'drilldown_config': :'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



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

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    provider_id == other.provider_id &&
    provider_version == other.provider_version &&
    provider_name == other.provider_name &&
    compartment_id == other.compartment_id &&
    is_oob_saved_search == other.is_oob_saved_search &&
    description == other.description &&
    nls == other.nls &&
    type == other.type &&
    ui_config == other.ui_config &&
    data_config == other.data_config &&
    screen_image == other.screen_image &&
    metadata_version == other.metadata_version &&
    widget_template == other.widget_template &&
    widget_vm == other.widget_vm &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    parameters_config == other.parameters_config &&
    features_config == other.features_config &&
    drilldown_config == other.drilldown_config
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



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 382

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


362
363
364
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 362

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



371
372
373
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 371

def hash
  [id, display_name, provider_id, provider_version, provider_name, compartment_id, is_oob_saved_search, description, nls, type, ui_config, data_config, screen_image, metadata_version, widget_template, widget_vm, freeform_tags, defined_tags, parameters_config, features_config, drilldown_config].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



415
416
417
418
419
420
421
422
423
424
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 415

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



409
410
411
 
# File 'lib/oci/management_dashboard/models/management_saved_search_for_import_details.rb', line 409

def to_s
  to_hash.to_s
end