HttpIngressGatewayTrafficRouteRuleDetails¶

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

Bases: oci.service_mesh.models.ingress_gateway_traffic_route_rule_details.IngressGatewayTrafficRouteRuleDetails

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 HttpIngressGatewayTrafficRouteRuleDetails.
`TYPE_HTTP`	str(object=’’) -> str
`TYPE_TCP`	str(object=’’) -> str
`TYPE_TLS_PASSTHROUGH`	str(object=’’) -> str
`destinations`	[Required] Gets the destinations of this IngressGatewayTrafficRouteRuleDetails.
`ingress_gateway_host`	Gets the ingress_gateway_host of this IngressGatewayTrafficRouteRuleDetails.
`is_grpc`	Gets the is_grpc of this HttpIngressGatewayTrafficRouteRuleDetails.
`is_host_rewrite_enabled`	Gets the is_host_rewrite_enabled of this HttpIngressGatewayTrafficRouteRuleDetails.
`is_path_rewrite_enabled`	Gets the is_path_rewrite_enabled of this HttpIngressGatewayTrafficRouteRuleDetails.
`path`	Gets the path of this HttpIngressGatewayTrafficRouteRuleDetails.
`path_type`	Gets the path_type of this HttpIngressGatewayTrafficRouteRuleDetails.
`request_timeout_in_ms`	Gets the request_timeout_in_ms of this HttpIngressGatewayTrafficRouteRuleDetails.
`type`	[Required] Gets the type of this IngressGatewayTrafficRouteRuleDetails.

Methods

`__init__`(**kwargs)	Initializes a new HttpIngressGatewayTrafficRouteRuleDetails 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 HttpIngressGatewayTrafficRouteRuleDetails. This constant has a value of “PREFIX”

TYPE_HTTP = 'HTTP'¶

TYPE_TCP = 'TCP'¶

TYPE_TLS_PASSTHROUGH = 'TLS_PASSTHROUGH'¶

__init__(**kwargs)¶

Initializes a new HttpIngressGatewayTrafficRouteRuleDetails 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 HttpIngressGatewayTrafficRouteRuleDetails. Allowed values for this property are: “HTTP”, “TLS_PASSTHROUGH”, “TCP”
ingress_gateway_host (oci.service_mesh.models.IngressGatewayHostRef) – The value to assign to the ingress_gateway_host property of this HttpIngressGatewayTrafficRouteRuleDetails.
destinations (list[oci.service_mesh.models.VirtualServiceTrafficRuleTargetDetails]) – The value to assign to the destinations property of this HttpIngressGatewayTrafficRouteRuleDetails.
path (str) – The value to assign to the path property of this HttpIngressGatewayTrafficRouteRuleDetails.
path_type (str) – The value to assign to the path_type property of this HttpIngressGatewayTrafficRouteRuleDetails. Allowed values for this property are: “PREFIX”
is_grpc (bool) – The value to assign to the is_grpc property of this HttpIngressGatewayTrafficRouteRuleDetails.
is_host_rewrite_enabled (bool) – The value to assign to the is_host_rewrite_enabled property of this HttpIngressGatewayTrafficRouteRuleDetails.
is_path_rewrite_enabled (bool) – The value to assign to the is_path_rewrite_enabled property of this HttpIngressGatewayTrafficRouteRuleDetails.
request_timeout_in_ms (int) – The value to assign to the request_timeout_in_ms property of this HttpIngressGatewayTrafficRouteRuleDetails.

destinations¶

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

Returns:	The destinations of this IngressGatewayTrafficRouteRuleDetails.
Return type:	list[oci.service_mesh.models.VirtualServiceTrafficRuleTargetDetails]

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 IngressGatewayTrafficRouteRuleDetails.

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

is_grpc¶

Gets the is_grpc of this HttpIngressGatewayTrafficRouteRuleDetails. 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 HttpIngressGatewayTrafficRouteRuleDetails.
Return type:	bool

is_host_rewrite_enabled¶

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

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

is_path_rewrite_enabled¶

Gets the is_path_rewrite_enabled of this HttpIngressGatewayTrafficRouteRuleDetails. 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 HttpIngressGatewayTrafficRouteRuleDetails.
Return type:	bool

path¶

Gets the path of this HttpIngressGatewayTrafficRouteRuleDetails. Route to match

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

path_type¶

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

Allowed values for this property are: “PREFIX”

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

request_timeout_in_ms¶

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

type¶

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

Allowed values for this property are: “HTTP”, “TLS_PASSTHROUGH”, “TCP”

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