class IbmCloudIam::CreateApiKeyRequest
Input body parameters for the Create API key V1 REST request.
Attributes
The account ID of the API key.
You can optionally passthrough the API key value for this API key. If passed, NO validation of that apiKey value is done, i.e. the value can be non-URL safe. If omitted, the API key management will create an URL safe opaque API key value. The value of the API key is checked for uniqueness. Please ensure enough variations when passing in this value.
The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.
The iam_id
that this API key authenticates.
Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.
Send true or false to set whether the API key value is retrievable in the future by using the Get details of an API key request. If you create an API key for a user, you must specify `false` or omit the value. We don't allow storing of API keys for users.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/ibm_cloud_iam/models/create_api_key_request.rb, line 37 def self.attribute_map { :'name' => :'name', :'description' => :'description', :'iam_id' => :'iam_id', :'account_id' => :'account_id', :'apikey' => :'apikey', :'store_value' => :'store_value' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/ibm_cloud_iam/models/create_api_key_request.rb, line 157 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/ibm_cloud_iam/models/create_api_key_request.rb, line 68 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `IbmCloudIam::CreateApiKeyRequest` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `IbmCloudIam::CreateApiKeyRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'iam_id') self.iam_id = attributes[:'iam_id'] end if attributes.key?(:'account_id') self.account_id = attributes[:'account_id'] end if attributes.key?(:'apikey') self.apikey = attributes[:'apikey'] end if attributes.key?(:'store_value') self.store_value = attributes[:'store_value'] end end
List of attributes with nullable: true
# File lib/ibm_cloud_iam/models/create_api_key_request.rb, line 61 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/ibm_cloud_iam/models/create_api_key_request.rb, line 49 def self.openapi_types { :'name' => :'String', :'description' => :'String', :'iam_id' => :'String', :'account_id' => :'String', :'apikey' => :'String', :'store_value' => :'Boolean' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/ibm_cloud_iam/models/create_api_key_request.rb, line 131 def ==(o) return true if self.equal?(o) self.class == o.class && name == o.name && description == o.description && iam_id == o.iam_id && account_id == o.account_id && apikey == o.apikey && store_value == o.store_value end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/ibm_cloud_iam/models/create_api_key_request.rb, line 187 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model IbmCloudIam.const_get(type).build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/ibm_cloud_iam/models/create_api_key_request.rb, line 256 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/ibm_cloud_iam/models/create_api_key_request.rb, line 164 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that 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]])) elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) end end self end
@see the `==` method @param [Object] Object to be compared
# File lib/ibm_cloud_iam/models/create_api_key_request.rb, line 144 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/ibm_cloud_iam/models/create_api_key_request.rb, line 150 def hash [name, description, iam_id, account_id, apikey, store_value].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/ibm_cloud_iam/models/create_api_key_request.rb, line 108 def list_invalid_properties invalid_properties = Array.new if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @iam_id.nil? invalid_properties.push('invalid value for "iam_id", iam_id cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/ibm_cloud_iam/models/create_api_key_request.rb, line 238 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/ibm_cloud_iam/models/create_api_key_request.rb, line 226 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/ibm_cloud_iam/models/create_api_key_request.rb, line 123 def valid? return false if @name.nil? return false if @iam_id.nil? true end