Class: OCI::CloudGuard::Models::ComplianceDocument

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

Overview

A compliance document that exists in the tenancy.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ComplianceDocument

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



117
118
119
120
121
122
123
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
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/cloud_guard/models/compliance_document.rb', line 117

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

Instance Attribute Details

#document_file_name ⇒ String

[Required] The file name of the compliance document.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/cloud_guard/models/compliance_document.rb', line 39

def document_file_name
  @document_file_name
end

#id ⇒ String

[Required] The OCID of the compliance document, which is assigned when you create the document as an Oracle Cloud Infrastructure resource and is immutable.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/cloud_guard/models/compliance_document.rb', line 20

def id
  @id
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/cloud_guard/models/compliance_document.rb', line 35

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) 


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

def name
  @name
end

#platform ⇒ String

[Required] The information technology infrastructure platform, or set of services, to which the compliance document belongs. A platform can also be described as an environment or a business pillar. For definitions of supported environments, see Types of Environments.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/cloud_guard/models/compliance_document.rb', line 54

def platform
  @platform
end

#saas_service_name ⇒ String

The saas service name to which compliance document belongs. For other types such as 'OCI' / 'PaaS' this value will be null.

Returns:

  • (String) 


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

def saas_service_name
  @saas_service_name
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


31
32
33
 
# File 'lib/oci/cloud_guard/models/compliance_document.rb', line 31

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) 


59
60
61
 
# File 'lib/oci/cloud_guard/models/compliance_document.rb', line 59

def time_updated
  @time_updated
end

#type ⇒ String

[Required] The type of compliance document. For definitions of supported types of compliance documents, see Types of Compliance Documents.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/cloud_guard/models/compliance_document.rb', line 48

def type
  @type
end

#version ⇒ Integer

[Required] The version number of the compliance document.

Returns:

  • (Integer) 


43
44
45
 
# File 'lib/oci/cloud_guard/models/compliance_document.rb', line 43

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/cloud_guard/models/compliance_document.rb', line 66

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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/cloud_guard/models/compliance_document.rb', line 179

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/oci/cloud_guard/models/compliance_document.rb', line 218

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


198
199
200
 
# File 'lib/oci/cloud_guard/models/compliance_document.rb', line 198

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



207
208
209
 
# File 'lib/oci/cloud_guard/models/compliance_document.rb', line 207

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



251
252
253
254
255
256
257
258
259
260
 
# File 'lib/oci/cloud_guard/models/compliance_document.rb', line 251

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



245
246
247
 
# File 'lib/oci/cloud_guard/models/compliance_document.rb', line 245

def to_s
  to_hash.to_s
end