Class: OCI::Identity::Models::CreateUserDetails

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateUserDetails

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

  • :description (String) —

    The value to assign to the #description 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



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/identity/models/create_user_details.rb', line 43

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[:'description']
    self.description = attributes[:'description']
  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 tenancy containing the user.

Returns:

  • (String) 


9
10
11
 
# File 'lib/oci/identity/models/create_user_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>>) 


33
34
35
 
# File 'lib/oci/identity/models/create_user_details.rb', line 33

def defined_tags
  @defined_tags
end

#description ⇒ String

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

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/identity/models/create_user_details.rb', line 19

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


26
27
28
 
# File 'lib/oci/identity/models/create_user_details.rb', line 26

def freeform_tags
  @freeform_tags
end

#name ⇒ String

[Required] The name you assign to the user during creation. This is the user’s login for the Console. The name must be unique across all users in the tenancy and cannot be changed.

Returns:

  • (String) 


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

def name
  @name
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/identity/models/create_user_details.rb', line 73

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 &&
      description == other_object.description &&
      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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/identity/models/create_user_details.rb', line 98

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


85
86
87
 
# File 'lib/oci/identity/models/create_user_details.rb', line 85

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



91
92
93
 
# File 'lib/oci/identity/models/create_user_details.rb', line 91

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



123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/identity/models/create_user_details.rb', line 123

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



117
118
119
 
# File 'lib/oci/identity/models/create_user_details.rb', line 117

def to_s
  to_hash.to_s
end