class OCI::Apigateway::Models::ApiSpecification

The logical configuration of the API exposed by a deployment.

Attributes

logging_policies[RW]

@return [OCI::Apigateway::Models::ApiSpecificationLoggingPolicies]

request_policies[RW]

@return [OCI::Apigateway::Models::ApiSpecificationRequestPolicies]

routes[RW]

A list of routes that this API exposes. @return [Array<OCI::Apigateway::Models::ApiSpecificationRoute>]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/apigateway/models/api_specification.rb, line 21
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'request_policies': :'requestPolicies',
    'logging_policies': :'loggingPolicies',
    'routes': :'routes'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [OCI::Apigateway::Models::ApiSpecificationRequestPolicies] :request_policies The value to assign to the {#request_policies} property @option attributes [OCI::Apigateway::Models::ApiSpecificationLoggingPolicies] :logging_policies The value to assign to the {#logging_policies} property @option attributes [Array<OCI::Apigateway::Models::ApiSpecificationRoute>] :routes The value to assign to the {#routes} property

# File lib/oci/apigateway/models/api_specification.rb, line 51
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.request_policies = attributes[:'requestPolicies'] if attributes[:'requestPolicies']

  raise 'You cannot provide both :requestPolicies and :request_policies' if attributes.key?(:'requestPolicies') && attributes.key?(:'request_policies')

  self.request_policies = attributes[:'request_policies'] if attributes[:'request_policies']

  self.logging_policies = attributes[:'loggingPolicies'] if attributes[:'loggingPolicies']

  raise 'You cannot provide both :loggingPolicies and :logging_policies' if attributes.key?(:'loggingPolicies') && attributes.key?(:'logging_policies')

  self.logging_policies = attributes[:'logging_policies'] if attributes[:'logging_policies']

  self.routes = attributes[:'routes'] if attributes[:'routes']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/apigateway/models/api_specification.rb, line 32
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'request_policies': :'OCI::Apigateway::Models::ApiSpecificationRequestPolicies',
    'logging_policies': :'OCI::Apigateway::Models::ApiSpecificationLoggingPolicies',
    'routes': :'Array<OCI::Apigateway::Models::ApiSpecificationRoute>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

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

# File lib/oci/apigateway/models/api_specification.rb, line 79
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    request_policies == other.request_policies &&
    logging_policies == other.logging_policies &&
    routes == other.routes
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/oci/apigateway/models/api_specification.rb, line 111
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(other) click to toggle source

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

# File lib/oci/apigateway/models/api_specification.rb, line 91
def eql?(other)
  self == other
end
hash() click to toggle source

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

# File lib/oci/apigateway/models/api_specification.rb, line 100
def hash
  [request_policies, logging_policies, routes].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/oci/apigateway/models/api_specification.rb, line 144
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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/oci/apigateway/models/api_specification.rb, line 138
def to_s
  to_hash.to_s
end

Private Instance Methods

_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/oci/apigateway/models/api_specification.rb, line 161
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