Class HttpRouteMatch
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<HttpRouteMatch.Builder,
HttpRouteMatch>
An object that represents the requirements for a route to match HTTP requests for a virtual router.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic HttpRouteMatch.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Headers property.final boolean
For responses, this returns true if the service returned a value for the QueryParameters property.final List
<HttpRouteHeader> headers()
The client request headers to match on.final HttpMethod
method()
The client request method to match on.final String
The client request method to match on.final HttpPathMatch
path()
The client request path to match on.final Integer
port()
The port number to match on.final String
prefix()
Specifies the path to match requests with.final List
<HttpQueryParameter> The client request query parameters to match on.final HttpScheme
scheme()
The client request scheme to match on.final String
The client request scheme to match on.static Class
<? extends HttpRouteMatch.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
hasHeaders
public final boolean hasHeaders()For responses, this returns true if the service returned a value for the Headers property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
headers
The client request headers to match on.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasHeaders()
method.- Returns:
- The client request headers to match on.
-
method
The client request method to match on. Specify only one.
If the service returns an enum value that is not available in the current SDK version,
method
will returnHttpMethod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommethodAsString()
.- Returns:
- The client request method to match on. Specify only one.
- See Also:
-
methodAsString
The client request method to match on. Specify only one.
If the service returns an enum value that is not available in the current SDK version,
method
will returnHttpMethod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommethodAsString()
.- Returns:
- The client request method to match on. Specify only one.
- See Also:
-
path
The client request path to match on.
- Returns:
- The client request path to match on.
-
port
The port number to match on.
- Returns:
- The port number to match on.
-
prefix
Specifies the path to match requests with. This parameter must always start with
/
, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name ismy-service.local
and you want the route to match requests tomy-service.local/metrics
, your prefix should be/metrics
.- Returns:
- Specifies the path to match requests with. This parameter must always start with
/
, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name ismy-service.local
and you want the route to match requests tomy-service.local/metrics
, your prefix should be/metrics
.
-
hasQueryParameters
public final boolean hasQueryParameters()For responses, this returns true if the service returned a value for the QueryParameters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
queryParameters
The client request query parameters to match on.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasQueryParameters()
method.- Returns:
- The client request query parameters to match on.
-
scheme
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
If the service returns an enum value that is not available in the current SDK version,
scheme
will returnHttpScheme.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromschemeAsString()
.- Returns:
- The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
- See Also:
-
schemeAsString
The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
If the service returns an enum value that is not available in the current SDK version,
scheme
will returnHttpScheme.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromschemeAsString()
.- Returns:
- The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<HttpRouteMatch.Builder,
HttpRouteMatch> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-