Class: OCI::DataSafe::Models::SecurityPolicyEntryState

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_safe/models/security_policy_entry_state.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 = {}) ⇒ SecurityPolicyEntryState

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
151
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/oci/data_safe/models/security_policy_entry_state.rb', line 113

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

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

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

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

Instance Attribute Details

#deployment_statusString

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

Returns:

  • (String)


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

def deployment_status
  @deployment_status
end

#deployment_status_detailsString

Details about the current deployment status.

Returns:

  • (String)


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

def deployment_status_details
  @deployment_status_details
end

#entry_detailsOCI::DataSafe::Models::EntryDetails



65
66
67
# File 'lib/oci/data_safe/models/security_policy_entry_state.rb', line 65

def entry_details
  @entry_details
end

#entry_typeString

[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.rb', line 54

def entry_type
  @entry_type
end

#idString

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

Returns:

  • (String)


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

def id
  @id
end

#security_policy_deployment_idString

The OCID of the security policy deployment associated.

Returns:

  • (String)


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

def security_policy_deployment_id
  @security_policy_deployment_id
end

#security_policy_entry_idString

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

Returns:

  • (String)


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

def security_policy_entry_id
  @security_policy_entry_id
end

#target_idString

[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.rb', line 46

def target_id
  @target_id
end

Class Method Details

.attribute_mapObject

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



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

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_details': :'deploymentStatusDetails',
    'deployment_status': :'deploymentStatus',
    'entry_details': :'entryDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

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_details': :'String',
    'deployment_status': :'String',
    'entry_details': :'OCI::DataSafe::Models::EntryDetails'
    # 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



197
198
199
200
201
202
203
204
205
206
207
208
209
# File 'lib/oci/data_safe/models/security_policy_entry_state.rb', line 197

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_details == other.deployment_status_details &&
    deployment_status == other.deployment_status &&
    entry_details == other.entry_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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
# File 'lib/oci/data_safe/models/security_policy_entry_state.rb', line 234

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


214
215
216
# File 'lib/oci/data_safe/models/security_policy_entry_state.rb', line 214

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



223
224
225
# File 'lib/oci/data_safe/models/security_policy_entry_state.rb', line 223

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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



267
268
269
270
271
272
273
274
275
276
# File 'lib/oci/data_safe/models/security_policy_entry_state.rb', line 267

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



261
262
263
# File 'lib/oci/data_safe/models/security_policy_entry_state.rb', line 261

def to_s
  to_hash.to_s
end