Class: OCI::IdentityDomains::Models::RuleReturn

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity_domains/models/rule_return.rb

Overview

The return values are the then portion of a Rule

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RuleReturn

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :value (String) —

    The value to assign to the #value property

  • :return_groovy (String) —

    The value to assign to the #return_groovy property



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/identity_domains/models/rule_return.rb', line 81

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

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

  self.return_groovy = attributes[:'returnGroovy'] if attributes[:'returnGroovy']

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

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

Instance Attribute Details

#name ⇒ String

[Required] Attribute name of an individual value to be returned.

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/identity_domains/models/rule_return.rb', line 22

def name
  @name
end

#return_groovy ⇒ String

The Groovy script that is run to generate output for the rule, if the policy type allows the return value to be a Groovy script.

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/identity_domains/models/rule_return.rb', line 48

def return_groovy
  @return_groovy
end

#value ⇒ String

[Required] Attribute value of some attribute to be returned.

SCIM++ Properties: - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/identity_domains/models/rule_return.rb', line 35

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
 
# File 'lib/oci/identity_domains/models/rule_return.rb', line 51

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'value': :'value',
    'return_groovy': :'returnGroovy'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
 
# File 'lib/oci/identity_domains/models/rule_return.rb', line 62

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'value': :'String',
    'return_groovy': :'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



105
106
107
108
109
110
111
112
 
# File 'lib/oci/identity_domains/models/rule_return.rb', line 105

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

  self.class == other.class &&
    name == other.name &&
    value == other.value &&
    return_groovy == other.return_groovy
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



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/identity_domains/models/rule_return.rb', line 137

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


117
118
119
 
# File 'lib/oci/identity_domains/models/rule_return.rb', line 117

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



126
127
128
 
# File 'lib/oci/identity_domains/models/rule_return.rb', line 126

def hash
  [name, value, return_groovy].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



170
171
172
173
174
175
176
177
178
179
 
# File 'lib/oci/identity_domains/models/rule_return.rb', line 170

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



164
165
166
 
# File 'lib/oci/identity_domains/models/rule_return.rb', line 164

def to_s
  to_hash.to_s
end