java.lang.Object
- software.amazon.awssdk.services.appmesh.model.HttpGatewayRouteMatch

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<HttpGatewayRouteMatch.Builder,HttpGatewayRouteMatch>
```
@Generated("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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface HttpGatewayRouteMatch.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static HttpGatewayRouteMatch.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<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.
`Integer`	`port()`	The port number 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()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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 the 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.
  - headers
```
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.
    
    Returns:
    
    The client request headers to match on.
  - hostname
```
public final GatewayRouteHostnameMatch hostname()
```
    The host name to match on.
    
    Returns:
    
    The host name to match on.
  - method
```
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().
    
    Returns:
    
    The method to match on.
    
    See Also:
    
    HttpMethod
  - methodAsString
```
public 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().
    
    Returns:
    
    The method to match on.
    
    See Also:
    
    HttpMethod
  - path
```
public final HttpPathMatch path()
```
    The path to match on.
    
    Returns:
    
    The path to match on.
  - port
```
public final Integer port()
```
    The port number to match on.
    
    Returns:
    
    The port number to match on.
  - prefix
```
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.
    
    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 is my-service.local and you want the route to match requests to my-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 the 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.
  - queryParameters
```
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.
    
    Returns:
    
    The query parameter to match on.
  - toBuilder
```
public HttpGatewayRouteMatch.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<HttpGatewayRouteMatch.Builder,HttpGatewayRouteMatch>
  - builder
```
public static HttpGatewayRouteMatch.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends HttpGatewayRouteMatch.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class HttpGatewayRouteMatch

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasHeaders

headers

hostname

method

methodAsString

path

port

prefix

hasQueryParameters

queryParameters

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields