Class: OCI::Apigateway::Models::ApiSpecification

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/apigateway/models/api_specification.rb

Overview

The logical configuration of the API exposed by a deployment.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApiSpecification

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/apigateway/models/api_specification.rb', line 52

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

Instance Attribute Details

#logging_policies ⇒ OCI::Apigateway::Models::ApiSpecificationLoggingPolicies

Returns:



15
16
17
 
# File 'lib/oci/apigateway/models/api_specification.rb', line 15

def logging_policies
  @logging_policies
end

#request_policies ⇒ OCI::Apigateway::Models::ApiSpecificationRequestPolicies

Returns:



12
13
14
 
# File 'lib/oci/apigateway/models/api_specification.rb', line 12

def request_policies
  @request_policies
end

#routes ⇒ Array<OCI::Apigateway::Models::ApiSpecificationRoute>

A list of routes that this API exposes.

Returns:



19
20
21
 
# File 'lib/oci/apigateway/models/api_specification.rb', line 19

def routes
  @routes
end

Class Method Details

.attribute_map ⇒ Object

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



22
23
24
25
26
27
28
29
30
 
# File 'lib/oci/apigateway/models/api_specification.rb', line 22

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'request_policies': :'requestPolicies',
    'logging_policies': :'loggingPolicies',
    'routes': :'routes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



33
34
35
36
37
38
39
40
41
 
# File 'lib/oci/apigateway/models/api_specification.rb', line 33

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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



80
81
82
83
84
85
86
87
 
# File 'lib/oci/apigateway/models/api_specification.rb', line 80

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/oci/apigateway/models/api_specification.rb', line 112

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) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


92
93
94
 
# File 'lib/oci/apigateway/models/api_specification.rb', line 92

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



101
102
103
 
# File 'lib/oci/apigateway/models/api_specification.rb', line 101

def hash
  [request_policies, logging_policies, routes].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/apigateway/models/api_specification.rb', line 145

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

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



139
140
141
 
# File 'lib/oci/apigateway/models/api_specification.rb', line 139

def to_s
  to_hash.to_s
end