@Generated(value="software.amazon.awssdk:codegen") public final class HttpGatewayRouteMatch extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HttpGatewayRouteMatch.Builder,HttpGatewayRouteMatch>
An object that represents the criteria for determining a request match.
| Modifier and Type | Class and Description |
|---|---|
static interface |
HttpGatewayRouteMatch.Builder |
| Modifier and Type | Method and Description |
|---|---|
static HttpGatewayRouteMatch.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasHeaders()
For responses, this returns true if the service returned a value for the Headers property.
|
boolean |
hasQueryParameters()
For responses, this returns true if the service returned a value for the QueryParameters property.
|
List<HttpGatewayRouteHeader> |
headers()
The client request headers to match on.
|
GatewayRouteHostnameMatch |
hostname()
The host name to match on.
|
HttpMethod |
method()
The method to match on.
|
String |
methodAsString()
The method to match on.
|
HttpPathMatch |
path()
The path to match on.
|
String |
prefix()
Specifies the path to match requests with.
|
List<HttpQueryParameter> |
queryParameters()
The query parameter to match on.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends HttpGatewayRouteMatch.Builder> |
serializableBuilderClass() |
HttpGatewayRouteMatch.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
copypublic final boolean hasHeaders()
isEmpty() 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.public final List<HttpGatewayRouteHeader> 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.
public final GatewayRouteHostnameMatch hostname()
The host name to match on.
public final HttpMethod method()
The method to match on.
If the service returns an enum value that is not available in the current SDK version, method will
return HttpMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
methodAsString().
HttpMethodpublic final String methodAsString()
The method to match on.
If the service returns an enum value that is not available in the current SDK version, method will
return HttpMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
methodAsString().
HttpMethodpublic final HttpPathMatch path()
The path to match on.
public final String 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 is my-service.local and you want the route to match requests
to my-service.local/metrics, your prefix should be /metrics.
/, 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 is my-service.local and you want the
route to match requests to my-service.local/metrics, your prefix should be
/metrics.public final boolean hasQueryParameters()
isEmpty() 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.public final List<HttpQueryParameter> queryParameters()
The query parameter 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.
public HttpGatewayRouteMatch.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<HttpGatewayRouteMatch.Builder,HttpGatewayRouteMatch>public static HttpGatewayRouteMatch.Builder builder()
public static Class<? extends HttpGatewayRouteMatch.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()