Class: OCI::ServiceMesh::Models::HttpIngressGatewayTrafficRouteRule

Inherits:
IngressGatewayTrafficRouteRule show all
Defined in:
lib/oci/service_mesh/models/http_ingress_gateway_traffic_route_rule.rb

Overview

Rule for routing incoming ingress gateway traffic with HTTP protocol

Constant Summary collapse

PATH_TYPE_ENUM = 
[
  PATH_TYPE_PREFIX = 'PREFIX'.freeze,
  PATH_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from IngressGatewayTrafficRouteRule

IngressGatewayTrafficRouteRule::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from IngressGatewayTrafficRouteRule

#destinations, #ingress_gateway_host, #type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from IngressGatewayTrafficRouteRule

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ HttpIngressGatewayTrafficRouteRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
146
147
148
 
# File 'lib/oci/service_mesh/models/http_ingress_gateway_traffic_route_rule.rb', line 98

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['type'] = 'HTTP'

  super(attributes)

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

  self.path = attributes[:'path'] if attributes[:'path']
  self.path = "/" if path.nil? && !attributes.key?(:'path') # rubocop:disable Style/StringLiterals

  self.path_type = attributes[:'pathType'] if attributes[:'pathType']
  self.path_type = "PREFIX" if path_type.nil? && !attributes.key?(:'pathType') # rubocop:disable Style/StringLiterals

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

  self.path_type = attributes[:'path_type'] if attributes[:'path_type']
  self.path_type = "PREFIX" if path_type.nil? && !attributes.key?(:'pathType') && !attributes.key?(:'path_type') # rubocop:disable Style/StringLiterals

  self.is_grpc = attributes[:'isGrpc'] unless attributes[:'isGrpc'].nil?
  self.is_grpc = false if is_grpc.nil? && !attributes.key?(:'isGrpc') # rubocop:disable Style/StringLiterals

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

  self.is_grpc = attributes[:'is_grpc'] unless attributes[:'is_grpc'].nil?
  self.is_grpc = false if is_grpc.nil? && !attributes.key?(:'isGrpc') && !attributes.key?(:'is_grpc') # rubocop:disable Style/StringLiterals

  self.is_host_rewrite_enabled = attributes[:'isHostRewriteEnabled'] unless attributes[:'isHostRewriteEnabled'].nil?
  self.is_host_rewrite_enabled = false if is_host_rewrite_enabled.nil? && !attributes.key?(:'isHostRewriteEnabled') # rubocop:disable Style/StringLiterals

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

  self.is_host_rewrite_enabled = attributes[:'is_host_rewrite_enabled'] unless attributes[:'is_host_rewrite_enabled'].nil?
  self.is_host_rewrite_enabled = false if is_host_rewrite_enabled.nil? && !attributes.key?(:'isHostRewriteEnabled') && !attributes.key?(:'is_host_rewrite_enabled') # rubocop:disable Style/StringLiterals

  self.is_path_rewrite_enabled = attributes[:'isPathRewriteEnabled'] unless attributes[:'isPathRewriteEnabled'].nil?
  self.is_path_rewrite_enabled = false if is_path_rewrite_enabled.nil? && !attributes.key?(:'isPathRewriteEnabled') # rubocop:disable Style/StringLiterals

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

  self.is_path_rewrite_enabled = attributes[:'is_path_rewrite_enabled'] unless attributes[:'is_path_rewrite_enabled'].nil?
  self.is_path_rewrite_enabled = false if is_path_rewrite_enabled.nil? && !attributes.key?(:'isPathRewriteEnabled') && !attributes.key?(:'is_path_rewrite_enabled') # rubocop:disable Style/StringLiterals

  self.request_timeout_in_ms = attributes[:'requestTimeoutInMs'] if attributes[:'requestTimeoutInMs']

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

  self.request_timeout_in_ms = attributes[:'request_timeout_in_ms'] if attributes[:'request_timeout_in_ms']
end

Instance Attribute Details

#is_grpc ⇒ BOOLEAN

If true, the rule will check that the content-type header has a application/grpc or one of the various application/grpc+ values.

Returns:

  • (BOOLEAN) 


30
31
32
 
# File 'lib/oci/service_mesh/models/http_ingress_gateway_traffic_route_rule.rb', line 30

def is_grpc
  @is_grpc
end

#is_host_rewrite_enabled ⇒ BOOLEAN

If true, the hostname will be rewritten to the target virtual deployment's DNS hostname.

Returns:

  • (BOOLEAN) 


35
36
37
 
# File 'lib/oci/service_mesh/models/http_ingress_gateway_traffic_route_rule.rb', line 35

def is_host_rewrite_enabled
  @is_host_rewrite_enabled
end

#is_path_rewrite_enabled ⇒ BOOLEAN

If true, the matched path prefix will be rewritten to '/' before being directed to the target virtual deployment.

Returns:

  • (BOOLEAN) 


40
41
42
 
# File 'lib/oci/service_mesh/models/http_ingress_gateway_traffic_route_rule.rb', line 40

def is_path_rewrite_enabled
  @is_path_rewrite_enabled
end

#path ⇒ String

Route to match

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/service_mesh/models/http_ingress_gateway_traffic_route_rule.rb', line 20

def path
  @path
end

#path_type ⇒ String

Match type for the route

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/service_mesh/models/http_ingress_gateway_traffic_route_rule.rb', line 24

def path_type
  @path_type
end

#request_timeout_in_ms ⇒ Integer

The maximum duration in milliseconds for the upstream service to respond to a request. If provided, the timeout value overrides the default timeout of 15 seconds for the HTTP based route rules, and disabled (no timeout) when 'isGrpc' is true. The value 0 (zero) indicates that the timeout is disabled. For streaming responses from the upstream service, consider either keeping the timeout disabled or set a sufficiently high value.

Returns:

  • (Integer) 


48
49
50
 
# File 'lib/oci/service_mesh/models/http_ingress_gateway_traffic_route_rule.rb', line 48

def request_timeout_in_ms
  @request_timeout_in_ms
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/service_mesh/models/http_ingress_gateway_traffic_route_rule.rb', line 51

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'ingress_gateway_host': :'ingressGatewayHost',
    'destinations': :'destinations',
    'path': :'path',
    'path_type': :'pathType',
    'is_grpc': :'isGrpc',
    'is_host_rewrite_enabled': :'isHostRewriteEnabled',
    'is_path_rewrite_enabled': :'isPathRewriteEnabled',
    'request_timeout_in_ms': :'requestTimeoutInMs'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'ingress_gateway_host': :'OCI::ServiceMesh::Models::IngressGatewayHostRef',
    'destinations': :'Array<OCI::ServiceMesh::Models::VirtualServiceTrafficRuleTarget>',
    'path': :'String',
    'path_type': :'String',
    'is_grpc': :'BOOLEAN',
    'is_host_rewrite_enabled': :'BOOLEAN',
    'is_path_rewrite_enabled': :'BOOLEAN',
    'request_timeout_in_ms': :'Integer'
    # 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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/service_mesh/models/http_ingress_gateway_traffic_route_rule.rb', line 170

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    type == other.type &&
    ingress_gateway_host == other.ingress_gateway_host &&
    destinations == other.destinations &&
    path == other.path &&
    path_type == other.path_type &&
    is_grpc == other.is_grpc &&
    is_host_rewrite_enabled == other.is_host_rewrite_enabled &&
    is_path_rewrite_enabled == other.is_path_rewrite_enabled &&
    request_timeout_in_ms == other.request_timeout_in_ms
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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/oci/service_mesh/models/http_ingress_gateway_traffic_route_rule.rb', line 208

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


188
189
190
 
# File 'lib/oci/service_mesh/models/http_ingress_gateway_traffic_route_rule.rb', line 188

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



197
198
199
 
# File 'lib/oci/service_mesh/models/http_ingress_gateway_traffic_route_rule.rb', line 197

def hash
  [type, ingress_gateway_host, destinations, path, path_type, is_grpc, is_host_rewrite_enabled, is_path_rewrite_enabled, request_timeout_in_ms].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



241
242
243
244
245
246
247
248
249
250
 
# File 'lib/oci/service_mesh/models/http_ingress_gateway_traffic_route_rule.rb', line 241

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



235
236
237
 
# File 'lib/oci/service_mesh/models/http_ingress_gateway_traffic_route_rule.rb', line 235

def to_s
  to_hash.to_s
end