Package com.oracle.bmc.servicemesh.model

Class HttpIngressGatewayTrafficRouteRule

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.servicemesh.model.IngressGatewayTrafficRouteRule

com.oracle.bmc.servicemesh.model.HttpIngressGatewayTrafficRouteRule

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220615")
public final class HttpIngressGatewayTrafficRouteRule
extends IngressGatewayTrafficRouteRule

Rule for routing incoming ingress gateway traffic with HTTP protocol
Note: Objects should always be created or deserialized using the HttpIngressGatewayTrafficRouteRule.Builder.

This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the HttpIngressGatewayTrafficRouteRule.Builder, which maintain a set of all explicitly set fields called HttpIngressGatewayTrafficRouteRule.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpIngressGatewayTrafficRouteRule.Builder
static class	HttpIngressGatewayTrafficRouteRule.PathType	Match type for the route

Nested classes/interfaces inherited from class com.oracle.bmc.servicemesh.model.IngressGatewayTrafficRouteRule

IngressGatewayTrafficRouteRule.Type

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
HttpIngressGatewayTrafficRouteRule(IngressGatewayHostRef ingressGatewayHost, List<VirtualServiceTrafficRuleTarget> destinations, String path, HttpIngressGatewayTrafficRouteRule.PathType pathType, Boolean isGrpc, Boolean isHostRewriteEnabled, Boolean isPathRewriteEnabled, Long requestTimeoutInMs)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static HttpIngressGatewayTrafficRouteRule.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Boolean	getIsGrpc()	If true, the rule will check that the content-type header has a application/grpc or one of the various application/grpc+ values.
Boolean	getIsHostRewriteEnabled()	If true, the hostname will be rewritten to the target virtual deployment’s DNS hostname.
Boolean	getIsPathRewriteEnabled()	If true, the matched path prefix will be rewritten to ‘/’ before being directed to the target virtual deployment.
String	getPath()	Route to match
HttpIngressGatewayTrafficRouteRule.PathType	getPathType()	Match type for the route
Long	getRequestTimeoutInMs()	The maximum duration in milliseconds for the upstream service to respond to a request.
int	hashCode()
HttpIngressGatewayTrafficRouteRule.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.servicemesh.model.IngressGatewayTrafficRouteRule

getDestinations, getIngressGatewayHost

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HttpIngressGatewayTrafficRouteRule

@Deprecated
public HttpIngressGatewayTrafficRouteRule(IngressGatewayHostRef ingressGatewayHost,
                                          List<VirtualServiceTrafficRuleTarget> destinations,
                                          String path,
                                          HttpIngressGatewayTrafficRouteRule.PathType pathType,
                                          Boolean isGrpc,
                                          Boolean isHostRewriteEnabled,
                                          Boolean isPathRewriteEnabled,
                                          Long requestTimeoutInMs)

Deprecated.

Method Detail

builder

public static HttpIngressGatewayTrafficRouteRule.Builder builder()

Create a new builder.

toBuilder

public HttpIngressGatewayTrafficRouteRule.Builder toBuilder()

getPath

public String getPath()

Route to match

Returns:

the value

getPathType

public HttpIngressGatewayTrafficRouteRule.PathType getPathType()

Match type for the route

Returns:

the value

getIsGrpc

public Boolean getIsGrpc()

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 value

getIsHostRewriteEnabled

public Boolean getIsHostRewriteEnabled()

If true, the hostname will be rewritten to the target virtual deployment’s DNS hostname.

Returns:

the value

getIsPathRewriteEnabled

public Boolean getIsPathRewriteEnabled()

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

Returns:

the value

getRequestTimeoutInMs

public Long getRequestTimeoutInMs()

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 value

toString

public String toString()

Overrides:

toString in class IngressGatewayTrafficRouteRule

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class IngressGatewayTrafficRouteRule

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class IngressGatewayTrafficRouteRule

hashCode

public int hashCode()

Overrides:

hashCode in class IngressGatewayTrafficRouteRule