Class: OCI::LogAnalytics::Models::LogAnalyticsTemplate

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/log_analytics/models/log_analytics_template.rb

Overview

A template object.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.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 = {}) ⇒ LogAnalyticsTemplate

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

  • :description (String) —

    The value to assign to the #description property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

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

  • :name (String) —

    The value to assign to the #name property

  • :type (String) —

    The value to assign to the #type property

  • :is_system (BOOLEAN) —

    The value to assign to the #is_system property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :facets (Array<OCI::LogAnalytics::Models::TemplateFacet>) —

    The value to assign to the #facets property

  • :content (String) —

    The value to assign to the #content property

  • :content_format (String) —

    The value to assign to the #content_format property

  • :parameters (String) —

    The value to assign to the #parameters property

  • :parameters_format (String) —

    The value to assign to the #parameters_format property

  • :parameters_metadata (String) —

    The value to assign to the #parameters_metadata property



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
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
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 172

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

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

  self.is_system = attributes[:'isSystem'] unless attributes[:'isSystem'].nil?

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

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

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

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

  self.content_format = attributes[:'contentFormat'] if attributes[:'contentFormat']

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

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

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

  self.parameters_format = attributes[:'parametersFormat'] if attributes[:'parametersFormat']

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

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

  self.parameters_metadata = attributes[:'parametersMetadata'] if attributes[:'parametersMetadata']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] Compartment Identifier [OCID] (docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 32

def compartment_id
  @compartment_id
end

#content ⇒ String

Base64 encoded template content.

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 81

def content
  @content
end

#content_format ⇒ String

Content format. For example - XML.

Returns:

  • (String) 


85
86
87
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 85

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


54
55
56
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 54

def defined_tags
  @defined_tags
end

#description ⇒ String

Description for this resource.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 28

def description
  @description
end

#facets ⇒ Array<OCI::LogAnalytics::Models::TemplateFacet>

Facets of the template

Returns:



77
78
79
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 77

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


48
49
50
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 48

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The log analytics entity OCID. This ID is a reference used by log analytics features and it represents a resource that is provisioned and managed by the customer on their premises or on the cloud.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 23

def id
  @id
end

#is_system ⇒ BOOLEAN

The system flag. A value of false denotes a custom, or user defined object. A value of true denotes a built in object.

Returns:

  • (BOOLEAN) 


68
69
70
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 68

def is_system
  @is_system
end

#lifecycle_state ⇒ String

[Required] The current state of the template.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 73

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] The template name.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 58

def name
  @name
end

#parameters ⇒ String

Base64 encoded template parameters.

Returns:

  • (String) 


89
90
91
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 89

def parameters
  @parameters
end

#parameters_format ⇒ String

Parameters format. For example - NAME_VALUE_PAIR.

Returns:

  • (String) 


93
94
95
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 93

def parameters_format
  @parameters_format
end

#parameters_metadata ⇒ String

Base64 encoded parameters metadata definition.

Returns:

  • (String) 


97
98
99
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 97

def parameters_metadata
  @parameters_metadata
end

#time_created ⇒ DateTime

[Required] The date and time the resource was created, in the format defined by RFC3339.

Returns:

  • (DateTime) 


37
38
39
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 37

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the resource was last updated, in the format defined by RFC3339.

Returns:

  • (DateTime) 


42
43
44
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 42

def time_updated
  @time_updated
end

#type ⇒ String

The template type.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 62

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 100

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'name': :'name',
    'type': :'type',
    'is_system': :'isSystem',
    'lifecycle_state': :'lifecycleState',
    'facets': :'facets',
    'content': :'content',
    'content_format': :'contentFormat',
    'parameters': :'parameters',
    'parameters_format': :'parametersFormat',
    'parameters_metadata': :'parametersMetadata'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 125

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'name': :'String',
    'type': :'String',
    'is_system': :'BOOLEAN',
    'lifecycle_state': :'String',
    'facets': :'Array<OCI::LogAnalytics::Models::TemplateFacet>',
    'content': :'String',
    'content_format': :'String',
    'parameters': :'String',
    'parameters_format': :'String',
    'parameters_metadata': :'String'
    # 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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 273

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

  self.class == other.class &&
    id == other.id &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    name == other.name &&
    type == other.type &&
    is_system == other.is_system &&
    lifecycle_state == other.lifecycle_state &&
    facets == other.facets &&
    content == other.content &&
    content_format == other.content_format &&
    parameters == other.parameters &&
    parameters_format == other.parameters_format &&
    parameters_metadata == other.parameters_metadata
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



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 319

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


299
300
301
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 299

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



308
309
310
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 308

def hash
  [id, description, compartment_id, time_created, time_updated, freeform_tags, defined_tags, name, type, is_system, lifecycle_state, facets, content, content_format, parameters, parameters_format, parameters_metadata].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



352
353
354
355
356
357
358
359
360
361
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 352

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



346
347
348
 
# File 'lib/oci/log_analytics/models/log_analytics_template.rb', line 346

def to_s
  to_hash.to_s
end