Class: OCI::DataIntegration::Models::TemplateSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_integration/models/template_summary.rb

Overview

The application template summary type contains the audit summary information and the definition of the application template.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.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 = {}) ⇒ TemplateSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 217

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

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

  self.model_type = attributes[:'modelType'] if attributes[:'modelType']

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

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

  self.model_version = attributes[:'modelVersion'] if attributes[:'modelVersion']

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

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

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

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

  self.application_version = attributes[:'applicationVersion'] if attributes[:'applicationVersion']

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

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

  self.object_status = attributes[:'objectStatus'] if attributes[:'objectStatus']

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

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

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

  self.parent_ref = attributes[:'parentRef'] if attributes[:'parentRef']

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

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

  self.object_version = attributes[:'objectVersion'] if attributes[:'objectVersion']

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

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

  self.dependent_object_metadata = attributes[:'dependentObjectMetadata'] if attributes[:'dependentObjectMetadata']

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

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

  self.published_object_metadata = attributes[:'publishedObjectMetadata'] if attributes[:'publishedObjectMetadata']

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

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

  self.source_application_info = attributes[:'sourceApplicationInfo'] if attributes[:'sourceApplicationInfo']

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

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

  self.time_patched = attributes[:'timePatched'] if attributes[:'timePatched']

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

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

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

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

  self.key_map = attributes[:'keyMap'] if attributes[:'keyMap']

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

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

Instance Attribute Details

#application_version ⇒ Integer

The application's version.

Returns:

  • (Integer) 


44
45
46
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 44

def application_version
  @application_version
end

#compartment_id ⇒ String

OCID of the compartment that this resource belongs to. Defaults to compartment of the Workspace.

Returns:

  • (String) 


83
84
85
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 83

def compartment_id
  @compartment_id
end

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

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


110
111
112
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 110

def defined_tags
  @defined_tags
end

#dependent_object_metadata ⇒ Array<OCI::DataIntegration::Models::PatchObjectMetadata>

A list of dependent objects in this patch.

Returns:



63
64
65
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 63

def dependent_object_metadata
  @dependent_object_metadata
end

#description ⇒ String

Detailed description for the object.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 40

def description
  @description
end

#display_name ⇒ String

Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Returns:

  • (String) 


87
88
89
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 87

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

Returns:

  • (Hash<String, String>) 


104
105
106
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 104

def freeform_tags
  @freeform_tags
end

#id ⇒ String

OCID of the resource that is used to uniquely identify the application

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 79

def id
  @id
end

#identifier ⇒ String

Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 52

def identifier
  @identifier
end

#key ⇒ String

Generated key that can be used in API calls to identify application.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 24

def key
  @key
end

#key_map ⇒ Hash<String, String>

A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key.

Returns:

  • (Hash<String, String>) 


121
122
123
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 121

def key_map
  @key_map
end

#lifecycle_state ⇒ String

The current state of the workspace.

Returns:

  • (String) 


114
115
116
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 114

def lifecycle_state
  @lifecycle_state
end

#metadata ⇒ OCI::DataIntegration::Models::ObjectMetadata

Returns:



117
118
119
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 117

def metadata
  @metadata
end

#model_type ⇒ String

The object type.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 28

def model_type
  @model_type
end

#model_version ⇒ String

The object's model version.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 32

def model_version
  @model_version
end

#name ⇒ String

Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 36

def name
  @name
end

#object_status ⇒ Integer

The status of an object that can be set to value 1 for shallow references across objects, other values reserved.

Returns:

  • (Integer) 


48
49
50
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 48

def object_status
  @object_status
end

#object_version ⇒ Integer

The version of the object that is used to track changes in the object instance.

Returns:

  • (Integer) 


59
60
61
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 59

def object_version
  @object_version
end

#parent_ref ⇒ OCI::DataIntegration::Models::ParentReference

Returns:



55
56
57
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 55

def parent_ref
  @parent_ref
end

#published_object_metadata ⇒ Hash<String, OCI::DataIntegration::Models::PatchObjectMetadata>

A list of objects that are published or unpublished in this patch.

Returns:



67
68
69
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 67

def published_object_metadata
  @published_object_metadata
end

#source_application_info ⇒ OCI::DataIntegration::Models::SourceApplicationInfo

Returns:



70
71
72
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 70

def source_application_info
  @source_application_info
end

#time_created ⇒ DateTime

The date and time the application was created, in the timestamp format defined by RFC3339.

Returns:

  • (DateTime) 


92
93
94
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 92

def time_created
  @time_created
end

#time_patched ⇒ DateTime

The date and time the application was patched, in the timestamp format defined by RFC3339.

Returns:

  • (DateTime) 


75
76
77
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 75

def time_patched
  @time_patched
end

#time_updated ⇒ DateTime

The date and time the application was updated, in the timestamp format defined by RFC3339. example: 2019-08-25T21:10:29.41Z

Returns:

  • (DateTime) 


98
99
100
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 98

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 124

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'model_type': :'modelType',
    'model_version': :'modelVersion',
    'name': :'name',
    'description': :'description',
    'application_version': :'applicationVersion',
    'object_status': :'objectStatus',
    'identifier': :'identifier',
    'parent_ref': :'parentRef',
    'object_version': :'objectVersion',
    'dependent_object_metadata': :'dependentObjectMetadata',
    'published_object_metadata': :'publishedObjectMetadata',
    'source_application_info': :'sourceApplicationInfo',
    'time_patched': :'timePatched',
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'lifecycle_state': :'lifecycleState',
    'metadata': :'metadata',
    'key_map': :'keyMap'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 156

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'model_type': :'String',
    'model_version': :'String',
    'name': :'String',
    'description': :'String',
    'application_version': :'Integer',
    'object_status': :'Integer',
    'identifier': :'String',
    'parent_ref': :'OCI::DataIntegration::Models::ParentReference',
    'object_version': :'Integer',
    'dependent_object_metadata': :'Array<OCI::DataIntegration::Models::PatchObjectMetadata>',
    'published_object_metadata': :'Hash<String, OCI::DataIntegration::Models::PatchObjectMetadata>',
    'source_application_info': :'OCI::DataIntegration::Models::SourceApplicationInfo',
    'time_patched': :'DateTime',
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'lifecycle_state': :'String',
    'metadata': :'OCI::DataIntegration::Models::ObjectMetadata',
    'key_map': :'Hash<String, 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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 361

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

  self.class == other.class &&
    key == other.key &&
    model_type == other.model_type &&
    model_version == other.model_version &&
    name == other.name &&
    description == other.description &&
    application_version == other.application_version &&
    object_status == other.object_status &&
    identifier == other.identifier &&
    parent_ref == other.parent_ref &&
    object_version == other.object_version &&
    dependent_object_metadata == other.dependent_object_metadata &&
    published_object_metadata == other.published_object_metadata &&
    source_application_info == other.source_application_info &&
    time_patched == other.time_patched &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    lifecycle_state == other.lifecycle_state &&
    metadata == other.metadata &&
    key_map == other.key_map
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



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 414

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


394
395
396
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 394

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



403
404
405
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 403

def hash
  [key, model_type, model_version, name, description, application_version, object_status, identifier, parent_ref, object_version, dependent_object_metadata, published_object_metadata, source_application_info, time_patched, id, compartment_id, display_name, time_created, time_updated, freeform_tags, defined_tags, lifecycle_state, metadata, key_map].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



447
448
449
450
451
452
453
454
455
456
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 447

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



441
442
443
 
# File 'lib/oci/data_integration/models/template_summary.rb', line 441

def to_s
  to_hash.to_s
end