Class: OCI::ServiceMesh::Models::VirtualDeploymentListener

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/service_mesh/models/virtual_deployment_listener.rb

Overview

Listener configuration for a virtual deployment.

Constant Summary collapse

PROTOCOL_ENUM = 
[
  PROTOCOL_HTTP = 'HTTP'.freeze,
  PROTOCOL_TLS_PASSTHROUGH = 'TLS_PASSTHROUGH'.freeze,
  PROTOCOL_TCP = 'TCP'.freeze,
  PROTOCOL_HTTP2 = 'HTTP2'.freeze,
  PROTOCOL_GRPC = 'GRPC'.freeze,
  PROTOCOL_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VirtualDeploymentListener

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :protocol (String) —

    The value to assign to the #protocol property

  • :port (Integer) —

    The value to assign to the #port property

  • :request_timeout_in_ms (Integer) —

    The value to assign to the #request_timeout_in_ms property

  • :idle_timeout_in_ms (Integer) —

    The value to assign to the #idle_timeout_in_ms property



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/service_mesh/models/virtual_deployment_listener.rb', line 75

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.protocol = attributes[:'protocol'] if attributes[:'protocol']

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

  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']

  self.idle_timeout_in_ms = attributes[:'idleTimeoutInMs'] if attributes[:'idleTimeoutInMs']

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

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

Instance Attribute Details

#idle_timeout_in_ms ⇒ Integer

The maximum duration in milliseconds for which the request's stream may be idle. The value 0 (zero) indicates that the timeout is disabled.

Returns:

  • (Integer) 


39
40
41
 
# File 'lib/oci/service_mesh/models/virtual_deployment_listener.rb', line 39

def idle_timeout_in_ms
  @idle_timeout_in_ms
end

#port ⇒ Integer

[Required] Port in which virtual deployment is running.

Returns:

  • (Integer) 


27
28
29
 
# File 'lib/oci/service_mesh/models/virtual_deployment_listener.rb', line 27

def port
  @port
end

#protocol ⇒ String

[Required] Type of protocol used in virtual deployment.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/service_mesh/models/virtual_deployment_listener.rb', line 23

def protocol
  @protocol
end

#request_timeout_in_ms ⇒ Integer

The maximum duration in milliseconds for the deployed service to respond to an incoming request through the listener. If provided, the timeout value overrides the default timeout of 15 seconds for the HTTP/HTTP2 listeners, and disabled (no timeout) for the GRPC listeners. The value 0 (zero) indicates that the timeout is disabled. The timeout cannot be configured for the TCP and TLS_PASSTHROUGH listeners. For streaming responses from the deployed service, consider either keeping the timeout disabled or set a sufficiently high value.

Returns:

  • (Integer) 


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

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.



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'protocol': :'protocol',
    'port': :'port',
    'request_timeout_in_ms': :'requestTimeoutInMs',
    'idle_timeout_in_ms': :'idleTimeoutInMs'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/oci/service_mesh/models/virtual_deployment_listener.rb', line 54

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'protocol': :'String',
    'port': :'Integer',
    'request_timeout_in_ms': :'Integer',
    'idle_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



118
119
120
121
122
123
124
125
126
 
# File 'lib/oci/service_mesh/models/virtual_deployment_listener.rb', line 118

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

  self.class == other.class &&
    protocol == other.protocol &&
    port == other.port &&
    request_timeout_in_ms == other.request_timeout_in_ms &&
    idle_timeout_in_ms == other.idle_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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/service_mesh/models/virtual_deployment_listener.rb', line 151

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


131
132
133
 
# File 'lib/oci/service_mesh/models/virtual_deployment_listener.rb', line 131

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



140
141
142
 
# File 'lib/oci/service_mesh/models/virtual_deployment_listener.rb', line 140

def hash
  [protocol, port, request_timeout_in_ms, idle_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



184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/service_mesh/models/virtual_deployment_listener.rb', line 184

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



178
179
180
 
# File 'lib/oci/service_mesh/models/virtual_deployment_listener.rb', line 178

def to_s
  to_hash.to_s
end