Class: OCI::Identity::Models::Policy

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity/models/policy.rb

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_CREATING = 'CREATING',
LIFECYCLE_STATE_ACTIVE = 'ACTIVE',
LIFECYCLE_STATE_INACTIVE = 'INACTIVE',
LIFECYCLE_STATE_DELETING = 'DELETING',
LIFECYCLE_STATE_DELETED = 'DELETED',
LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Policy

Initializes the object

Parameters:

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

    Model attributes in the form of hash



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/identity/models/policy.rb', line 77

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}

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

  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end

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

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

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

  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end

  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end

  if attributes[:'inactiveStatus']
    self.inactive_status = attributes[:'inactiveStatus']
  end

  if attributes[:'versionDate']
    self.version_date = attributes[:'versionDate']
  end

  if attributes[:'freeformTags']
    self.freeform_tags = attributes[:'freeformTags']
  end

  if attributes[:'definedTags']
    self.defined_tags = attributes[:'definedTags']
  end

end

Instance Attribute Details

#compartment_id ⇒ String

The OCID of the compartment containing the policy (either the tenancy or another compartment).

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/identity/models/policy.rb', line 22

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: ‘{"bar-key": "foo-value"}`

Returns:

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


72
73
74
 
# File 'lib/oci/identity/models/policy.rb', line 72

def defined_tags
  @defined_tags
end

#description ⇒ String

The description you assign to the policy. Does not have to be unique, and it’s changeable.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/identity/models/policy.rb', line 36

def description
  @description
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: ‘"value"`

Returns:

  • (Hash<String, String>) 


66
67
68
 
# File 'lib/oci/identity/models/policy.rb', line 66

def freeform_tags
  @freeform_tags
end

#id ⇒ String

The OCID of the policy.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/identity/models/policy.rb', line 17

def id
  @id
end

#inactive_status ⇒ Integer

The detailed status of INACTIVE lifecycleState.

Returns:

  • (Integer) 


53
54
55
 
# File 'lib/oci/identity/models/policy.rb', line 53

def inactive_status
  @inactive_status
end

#lifecycle_state ⇒ String

The policy’s current state. After creating a policy, make sure its ‘lifecycleState` changes from CREATING to ACTIVE before using it.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/identity/models/policy.rb', line 49

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

The name you assign to the policy during creation. The name must be unique across all policies in the tenancy and cannot be changed.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/identity/models/policy.rb', line 28

def name
  @name
end

#statements ⇒ Array<String>

An array of one or more policy statements written in the policy language.

Returns:

  • (Array<String>) 


32
33
34
 
# File 'lib/oci/identity/models/policy.rb', line 32

def statements
  @statements
end

#time_created ⇒ DateTime

Date and time the policy was created, in the format defined by RFC3339.

Example: ‘2016-08-25T21:10:29.600Z`

Returns:

  • (DateTime) 


43
44
45
 
# File 'lib/oci/identity/models/policy.rb', line 43

def time_created
  @time_created
end

#version_date ⇒ DateTime

The version of the policy. If null or set to an empty string, when a request comes in for authorization, the policy will be evaluated according to the current behavior of the services at that moment. If set to a particular date (YYYY-MM-DD), the policy will be evaluated according to the behavior of the services on that date.

Returns:

  • (DateTime) 


60
61
62
 
# File 'lib/oci/identity/models/policy.rb', line 60

def version_date
  @version_date
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/identity/models/policy.rb', line 141

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      id == other_object.id &&
      compartment_id == other_object.compartment_id &&
      name == other_object.name &&
      statements == other_object.statements &&
      description == other_object.description &&
      time_created == other_object.time_created &&
      lifecycle_state == other_object.lifecycle_state &&
      inactive_status == other_object.inactive_status &&
      version_date == other_object.version_date &&
      freeform_tags == other_object.freeform_tags &&
      defined_tags == other_object.defined_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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/oci/identity/models/policy.rb', line 172

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


159
160
161
 
# File 'lib/oci/identity/models/policy.rb', line 159

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



165
166
167
 
# File 'lib/oci/identity/models/policy.rb', line 165

def hash
  [id, compartment_id, name, statements, description, time_created, lifecycle_state, inactive_status, version_date, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/identity/models/policy.rb', line 197

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



191
192
193
 
# File 'lib/oci/identity/models/policy.rb', line 191

def to_s
  to_hash.to_s
end