HttpIngressGatewayTrafficRouteRule¶

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

Bases: oci.service_mesh.models.ingress_gateway_traffic_route_rule.IngressGatewayTrafficRouteRule

Rule for routing incoming ingress gateway traffic with HTTP protocol

Attributes

`PATH_TYPE_PREFIX`	A constant which can be used with the path_type property of a HttpIngressGatewayTrafficRouteRule.
`TYPE_HTTP`	str(object=’’) -> str
`TYPE_TCP`	str(object=’’) -> str
`TYPE_TLS_PASSTHROUGH`	str(object=’’) -> str
`destinations`	[Required] Gets the destinations of this IngressGatewayTrafficRouteRule.
`ingress_gateway_host`	Gets the ingress_gateway_host of this IngressGatewayTrafficRouteRule.
`is_grpc`	Gets the is_grpc of this HttpIngressGatewayTrafficRouteRule.
`is_host_rewrite_enabled`	Gets the is_host_rewrite_enabled of this HttpIngressGatewayTrafficRouteRule.
`is_path_rewrite_enabled`	Gets the is_path_rewrite_enabled of this HttpIngressGatewayTrafficRouteRule.
`path`	Gets the path of this HttpIngressGatewayTrafficRouteRule.
`path_type`	Gets the path_type of this HttpIngressGatewayTrafficRouteRule.
`request_timeout_in_ms`	Gets the request_timeout_in_ms of this HttpIngressGatewayTrafficRouteRule.
`type`	[Required] Gets the type of this IngressGatewayTrafficRouteRule.

Methods

`__init__`(**kwargs)	Initializes a new HttpIngressGatewayTrafficRouteRule object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

PATH_TYPE_PREFIX = 'PREFIX'¶: A constant which can be used with the path_type property of a HttpIngressGatewayTrafficRouteRule. This constant has a value of “PREFIX”

TYPE_HTTP = 'HTTP'¶

TYPE_TCP = 'TCP'¶

TYPE_TLS_PASSTHROUGH = 'TLS_PASSTHROUGH'¶

__init__(**kwargs)¶

Initializes a new HttpIngressGatewayTrafficRouteRule object with values from keyword arguments. The default value of the type attribute of this class is HTTP and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

type (str) – The value to assign to the type property of this HttpIngressGatewayTrafficRouteRule. Allowed values for this property are: “HTTP”, “TLS_PASSTHROUGH”, “TCP”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
ingress_gateway_host (oci.service_mesh.models.IngressGatewayHostRef) – The value to assign to the ingress_gateway_host property of this HttpIngressGatewayTrafficRouteRule.
destinations (list[oci.service_mesh.models.VirtualServiceTrafficRuleTarget]) – The value to assign to the destinations property of this HttpIngressGatewayTrafficRouteRule.
path (str) – The value to assign to the path property of this HttpIngressGatewayTrafficRouteRule.
path_type (str) – The value to assign to the path_type property of this HttpIngressGatewayTrafficRouteRule. Allowed values for this property are: “PREFIX”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_grpc (bool) – The value to assign to the is_grpc property of this HttpIngressGatewayTrafficRouteRule.
is_host_rewrite_enabled (bool) – The value to assign to the is_host_rewrite_enabled property of this HttpIngressGatewayTrafficRouteRule.
is_path_rewrite_enabled (bool) – The value to assign to the is_path_rewrite_enabled property of this HttpIngressGatewayTrafficRouteRule.
request_timeout_in_ms (int) – The value to assign to the request_timeout_in_ms property of this HttpIngressGatewayTrafficRouteRule.

destinations¶

[Required] Gets the destinations of this IngressGatewayTrafficRouteRule. The destination of the request.

Returns:	The destinations of this IngressGatewayTrafficRouteRule.
Return type:	list[oci.service_mesh.models.VirtualServiceTrafficRuleTarget]

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

ingress_gateway_host¶

Gets the ingress_gateway_host of this IngressGatewayTrafficRouteRule.

Returns:	The ingress_gateway_host of this IngressGatewayTrafficRouteRule.
Return type:	oci.service_mesh.models.IngressGatewayHostRef

is_grpc¶

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

Returns:	The is_grpc of this HttpIngressGatewayTrafficRouteRule.
Return type:	bool

is_host_rewrite_enabled¶

Gets the is_host_rewrite_enabled of this HttpIngressGatewayTrafficRouteRule. If true, the hostname will be rewritten to the target virtual deployment’s DNS hostname.

Returns:	The is_host_rewrite_enabled of this HttpIngressGatewayTrafficRouteRule.
Return type:	bool

is_path_rewrite_enabled¶

Gets the is_path_rewrite_enabled of this HttpIngressGatewayTrafficRouteRule. If true, the matched path prefix will be rewritten to ‘/’ before being directed to the target virtual deployment.

Returns:	The is_path_rewrite_enabled of this HttpIngressGatewayTrafficRouteRule.
Return type:	bool

path¶

Gets the path of this HttpIngressGatewayTrafficRouteRule. Route to match

Returns:	The path of this HttpIngressGatewayTrafficRouteRule.
Return type:	str

path_type¶

Gets the path_type of this HttpIngressGatewayTrafficRouteRule. Match type for the route

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

Returns:	The path_type of this HttpIngressGatewayTrafficRouteRule.
Return type:	str

request_timeout_in_ms¶

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

type¶

[Required] Gets the type of this IngressGatewayTrafficRouteRule. Type of protocol.

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

Returns:	The type of this IngressGatewayTrafficRouteRule.
Return type:	str