Class: OCI::CloudGuard::Models::ComplianceDocumentSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/cloud_guard/models/compliance_document_summary.rb

Overview

A summary representation of the compliance document.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ComplianceDocumentSummary

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

  • :name (String) —

    The value to assign to the #name property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :document_file_name (String) —

    The value to assign to the #document_file_name property

  • :version (Integer) —

    The value to assign to the #version property

  • :type (String) —

    The value to assign to the #type property

  • :platform (String) —

    The value to assign to the #platform property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :saas_service_name (String) —

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

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



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
168
169
170
171
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
 
# File 'lib/oci/cloud_guard/models/compliance_document_summary.rb', line 141

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

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


69
70
71
 
# File 'lib/oci/cloud_guard/models/compliance_document_summary.rb', line 69

def defined_tags
  @defined_tags
end

#document_file_name ⇒ String

[Required] The file name of the compliance document.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/cloud_guard/models/compliance_document_summary.rb', line 34

def document_file_name
  @document_file_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\"}

Avoid entering confidential information.

Returns:

  • (Hash<String, String>) 


63
64
65
 
# File 'lib/oci/cloud_guard/models/compliance_document_summary.rb', line 63

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] A unique identifier for the document that is assigned when you create the document as an Oracle Cloud Infrastructure resource and is immutable.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/cloud_guard/models/compliance_document_summary.rb', line 15

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current lifecycle state of the compliance document.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/cloud_guard/models/compliance_document_summary.rb', line 30

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] A friendly name or title for the compliance document. You cannot update this value later. Avoid entering confidential information.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/cloud_guard/models/compliance_document_summary.rb', line 21

def name
  @name
end

#platform ⇒ String

[Required] The environment, also known as platform or business pillar, to which the compliance document belongs.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/cloud_guard/models/compliance_document_summary.rb', line 46

def platform
  @platform
end

#saas_service_name ⇒ String

The saas service name to which compliance document belongs.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/cloud_guard/models/compliance_document_summary.rb', line 55

def saas_service_name
  @saas_service_name
end

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

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


78
79
80
 
# File 'lib/oci/cloud_guard/models/compliance_document_summary.rb', line 78

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The date and time the compliance document was created, expressed in RFC 3339 timestamp format.

Returns:

  • (DateTime) 


26
27
28
 
# File 'lib/oci/cloud_guard/models/compliance_document_summary.rb', line 26

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The date and time the compliance document was last updated, expressed in RFC 3339 timestamp format.

Returns:

  • (DateTime) 


51
52
53
 
# File 'lib/oci/cloud_guard/models/compliance_document_summary.rb', line 51

def time_updated
  @time_updated
end

#type ⇒ String

[Required] The type of compliance document.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/cloud_guard/models/compliance_document_summary.rb', line 42

def type
  @type
end

#version ⇒ Integer

[Required] The version number of the compliance document.

Returns:

  • (Integer) 


38
39
40
 
# File 'lib/oci/cloud_guard/models/compliance_document_summary.rb', line 38

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/cloud_guard/models/compliance_document_summary.rb', line 81

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'time_created': :'timeCreated',
    'lifecycle_state': :'lifecycleState',
    'document_file_name': :'documentFileName',
    'version': :'version',
    'type': :'type',
    'platform': :'platform',
    'time_updated': :'timeUpdated',
    'saas_service_name': :'saasServiceName',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/oci/cloud_guard/models/compliance_document_summary.rb', line 102

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'time_created': :'DateTime',
    'lifecycle_state': :'String',
    'document_file_name': :'String',
    'version': :'Integer',
    'type': :'String',
    'platform': :'String',
    'time_updated': :'DateTime',
    'saas_service_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/oci/cloud_guard/models/compliance_document_summary.rb', line 213

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    time_created == other.time_created &&
    lifecycle_state == other.lifecycle_state &&
    document_file_name == other.document_file_name &&
    version == other.version &&
    type == other.type &&
    platform == other.platform &&
    time_updated == other.time_updated &&
    saas_service_name == other.saas_service_name &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/oci/cloud_guard/models/compliance_document_summary.rb', line 255

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


235
236
237
 
# File 'lib/oci/cloud_guard/models/compliance_document_summary.rb', line 235

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



244
245
246
 
# File 'lib/oci/cloud_guard/models/compliance_document_summary.rb', line 244

def hash
  [id, name, time_created, lifecycle_state, document_file_name, version, type, platform, time_updated, saas_service_name, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



288
289
290
291
292
293
294
295
296
297
 
# File 'lib/oci/cloud_guard/models/compliance_document_summary.rb', line 288

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



282
283
284
 
# File 'lib/oci/cloud_guard/models/compliance_document_summary.rb', line 282

def to_s
  to_hash.to_s
end