Class: Akeyless::EventForwarderCreateEmail
- Inherits:
-
Object
- Object
- Akeyless::EventForwarderCreateEmail
- Defined in:
- lib/akeyless/models/event_forwarder_create_email.rb
Overview
eventForwarderCreateEmail is a command that creates email event forwarder
Instance Attribute Summary collapse
-
#auth_methods_event_source_locations ⇒ Object
Auth Method Event sources.
-
#description ⇒ Object
Description of the object.
-
#email_to ⇒ Object
A comma seperated list of email addresses to send event to.
-
#event_types ⇒ Object
List of event types to notify about [request-access, certificate-pending-expiration, certificate-expired, certificate-provisioning-success, certificate-provisioning-failure, auth-method-pending-expiration, auth-method-expired, rotated-secret-success, rotated-secret-failure, dynamic-secret-failure, multi-auth-failure, uid-rotation-failure, apply-justification, email-auth-method-approved, usage, rotation-usage, gateway-inactive, static-secret-updated].
-
#every ⇒ Object
Rate of periodic runner repetition in hours.
-
#gateways_event_source_locations ⇒ Object
Event sources.
-
#items_event_source_locations ⇒ Object
Items Event sources.
-
#json ⇒ Object
Set output format to JSON.
-
#key ⇒ Object
The name of a key that used to encrypt the EventForwarder secret value (if empty, the account default protectionKey key will be used).
-
#name ⇒ Object
EventForwarder name.
-
#override_url ⇒ Object
Override Akeyless default URL with your Gateway url (port 18888).
-
#runner_type ⇒ Object
Returns the value of attribute runner_type.
-
#targets_event_source_locations ⇒ Object
Targets Event sources.
-
#token ⇒ Object
Authentication token (see ‘/auth` and `/configure`).
-
#uid_token ⇒ Object
The universal identity token, Required only for universal_identity authentication.
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 = {}) ⇒ EventForwarderCreateEmail
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 = {}) ⇒ EventForwarderCreateEmail
Initializes the object
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 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 118 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Akeyless::EventForwarderCreateEmail` 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::EventForwarderCreateEmail`. 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?(:'auth_methods_event_source_locations') if (value = attributes[:'auth_methods_event_source_locations']).is_a?(Array) self.auth_methods_event_source_locations = value end end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'email_to') self.email_to = attributes[:'email_to'] end if attributes.key?(:'event_types') if (value = attributes[:'event_types']).is_a?(Array) self.event_types = value end end if attributes.key?(:'every') self.every = attributes[:'every'] end if attributes.key?(:'gateways_event_source_locations') if (value = attributes[:'gateways_event_source_locations']).is_a?(Array) self.gateways_event_source_locations = value end else self.gateways_event_source_locations = nil end if attributes.key?(:'items_event_source_locations') if (value = attributes[:'items_event_source_locations']).is_a?(Array) self.items_event_source_locations = value end end if attributes.key?(:'json') self.json = attributes[:'json'] else self.json = false end if attributes.key?(:'key') self.key = attributes[:'key'] end if attributes.key?(:'name') self.name = attributes[:'name'] else self.name = nil end if attributes.key?(:'override_url') self.override_url = attributes[:'override_url'] end if attributes.key?(:'runner_type') self.runner_type = attributes[:'runner_type'] else self.runner_type = nil end if attributes.key?(:'targets_event_source_locations') if (value = attributes[:'targets_event_source_locations']).is_a?(Array) self.targets_event_source_locations = value end end if attributes.key?(:'token') self.token = attributes[:'token'] end if attributes.key?(:'uid_token') self.uid_token = attributes[:'uid_token'] end end |
Instance Attribute Details
#auth_methods_event_source_locations ⇒ Object
Auth Method Event sources
20 21 22 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 20 def auth_methods_event_source_locations @auth_methods_event_source_locations end |
#description ⇒ Object
Description of the object
23 24 25 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 23 def description @description end |
#email_to ⇒ Object
A comma seperated list of email addresses to send event to
26 27 28 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 26 def email_to @email_to end |
#event_types ⇒ Object
List of event types to notify about [request-access, certificate-pending-expiration, certificate-expired, certificate-provisioning-success, certificate-provisioning-failure, auth-method-pending-expiration, auth-method-expired, rotated-secret-success, rotated-secret-failure, dynamic-secret-failure, multi-auth-failure, uid-rotation-failure, apply-justification, email-auth-method-approved, usage, rotation-usage, gateway-inactive, static-secret-updated]
29 30 31 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 29 def event_types @event_types end |
#every ⇒ Object
Rate of periodic runner repetition in hours
32 33 34 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 32 def every @every end |
#gateways_event_source_locations ⇒ Object
Event sources
35 36 37 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 35 def gateways_event_source_locations @gateways_event_source_locations end |
#items_event_source_locations ⇒ Object
Items Event sources
38 39 40 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 38 def items_event_source_locations @items_event_source_locations end |
#json ⇒ Object
Set output format to JSON
41 42 43 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 41 def json @json end |
#key ⇒ Object
The name of a key that used to encrypt the EventForwarder secret value (if empty, the account default protectionKey key will be used)
44 45 46 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 44 def key @key end |
#name ⇒ Object
EventForwarder name
47 48 49 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 47 def name @name end |
#override_url ⇒ Object
Override Akeyless default URL with your Gateway url (port 18888)
50 51 52 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 50 def override_url @override_url end |
#runner_type ⇒ Object
Returns the value of attribute runner_type.
52 53 54 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 52 def runner_type @runner_type end |
#targets_event_source_locations ⇒ Object
Targets Event sources
55 56 57 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 55 def targets_event_source_locations @targets_event_source_locations end |
#token ⇒ Object
Authentication token (see ‘/auth` and `/configure`)
58 59 60 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 58 def token @token end |
#uid_token ⇒ Object
The universal identity token, Required only for universal_identity authentication
61 62 63 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 61 def uid_token @uid_token end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 301 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
85 86 87 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 85 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 64 def self.attribute_map { :'auth_methods_event_source_locations' => :'auth-methods-event-source-locations', :'description' => :'description', :'email_to' => :'email-to', :'event_types' => :'event-types', :'every' => :'every', :'gateways_event_source_locations' => :'gateways-event-source-locations', :'items_event_source_locations' => :'items-event-source-locations', :'json' => :'json', :'key' => :'key', :'name' => :'name', :'override_url' => :'override-url', :'runner_type' => :'runner-type', :'targets_event_source_locations' => :'targets-event-source-locations', :'token' => :'token', :'uid_token' => :'uid-token' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 277 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
111 112 113 114 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 111 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 90 def self.openapi_types { :'auth_methods_event_source_locations' => :'Array<String>', :'description' => :'String', :'email_to' => :'String', :'event_types' => :'Array<String>', :'every' => :'String', :'gateways_event_source_locations' => :'Array<String>', :'items_event_source_locations' => :'Array<String>', :'json' => :'Boolean', :'key' => :'String', :'name' => :'String', :'override_url' => :'String', :'runner_type' => :'String', :'targets_event_source_locations' => :'Array<String>', :'token' => :'String', :'uid_token' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 242 def ==(o) return true if self.equal?(o) self.class == o.class && auth_methods_event_source_locations == o.auth_methods_event_source_locations && description == o.description && email_to == o.email_to && event_types == o.event_types && every == o.every && gateways_event_source_locations == o.gateways_event_source_locations && items_event_source_locations == o.items_event_source_locations && json == o.json && key == o.key && name == o.name && override_url == o.override_url && runner_type == o.runner_type && targets_event_source_locations == o.targets_event_source_locations && token == o.token && uid_token == o.uid_token end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
372 373 374 375 376 377 378 379 380 381 382 383 384 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 372 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
264 265 266 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 264 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
270 271 272 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 270 def hash [auth_methods_event_source_locations, description, email_to, event_types, every, gateways_event_source_locations, items_event_source_locations, json, key, name, override_url, runner_type, targets_event_source_locations, token, uid_token].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 212 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new if @gateways_event_source_locations.nil? invalid_properties.push('invalid value for "gateways_event_source_locations", gateways_event_source_locations cannot be nil.') end if @name.nil? invalid_properties.push('invalid value for "name", name cannot be nil.') end if @runner_type.nil? invalid_properties.push('invalid value for "runner_type", runner_type cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
348 349 350 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 348 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
354 355 356 357 358 359 360 361 362 363 364 365 366 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 354 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
342 343 344 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 342 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
232 233 234 235 236 237 238 |
# File 'lib/akeyless/models/event_forwarder_create_email.rb', line 232 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' return false if @gateways_event_source_locations.nil? return false if @name.nil? return false if @runner_type.nil? true end |