Class: Fastly::TlsCsrDataAttributes

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/models/tls_csr_data_attributes.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TlsCsrDataAttributes

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 123

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Fastly::TlsCsrDataAttributes` 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 `Fastly::TlsCsrDataAttributes`. 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?(:'sans')
    if (value = attributes[:'sans']).is_a?(Array)
      self.sans = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#city ⇒ Object

Locality (L) - The locality, city, town, or village where the organization is located.



29
30
31
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 29

def city
  @city
end

#common_name ⇒ Object

Common Name (CN) - The fully qualified domain name (FQDN) to be secured by this certificate. The common name should be one of the entries in the SANs parameter.



20
21
22
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 20

def common_name
  @common_name
end

#country ⇒ Object

Country © - The two-letter ISO country code where the organization is located.



23
24
25
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 23

def country
  @country
end

#email ⇒ Object

Email Address (EMAIL) - The organizational contact for this.



44
45
46
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 44

def email
  @email
end

#key_type ⇒ Object

CSR Key Type.



47
48
49
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 47

def key_type
  @key_type
end

#organization ⇒ Object

Organization (O) - The legal name of the organization, including any suffixes. This should not be abbreviated.



38
39
40
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 38

def organization
  @organization
end

#organizational_unit ⇒ Object

Organizational Unit (OU) - The internal division of the organization managing the certificate.



41
42
43
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 41

def organizational_unit
  @organizational_unit
end

#postal_code ⇒ Object

Postal Code - The postal code where the organization is located.



32
33
34
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 32

def postal_code
  @postal_code
end

#relationships_tls_private_key_id ⇒ Object

Optional. An alphanumeric string identifying the private key you’ve uploaded for use with your TLS certificate. If left blank, Fastly will create and manage a key for you.



50
51
52
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 50

def relationships_tls_private_key_id
  @relationships_tls_private_key_id
end

#sans ⇒ Object

Subject Alternate Names - An array of one or more fully qualified domain names or public IP addresses to be secured by this certificate. Required.



17
18
19
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 17

def sans
  @sans
end

#state ⇒ Object

State (S) - The state, province, region, or county where the organization is located. This should not be abbreviated.



26
27
28
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 26

def state
  @state
end

#street_address ⇒ Object

Street Address - The street address where the organization is located.



35
36
37
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 35

def street_address
  @street_address
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



93
94
95
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 93

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 75

def self.attribute_map
  {
    :'sans' => :'sans',
    :'common_name' => :'common_name',
    :'country' => :'country',
    :'state' => :'state',
    :'city' => :'city',
    :'postal_code' => :'postal_code',
    :'street_address' => :'street_address',
    :'organization' => :'organization',
    :'organizational_unit' => :'organizational_unit',
    :'email' => :'email',
    :'key_type' => :'key_type',
    :'relationships_tls_private_key_id' => :'relationships.tls_private_key.id'
  }
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



251
252
253
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 251

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.fastly_nullable ⇒ Object

List of attributes with nullable: true



116
117
118
119
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 116

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

.fastly_types ⇒ Object

Attribute type mapping.



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

def self.fastly_types
  {
    :'sans' => :'Array<String>',
    :'common_name' => :'String',
    :'country' => :'String',
    :'state' => :'String',
    :'city' => :'String',
    :'postal_code' => :'String',
    :'street_address' => :'String',
    :'organization' => :'String',
    :'organizational_unit' => :'String',
    :'email' => :'String',
    :'key_type' => :'String',
    :'relationships_tls_private_key_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 219

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      sans == o.sans &&
      common_name == o.common_name &&
      country == o.country &&
      state == o.state &&
      city == o.city &&
      postal_code == o.postal_code &&
      street_address == o.street_address &&
      organization == o.organization &&
      organizational_unit == o.organizational_unit &&
      email == o.email &&
      key_type == o.key_type &&
      relationships_tls_private_key_id == o.relationships_tls_private_key_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 281

def _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 = Fastly.const_get(type)
    klass.respond_to?(:fastly_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 352

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

#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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 258

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.fastly_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.fastly_nullable.include?(key)
      self.send("#{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[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]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


238
239
240
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 238

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



244
245
246
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 244

def hash
  [sans, common_name, country, state, city, postal_code, street_address, organization, organizational_unit, email, key_type, relationships_tls_private_key_id].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



189
190
191
192
193
194
195
196
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 189

def list_invalid_properties
  invalid_properties = Array.new
  if @sans.nil?
    invalid_properties.push('invalid value for "sans", sans cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



328
329
330
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 328

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 334

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.fastly_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

Returns:

  • (String) —

    String presentation of the object



322
323
324
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 322

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



200
201
202
203
204
205
 
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 200

def valid?
  return false if @sans.nil?
  key_type_validator = EnumAttributeValidator.new('String', ["RSA2048", "ECDSA256"])
  return false unless key_type_validator.valid?(@key_type)
  true
end