HttpRouteMatch (AWS Java SDK :: Services

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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<HttpRouteMatch.Builder,HttpRouteMatch>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class HttpRouteMatch
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<HttpRouteMatch.Builder,HttpRouteMatch>
```
An object that represents the requirements for a route to match HTTP requests for a virtual router.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface HttpRouteMatch.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`HttpRouteMatch.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static HttpRouteMatch.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<HttpRouteHeader>`	`headers()` The client request headers to match on.
`HttpMethod`	`method()` The client request method to match on.
`String`	`methodAsString()` The client request method to match on.
`HttpPathMatch`	`path()` The client request 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 client request query parameters to match on.
`HttpScheme`	`scheme()` The client request scheme to match on.
`String`	`schemeAsString()` The client request scheme to match on.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends HttpRouteMatch.Builder>`	`serializableBuilderClass()`
`HttpRouteMatch.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<HttpRouteHeader> 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
```
public final HttpMethod 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 return HttpMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from methodAsString().
    
    Returns:
    
    The client request method to match on. Specify only one.
    
    See Also:
    
    HttpMethod
  - methodAsString
```
public final String 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 return HttpMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from methodAsString().
    
    Returns:
    
    The client request method to match on. Specify only one.
    
    See Also:
    
    HttpMethod
  - path
```
public final HttpPathMatch path()
```
    The client request path to match on.
    
    Returns:
    
    The client request 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 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
```
public final HttpScheme 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 return HttpScheme.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from schemeAsString().
    
    Returns:
    
    The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
    
    See Also:
    
    HttpScheme
  - schemeAsString
```
public final String 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 return HttpScheme.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from schemeAsString().
    
    Returns:
    
    The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
    
    See Also:
    
    HttpScheme
  - toBuilder
```
public HttpRouteMatch.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<HttpRouteMatch.Builder,HttpRouteMatch>
  - builder
```
public static HttpRouteMatch.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends HttpRouteMatch.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 HttpRouteMatch

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

method

methodAsString

path

port

prefix

hasQueryParameters

queryParameters

scheme

schemeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields