Class: OCI::Identity::Models::CreatePolicyDetails

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreatePolicyDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartmentId (String) —

    The value to assign to the #compartment_id property

  • :name (String) —

    The value to assign to the #name property

  • :statements (Array<String>) —

    The value to assign to the #statements property

  • :description (String) —

    The value to assign to the #description property

  • :versionDate (DateTime) —

    The value to assign to the #version_date property

  • :freeformTags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :definedTags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property



60
61
62
63
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
 
# File 'lib/oci/identity/models/create_policy_details.rb', line 60

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[:'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[:'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

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

Returns:

  • (String) 


9
10
11
 
# File 'lib/oci/identity/models/create_policy_details.rb', line 9

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: ‘{"CostCenter": "42"}`

Returns:

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


48
49
50
 
# File 'lib/oci/identity/models/create_policy_details.rb', line 48

def defined_tags
  @defined_tags
end

#description ⇒ String

[Required] The description you assign to the policy during creation. Does not have to be unique, and it’s changeable.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/identity/models/create_policy_details.rb', line 27

def description
  @description
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm). Example: ‘"Finance"`

Returns:

  • (Hash<String, String>) 


41
42
43
 
# File 'lib/oci/identity/models/create_policy_details.rb', line 41

def freeform_tags
  @freeform_tags
end

#name ⇒ String

[Required] 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) 


15
16
17
 
# File 'lib/oci/identity/models/create_policy_details.rb', line 15

def name
  @name
end

#statements ⇒ Array<String>

[Required] An array of policy statements written in the policy language. See [How Policies Work](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/policies.htm) and [Common Policies](docs.us-phoenix-1.oraclecloud.com/Content/Identity/Concepts/commonpolicies.htm).

Returns:

  • (Array<String>) 


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

def statements
  @statements
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) 


34
35
36
 
# File 'lib/oci/identity/models/create_policy_details.rb', line 34

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



98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/identity/models/create_policy_details.rb', line 98

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      compartment_id == other_object.compartment_id &&
      name == other_object.name &&
      statements == other_object.statements &&
      description == other_object.description &&
      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



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/oci/identity/models/create_policy_details.rb', line 125

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


112
113
114
 
# File 'lib/oci/identity/models/create_policy_details.rb', line 112

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



118
119
120
 
# File 'lib/oci/identity/models/create_policy_details.rb', line 118

def hash
  [compartment_id, name, statements, description, 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



150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/identity/models/create_policy_details.rb', line 150

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



144
145
146
 
# File 'lib/oci/identity/models/create_policy_details.rb', line 144

def to_s
  to_hash.to_s
end