Class: IbmCloudIam::CreateApiKeyRequest

Inherits:
ApiModelBase show all
Defined in:
lib/ibm_cloud_iam/models/create_api_key_request.rb

Overview

Input body parameters for the Create API key V1 REST request.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ CreateApiKeyRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/ibm_cloud_iam/models/create_api_key_request.rb', line 94

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
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_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: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'iam_id')
    self.iam_id = attributes[:'iam_id']
  else
    self.iam_id = nil
  end

  if attributes.key?(:'account_id')
    self. = 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

  if attributes.key?(:'support_sessions')
    self.support_sessions = attributes[:'support_sessions']
  end

  if attributes.key?(:'action_when_leaked')
    self.action_when_leaked = attributes[:'action_when_leaked']
  end

  if attributes.key?(:'expires_at')
    self.expires_at = attributes[:'expires_at']
  end
end

Instance Attribute Details

#account_id ⇒ Object

The account ID of the API key.



29
30
31
 
# File 'lib/ibm_cloud_iam/models/create_api_key_request.rb', line 29

def 
  @account_id
end

#action_when_leaked ⇒ Object

Defines the action to take when API key is leaked, valid values are 'none', 'disable' and 'delete'.



41
42
43
 
# File 'lib/ibm_cloud_iam/models/create_api_key_request.rb', line 41

def action_when_leaked
  @action_when_leaked
end

#apikey ⇒ Object

You can optionally passthrough the API key value for this API key. If passed, a minimum length validation of 32 characters for that apiKey value is done, i.e. the value can contain any characters and can even be non-URL safe, but the minimum length requirement must be met. 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. Ensure enough variations when passing in this value.



32
33
34
 
# File 'lib/ibm_cloud_iam/models/create_api_key_request.rb', line 32

def apikey
  @apikey
end

#description ⇒ Object

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.



23
24
25
 
# File 'lib/ibm_cloud_iam/models/create_api_key_request.rb', line 23

def description
  @description
end

#expires_at ⇒ Object

Date and time when the API key becomes invalid, ISO 8601 datetime in the format 'yyyy-MM-ddTHH:mm+0000'. WARNING An API key will be permanently and irrevocably deleted when both the expires_at and modified_at timestamps are more than ninety (90) days in the past, regardless of the key’s locked status or any other state.



44
45
46
 
# File 'lib/ibm_cloud_iam/models/create_api_key_request.rb', line 44

def expires_at
  @expires_at
end

#iam_id ⇒ Object

The iam_id that this API key authenticates.



26
27
28
 
# File 'lib/ibm_cloud_iam/models/create_api_key_request.rb', line 26

def iam_id
  @iam_id
end

#name ⇒ Object

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.



20
21
22
 
# File 'lib/ibm_cloud_iam/models/create_api_key_request.rb', line 20

def name
  @name
end

#store_value ⇒ Object

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.



35
36
37
 
# File 'lib/ibm_cloud_iam/models/create_api_key_request.rb', line 35

def store_value
  @store_value
end

#support_sessions ⇒ Object

Defines whether you can manage CLI login sessions for the API key. When true, sessions are created and can be reviewed or revoked. When false, no sessions are tracked. To block access, delete or rotate the API key. Available only for user API keys.



38
39
40
 
# File 'lib/ibm_cloud_iam/models/create_api_key_request.rb', line 38

def support_sessions
  @support_sessions
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



62
63
64
 
# File 'lib/ibm_cloud_iam/models/create_api_key_request.rb', line 62

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



67
68
69
 
# File 'lib/ibm_cloud_iam/models/create_api_key_request.rb', line 67

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/ibm_cloud_iam/models/create_api_key_request.rb', line 47

def self.attribute_map
  {
    :'name' => :'name',
    :'description' => :'description',
    :'iam_id' => :'iam_id',
    :'account_id' => :'account_id',
    :'apikey' => :'apikey',
    :'store_value' => :'store_value',
    :'support_sessions' => :'support_sessions',
    :'action_when_leaked' => :'action_when_leaked',
    :'expires_at' => :'expires_at'
  }
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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/ibm_cloud_iam/models/create_api_key_request.rb', line 225

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



87
88
89
90
 
# File 'lib/ibm_cloud_iam/models/create_api_key_request.rb', line 87

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/ibm_cloud_iam/models/create_api_key_request.rb', line 72

def self.openapi_types
  {
    :'name' => :'String',
    :'description' => :'String',
    :'iam_id' => :'String',
    :'account_id' => :'String',
    :'apikey' => :'String',
    :'store_value' => :'Boolean',
    :'support_sessions' => :'Boolean',
    :'action_when_leaked' => :'String',
    :'expires_at' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/ibm_cloud_iam/models/create_api_key_request.rb', line 196

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      iam_id == o.iam_id &&
       == o. &&
      apikey == o.apikey &&
      store_value == o.store_value &&
      support_sessions == o.support_sessions &&
      action_when_leaked == o.action_when_leaked &&
      expires_at == o.expires_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


212
213
214
 
# File 'lib/ibm_cloud_iam/models/create_api_key_request.rb', line 212

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



218
219
220
 
# File 'lib/ibm_cloud_iam/models/create_api_key_request.rb', line 218

def hash
  [name, description, iam_id, , apikey, store_value, support_sessions, action_when_leaked, expires_at].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/ibm_cloud_iam/models/create_api_key_request.rb', line 151

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/ibm_cloud_iam/models/create_api_key_request.rb', line 247

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



167
168
169
170
171
172
 
# File 'lib/ibm_cloud_iam/models/create_api_key_request.rb', line 167

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @iam_id.nil?
  true
end