Class: Fastly::TlsCsrDataAttributes

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

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



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

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
end

Instance Attribute Details

#cityObject

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_nameObject

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

#countryObject

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

#emailObject

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

#organizationObject

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_unitObject

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_codeObject

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

#sansObject

Subject Altername 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

#stateObject

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_addressObject

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_attributesObject

Returns all the JSON keys this model knows about



63
64
65
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 63

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



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

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'
  }
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



197
198
199
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 197

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

.fastly_nullableObject

List of attributes with nullable: true



84
85
86
87
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 84

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

.fastly_typesObject

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 68

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'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



167
168
169
170
171
172
173
174
175
176
177
178
179
180
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 167

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
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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 227

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



298
299
300
301
302
303
304
305
306
307
308
309
310
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 298

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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 204

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


184
185
186
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 184

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



190
191
192
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 190

def hash
  [sans, common_name, country, state, city, postal_code, street_address, organization, organizational_unit, email].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



149
150
151
152
153
154
155
156
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 149

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_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



274
275
276
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 274

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



280
281
282
283
284
285
286
287
288
289
290
291
292
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 280

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



268
269
270
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 268

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



160
161
162
163
# File 'lib/fastly/models/tls_csr_data_attributes.rb', line 160

def valid?
  return false if @sans.nil?
  true
end