VirtualDeploymentListener¶

class oci.service_mesh.models.VirtualDeploymentListener(**kwargs)¶

Bases: object

Listener configuration for a virtual deployment.

Attributes

`PROTOCOL_GRPC`	A constant which can be used with the protocol property of a VirtualDeploymentListener.
`PROTOCOL_HTTP`	A constant which can be used with the protocol property of a VirtualDeploymentListener.
`PROTOCOL_HTTP2`	A constant which can be used with the protocol property of a VirtualDeploymentListener.
`PROTOCOL_TCP`	A constant which can be used with the protocol property of a VirtualDeploymentListener.
`PROTOCOL_TLS_PASSTHROUGH`	A constant which can be used with the protocol property of a VirtualDeploymentListener.
`idle_timeout_in_ms`	Gets the idle_timeout_in_ms of this VirtualDeploymentListener.
`port`	[Required] Gets the port of this VirtualDeploymentListener.
`protocol`	[Required] Gets the protocol of this VirtualDeploymentListener.
`request_timeout_in_ms`	Gets the request_timeout_in_ms of this VirtualDeploymentListener.

Methods

__init__(**kwargs) Initializes a new VirtualDeploymentListener object with values from keyword arguments.

PROTOCOL_GRPC = 'GRPC'¶: A constant which can be used with the protocol property of a VirtualDeploymentListener. This constant has a value of “GRPC”

PROTOCOL_HTTP = 'HTTP'¶: A constant which can be used with the protocol property of a VirtualDeploymentListener. This constant has a value of “HTTP”

PROTOCOL_HTTP2 = 'HTTP2'¶: A constant which can be used with the protocol property of a VirtualDeploymentListener. This constant has a value of “HTTP2”

PROTOCOL_TCP = 'TCP'¶: A constant which can be used with the protocol property of a VirtualDeploymentListener. This constant has a value of “TCP”

PROTOCOL_TLS_PASSTHROUGH = 'TLS_PASSTHROUGH'¶: A constant which can be used with the protocol property of a VirtualDeploymentListener. This constant has a value of “TLS_PASSTHROUGH”

__init__(**kwargs)¶

Initializes a new VirtualDeploymentListener object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

protocol (str) – The value to assign to the protocol property of this VirtualDeploymentListener. Allowed values for this property are: “HTTP”, “TLS_PASSTHROUGH”, “TCP”, “HTTP2”, “GRPC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
port (int) – The value to assign to the port property of this VirtualDeploymentListener.
request_timeout_in_ms (int) – The value to assign to the request_timeout_in_ms property of this VirtualDeploymentListener.
idle_timeout_in_ms (int) – The value to assign to the idle_timeout_in_ms property of this VirtualDeploymentListener.

idle_timeout_in_ms¶

Gets the idle_timeout_in_ms of this VirtualDeploymentListener. 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:	The idle_timeout_in_ms of this VirtualDeploymentListener.
Return type:	int

port¶

[Required] Gets the port of this VirtualDeploymentListener. Port in which virtual deployment is running.

Returns:	The port of this VirtualDeploymentListener.
Return type:	int

protocol¶

[Required] Gets the protocol of this VirtualDeploymentListener. Type of protocol used in virtual deployment.

Allowed values for this property are: “HTTP”, “TLS_PASSTHROUGH”, “TCP”, “HTTP2”, “GRPC”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The protocol of this VirtualDeploymentListener.
Return type:	str

request_timeout_in_ms¶

Gets the request_timeout_in_ms of this VirtualDeploymentListener. 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:	The request_timeout_in_ms of this VirtualDeploymentListener.
Return type:	int