Class: Akeyless::Configure
- Inherits:
-
Object
- Object
- Akeyless::Configure
- Defined in:
- lib/akeyless/models/configure.rb
Instance Attribute Summary collapse
-
#access_id ⇒ Object
Access ID.
-
#access_key ⇒ Object
Access Key.
-
#access_type ⇒ Object
Access Type (access_key/password/azure_ad/saml/oidc/aws_iam/gcp/k8s/cert).
-
#account_id ⇒ Object
Account id (relevant only for access-type=password where the email address is associated with more than one account).
-
#admin_email ⇒ Object
Email (relevant only for access-type=password).
-
#admin_password ⇒ Object
Password (relevant only for access-type=password).
-
#azure_ad_object_id ⇒ Object
Azure Active Directory ObjectId (relevant only for access-type=azure_ad).
-
#cert_data ⇒ Object
Certificate data encoded in base64.
-
#gcp_audience ⇒ Object
GCP JWT audience.
-
#json ⇒ Object
Set output format to JSON.
-
#k8s_auth_config_name ⇒ Object
The K8S Auth config name (relevant only for access-type=k8s).
-
#key_data ⇒ Object
Private key data encoded in base64.
-
#oci_auth_type ⇒ Object
The type of the OCI configuration to use [instance/apikey/resource] (relevant only for access-type=oci).
-
#oci_group_ocid ⇒ Object
A list of Oracle Cloud IDs groups (relevant only for access-type=oci).
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Configure
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Configure
Initializes the object
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 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 |
# File 'lib/akeyless/models/configure.rb', line 113 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Akeyless::Configure` 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 `Akeyless::Configure`. 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?(:'access_id') self.access_id = attributes[:'access_id'] end if attributes.key?(:'access_key') self.access_key = attributes[:'access_key'] end if attributes.key?(:'access_type') self.access_type = attributes[:'access_type'] else self.access_type = 'access_key' end if attributes.key?(:'account_id') self.account_id = attributes[:'account_id'] end if attributes.key?(:'admin_email') self.admin_email = attributes[:'admin_email'] end if attributes.key?(:'admin_password') self.admin_password = attributes[:'admin_password'] end if attributes.key?(:'azure_ad_object_id') self.azure_ad_object_id = attributes[:'azure_ad_object_id'] end if attributes.key?(:'cert_data') self.cert_data = attributes[:'cert_data'] end if attributes.key?(:'gcp_audience') self.gcp_audience = attributes[:'gcp_audience'] else self.gcp_audience = 'akeyless.io' end if attributes.key?(:'json') self.json = attributes[:'json'] else self.json = false end if attributes.key?(:'k8s_auth_config_name') self.k8s_auth_config_name = attributes[:'k8s_auth_config_name'] end if attributes.key?(:'key_data') self.key_data = attributes[:'key_data'] end if attributes.key?(:'oci_auth_type') self.oci_auth_type = attributes[:'oci_auth_type'] else self.oci_auth_type = 'apikey' end if attributes.key?(:'oci_group_ocid') if (value = attributes[:'oci_group_ocid']).is_a?(Array) self.oci_group_ocid = value end end end |
Instance Attribute Details
#access_id ⇒ Object
Access ID
19 20 21 |
# File 'lib/akeyless/models/configure.rb', line 19 def access_id @access_id end |
#access_key ⇒ Object
Access Key
22 23 24 |
# File 'lib/akeyless/models/configure.rb', line 22 def access_key @access_key end |
#access_type ⇒ Object
Access Type (access_key/password/azure_ad/saml/oidc/aws_iam/gcp/k8s/cert)
25 26 27 |
# File 'lib/akeyless/models/configure.rb', line 25 def access_type @access_type end |
#account_id ⇒ Object
Account id (relevant only for access-type=password where the email address is associated with more than one account)
28 29 30 |
# File 'lib/akeyless/models/configure.rb', line 28 def account_id @account_id end |
#admin_email ⇒ Object
Email (relevant only for access-type=password)
31 32 33 |
# File 'lib/akeyless/models/configure.rb', line 31 def admin_email @admin_email end |
#admin_password ⇒ Object
Password (relevant only for access-type=password)
34 35 36 |
# File 'lib/akeyless/models/configure.rb', line 34 def admin_password @admin_password end |
#azure_ad_object_id ⇒ Object
Azure Active Directory ObjectId (relevant only for access-type=azure_ad)
37 38 39 |
# File 'lib/akeyless/models/configure.rb', line 37 def azure_ad_object_id @azure_ad_object_id end |
#cert_data ⇒ Object
Certificate data encoded in base64. Used if file was not provided. (relevant only for access-type=cert in Curl Context)
40 41 42 |
# File 'lib/akeyless/models/configure.rb', line 40 def cert_data @cert_data end |
#gcp_audience ⇒ Object
GCP JWT audience
43 44 45 |
# File 'lib/akeyless/models/configure.rb', line 43 def gcp_audience @gcp_audience end |
#json ⇒ Object
Set output format to JSON
46 47 48 |
# File 'lib/akeyless/models/configure.rb', line 46 def json @json end |
#k8s_auth_config_name ⇒ Object
The K8S Auth config name (relevant only for access-type=k8s)
49 50 51 |
# File 'lib/akeyless/models/configure.rb', line 49 def k8s_auth_config_name @k8s_auth_config_name end |
#key_data ⇒ Object
Private key data encoded in base64. Used if file was not provided.(relevant only for access-type=cert in Curl Context)
52 53 54 |
# File 'lib/akeyless/models/configure.rb', line 52 def key_data @key_data end |
#oci_auth_type ⇒ Object
The type of the OCI configuration to use [instance/apikey/resource] (relevant only for access-type=oci)
55 56 57 |
# File 'lib/akeyless/models/configure.rb', line 55 def oci_auth_type @oci_auth_type end |
#oci_group_ocid ⇒ Object
A list of Oracle Cloud IDs groups (relevant only for access-type=oci)
58 59 60 |
# File 'lib/akeyless/models/configure.rb', line 58 def oci_group_ocid @oci_group_ocid end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 |
# File 'lib/akeyless/models/configure.rb', line 268 def self._deserialize(type, value) case type.to_sym when :Time Time.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 # models (e.g. Pet) or oneOf klass = Akeyless.const_get(type) klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end |
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
81 82 83 |
# File 'lib/akeyless/models/configure.rb', line 81 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/akeyless/models/configure.rb', line 61 def self.attribute_map { :'access_id' => :'access-id', :'access_key' => :'access-key', :'access_type' => :'access-type', :'account_id' => :'account-id', :'admin_email' => :'admin-email', :'admin_password' => :'admin-password', :'azure_ad_object_id' => :'azure_ad_object_id', :'cert_data' => :'cert-data', :'gcp_audience' => :'gcp-audience', :'json' => :'json', :'k8s_auth_config_name' => :'k8s-auth-config-name', :'key_data' => :'key-data', :'oci_auth_type' => :'oci-auth-type', :'oci_group_ocid' => :'oci-group-ocid' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 |
# File 'lib/akeyless/models/configure.rb', line 244 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
106 107 108 109 |
# File 'lib/akeyless/models/configure.rb', line 106 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
# File 'lib/akeyless/models/configure.rb', line 86 def self.openapi_types { :'access_id' => :'String', :'access_key' => :'String', :'access_type' => :'String', :'account_id' => :'String', :'admin_email' => :'String', :'admin_password' => :'String', :'azure_ad_object_id' => :'String', :'cert_data' => :'String', :'gcp_audience' => :'String', :'json' => :'Boolean', :'k8s_auth_config_name' => :'String', :'key_data' => :'String', :'oci_auth_type' => :'String', :'oci_group_ocid' => :'Array<String>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 |
# File 'lib/akeyless/models/configure.rb', line 210 def ==(o) return true if self.equal?(o) self.class == o.class && access_id == o.access_id && access_key == o.access_key && access_type == o.access_type && account_id == o.account_id && admin_email == o.admin_email && admin_password == o.admin_password && azure_ad_object_id == o.azure_ad_object_id && cert_data == o.cert_data && gcp_audience == o.gcp_audience && json == o.json && k8s_auth_config_name == o.k8s_auth_config_name && key_data == o.key_data && oci_auth_type == o.oci_auth_type && oci_group_ocid == o.oci_group_ocid end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
339 340 341 342 343 344 345 346 347 348 349 350 351 |
# File 'lib/akeyless/models/configure.rb', line 339 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 |
#eql?(o) ⇒ Boolean
231 232 233 |
# File 'lib/akeyless/models/configure.rb', line 231 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
237 238 239 |
# File 'lib/akeyless/models/configure.rb', line 237 def hash [access_id, access_key, access_type, account_id, admin_email, admin_password, azure_ad_object_id, cert_data, gcp_audience, json, k8s_auth_config_name, key_data, oci_auth_type, oci_group_ocid].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
195 196 197 198 199 |
# File 'lib/akeyless/models/configure.rb', line 195 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
315 316 317 |
# File 'lib/akeyless/models/configure.rb', line 315 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
321 322 323 324 325 326 327 328 329 330 331 332 333 |
# File 'lib/akeyless/models/configure.rb', line 321 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 |
#to_s ⇒ String
Returns the string representation of the object
309 310 311 |
# File 'lib/akeyless/models/configure.rb', line 309 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
203 204 205 206 |
# File 'lib/akeyless/models/configure.rb', line 203 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' true end |