Class: OCI::DataSafe::Models::SecurityPolicyEntryStateSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_safe/models/security_policy_entry_state_summary.rb

Overview

The resource represents the state of a specific entry type deployment on a target.

Constant Summary collapse

ENTRY_TYPE_ENUM = 
[
  ENTRY_TYPE_FIREWALL_POLICY = 'FIREWALL_POLICY'.freeze,
  ENTRY_TYPE_AUDIT_POLICY = 'AUDIT_POLICY'.freeze,
  ENTRY_TYPE_CONFIG = 'CONFIG'.freeze,
  ENTRY_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DEPLOYMENT_STATUS_ENUM = 
[
  DEPLOYMENT_STATUS_CREATED = 'CREATED'.freeze,
  DEPLOYMENT_STATUS_MODIFIED = 'MODIFIED'.freeze,
  DEPLOYMENT_STATUS_CONFLICT = 'CONFLICT'.freeze,
  DEPLOYMENT_STATUS_CONNECTIVITY_ISSUE = 'CONNECTIVITY_ISSUE'.freeze,
  DEPLOYMENT_STATUS_UNSUPPORTED_SYNTAX = 'UNSUPPORTED_SYNTAX'.freeze,
  DEPLOYMENT_STATUS_UNKNOWN_ERROR = 'UNKNOWN_ERROR'.freeze,
  DEPLOYMENT_STATUS_UNAUTHORIZED = 'UNAUTHORIZED'.freeze,
  DEPLOYMENT_STATUS_DELETED = 'DELETED'.freeze,
  DEPLOYMENT_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SecurityPolicyEntryStateSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



107
108
109
110
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
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/data_safe/models/security_policy_entry_state_summary.rb', line 107

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

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

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

  self.security_policy_deployment_id = attributes[:'securityPolicyDeploymentId'] if attributes[:'securityPolicyDeploymentId']

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

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

  self.target_id = attributes[:'targetId'] if attributes[:'targetId']

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

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

  self.entry_type = attributes[:'entryType'] if attributes[:'entryType']

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

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

  self.deployment_status = attributes[:'deploymentStatus'] if attributes[:'deploymentStatus']

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

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

  self.deployment_status_details = attributes[:'deploymentStatusDetails'] if attributes[:'deploymentStatusDetails']

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

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

Instance Attribute Details

#deployment_status ⇒ String

[Required] The current deployment status of the security policy deployment and the security policy entry associated.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/data_safe/models/security_policy_entry_state_summary.rb', line 58

def deployment_status
  @deployment_status
end

#deployment_status_details ⇒ String

Details about the current deployment status.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/data_safe/models/security_policy_entry_state_summary.rb', line 62

def deployment_status_details
  @deployment_status_details
end

#entry_type ⇒ String

[Required] The security policy entry type. Allowed values: - FIREWALL_POLICY - The SQL Firewall policy entry type. - AUDIT_POLICY - The audit policy entry type. - CONFIG - Config changes deployment.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/data_safe/models/security_policy_entry_state_summary.rb', line 54

def entry_type
  @entry_type
end

#id ⇒ String

[Required] Unique id of the security policy entry state.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/data_safe/models/security_policy_entry_state_summary.rb', line 34

def id
  @id
end

#security_policy_deployment_id ⇒ String

The OCID of the security policy deployment associated.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/data_safe/models/security_policy_entry_state_summary.rb', line 42

def security_policy_deployment_id
  @security_policy_deployment_id
end

#security_policy_entry_id ⇒ String

[Required] The OCID of the security policy entry associated.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/data_safe/models/security_policy_entry_state_summary.rb', line 38

def security_policy_entry_id
  @security_policy_entry_id
end

#target_id ⇒ String

[Required] The OCID of the target on which the security policy is deployed.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/data_safe/models/security_policy_entry_state_summary.rb', line 46

def target_id
  @target_id
end

Class Method Details

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/data_safe/models/security_policy_entry_state_summary.rb', line 65

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'security_policy_entry_id': :'securityPolicyEntryId',
    'security_policy_deployment_id': :'securityPolicyDeploymentId',
    'target_id': :'targetId',
    'entry_type': :'entryType',
    'deployment_status': :'deploymentStatus',
    'deployment_status_details': :'deploymentStatusDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/data_safe/models/security_policy_entry_state_summary.rb', line 80

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'security_policy_entry_id': :'String',
    'security_policy_deployment_id': :'String',
    'target_id': :'String',
    'entry_type': :'String',
    'deployment_status': :'String',
    'deployment_status_details': :'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



185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/oci/data_safe/models/security_policy_entry_state_summary.rb', line 185

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

  self.class == other.class &&
    id == other.id &&
    security_policy_entry_id == other.security_policy_entry_id &&
    security_policy_deployment_id == other.security_policy_deployment_id &&
    target_id == other.target_id &&
    entry_type == other.entry_type &&
    deployment_status == other.deployment_status &&
    deployment_status_details == other.deployment_status_details
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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/oci/data_safe/models/security_policy_entry_state_summary.rb', line 221

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


201
202
203
 
# File 'lib/oci/data_safe/models/security_policy_entry_state_summary.rb', line 201

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



210
211
212
 
# File 'lib/oci/data_safe/models/security_policy_entry_state_summary.rb', line 210

def hash
  [id, security_policy_entry_id, security_policy_deployment_id, target_id, entry_type, deployment_status, deployment_status_details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



254
255
256
257
258
259
260
261
262
263
 
# File 'lib/oci/data_safe/models/security_policy_entry_state_summary.rb', line 254

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



248
249
250
 
# File 'lib/oci/data_safe/models/security_policy_entry_state_summary.rb', line 248

def to_s
  to_hash.to_s
end