Class: OCI::ServiceMesh::Models::HttpVirtualServiceTrafficRouteRule

Inherits:
VirtualServiceTrafficRouteRule show all
Defined in:
lib/oci/service_mesh/models/http_virtual_service_traffic_route_rule.rb

Overview

Rule for routing incoming Virtual Service 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 VirtualServiceTrafficRouteRule

VirtualServiceTrafficRouteRule::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from VirtualServiceTrafficRouteRule

#destinations, #type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from VirtualServiceTrafficRouteRule

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ HttpVirtualServiceTrafficRouteRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/service_mesh/models/http_virtual_service_traffic_route_rule.rb', line 79

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.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_virtual_service_traffic_route_rule.rb', line 30

def is_grpc
  @is_grpc
end

#path ⇒ String

Route to match

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/service_mesh/models/http_virtual_service_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_virtual_service_traffic_route_rule.rb', line 24

def path_type
  @path_type
end

#request_timeout_in_ms ⇒ Integer

The maximum duration in milliseconds for the target 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 target service, consider either keeping the timeout disabled or set a sufficiently high value.

Returns:

  • (Integer) 


38
39
40
 
# File 'lib/oci/service_mesh/models/http_virtual_service_traffic_route_rule.rb', line 38

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.



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/oci/service_mesh/models/http_virtual_service_traffic_route_rule.rb', line 41

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

.swagger_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/service_mesh/models/http_virtual_service_traffic_route_rule.rb', line 55

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'destinations': :'Array<OCI::ServiceMesh::Models::VirtualDeploymentTrafficRuleTarget>',
    'path': :'String',
    'path_type': :'String',
    'is_grpc': :'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



135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/service_mesh/models/http_virtual_service_traffic_route_rule.rb', line 135

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

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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/oci/service_mesh/models/http_virtual_service_traffic_route_rule.rb', line 170

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


150
151
152
 
# File 'lib/oci/service_mesh/models/http_virtual_service_traffic_route_rule.rb', line 150

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



159
160
161
 
# File 'lib/oci/service_mesh/models/http_virtual_service_traffic_route_rule.rb', line 159

def hash
  [type, destinations, path, path_type, is_grpc, 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



203
204
205
206
207
208
209
210
211
212
 
# File 'lib/oci/service_mesh/models/http_virtual_service_traffic_route_rule.rb', line 203

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



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

def to_s
  to_hash.to_s
end