Class: OracleBMC::Identity::Models::Policy

Inherits:
Object
  • Object
show all
Defined in:
lib/oraclebmc/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']

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



64
65
66
67
68
69
70
71
72
73
74
75
76
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
 
# File 'lib/oraclebmc/identity/models/policy.rb', line 64

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
  
end

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


21
22
23
 
# File 'lib/oraclebmc/identity/models/policy.rb', line 21

def compartment_id
  @compartment_id
end

#description ⇒ String

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

Returns:

  • (String) 


35
36
37
 
# File 'lib/oraclebmc/identity/models/policy.rb', line 35

def description
  @description
end

#id ⇒ String

The OCID of the policy.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oraclebmc/identity/models/policy.rb', line 16

def id
  @id
end

#inactive_status ⇒ Integer

The detailed status of INACTIVE lifecycleState.

Returns:

  • (Integer) 


52
53
54
 
# File 'lib/oraclebmc/identity/models/policy.rb', line 52

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) 


48
49
50
 
# File 'lib/oraclebmc/identity/models/policy.rb', line 48

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) 


27
28
29
 
# File 'lib/oraclebmc/identity/models/policy.rb', line 27

def name
  @name
end

#statements ⇒ Array<String>

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

Returns:

  • (Array<String>) 


31
32
33
 
# File 'lib/oraclebmc/identity/models/policy.rb', line 31

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) 


42
43
44
 
# File 'lib/oraclebmc/identity/models/policy.rb', line 42

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) 


59
60
61
 
# File 'lib/oraclebmc/identity/models/policy.rb', line 59

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



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/oraclebmc/identity/models/policy.rb', line 120

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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/oraclebmc/identity/models/policy.rb', line 149

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.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(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


136
137
138
 
# File 'lib/oraclebmc/identity/models/policy.rb', line 136

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



142
143
144
 
# File 'lib/oraclebmc/identity/models/policy.rb', line 142

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



174
175
176
177
178
179
180
181
182
 
# File 'lib/oraclebmc/identity/models/policy.rb', line 174

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



168
169
170
 
# File 'lib/oraclebmc/identity/models/policy.rb', line 168

def to_s
  to_hash.to_s
end