HttpGatewayRouteMatch (AWS SDK for Java

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

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<HttpGatewayRouteMatch.Builder,HttpGatewayRouteMatch>

@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.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface HttpGatewayRouteMatch.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()` Returns true if the Headers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasQueryParameters()` Returns true if the QueryParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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.

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

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

- Method Detail
  - hasHeaders
```
public final boolean hasHeaders()
```
    Returns true if the Headers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasHeaders() to see if a value was sent in this field.
    
    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.
  - 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()
```
    Returns true if the QueryParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasQueryParameters() to see if a value was sent in this field.
    
    Returns:
    
    The query parameter to match on.
  - toBuilder
```
public HttpGatewayRouteMatch.Builder 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 interface ToCopyableBuilder<HttpGatewayRouteMatch.Builder,HttpGatewayRouteMatch>
    
    Returns:
    
    a builder for type T
  - 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)
```
    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 an SdkPojo 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.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.16.83

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

prefix

hasQueryParameters

queryParameters

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields