class Fastly::TlsCsrDataAttributes

Attributes

city[RW]

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

common_name[RW]

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.

country[RW]

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

email[RW]

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

key_type[RW]

CSR Key Type.

organization[RW]

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

organizational_unit[RW]

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

postal_code[RW]

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

sans[RW]

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

state[RW]

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

street_address[RW]

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

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/fastly/models/tls_csr_data_attributes.rb, line 89
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# File lib/fastly/models/tls_csr_data_attributes.rb, line 72
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'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/fastly/models/tls_csr_data_attributes.rb, line 241
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
fastly_nullable() click to toggle source

List of attributes with nullable: true

# File lib/fastly/models/tls_csr_data_attributes.rb, line 111
def self.fastly_nullable
  Set.new([
  ])
end
fastly_types() click to toggle source

Attribute type mapping.

# File lib/fastly/models/tls_csr_data_attributes.rb, line 94
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'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/fastly/models/tls_csr_data_attributes.rb, line 210
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
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/fastly/models/tls_csr_data_attributes.rb, line 271
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/fastly/models/tls_csr_data_attributes.rb, line 342
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/fastly/models/tls_csr_data_attributes.rb, line 248
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) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/fastly/models/tls_csr_data_attributes.rb, line 228
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/fastly/models/tls_csr_data_attributes.rb, line 234
def hash
  [sans, common_name, country, state, city, postal_code, street_address, organization, organizational_unit, email, key_type].hash
end
key_type=(key_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] key_type Object to be assigned

# File lib/fastly/models/tls_csr_data_attributes.rb, line 200
def key_type=(key_type)
  validator = EnumAttributeValidator.new('String', ["RSA2048", "ECDSA256"])
  unless validator.valid?(key_type)
    fail ArgumentError, "invalid value for \"key_type\", must be one of #{validator.allowable_values}."
  end
  @key_type = key_type
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/fastly/models/tls_csr_data_attributes.rb, line 180
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() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/fastly/models/tls_csr_data_attributes.rb, line 318
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/fastly/models/tls_csr_data_attributes.rb, line 324
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/fastly/models/tls_csr_data_attributes.rb, line 312
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

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