HttpGatewayRouteMatch (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.appmesh.model.HttpGatewayRouteMatch

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class HttpGatewayRouteMatch
extends Object
implements Serializable, Cloneable, StructuredPojo
```
An object that represents the criteria for determining a request match.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

HttpGatewayRouteMatch()

Constructors
Constructor and Description
`HttpGatewayRouteMatch()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpGatewayRouteMatch`	`clone()`
`boolean`	`equals(Object obj)`
`List<HttpGatewayRouteHeader>`	`getHeaders()` The client request headers to match on.
`GatewayRouteHostnameMatch`	`getHostname()` The host name to match on.
`String`	`getMethod()` The method to match on.
`HttpPathMatch`	`getPath()` The path to match on.
`String`	`getPrefix()` Specifies the path to match requests with.
`List<HttpQueryParameter>`	`getQueryParameters()` The query parameter to match on.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setHeaders(Collection<HttpGatewayRouteHeader> headers)` The client request headers to match on.
`void`	`setHostname(GatewayRouteHostnameMatch hostname)` The host name to match on.
`void`	`setMethod(String method)` The method to match on.
`void`	`setPath(HttpPathMatch path)` The path to match on.
`void`	`setPrefix(String prefix)` Specifies the path to match requests with.
`void`	`setQueryParameters(Collection<HttpQueryParameter> queryParameters)` The query parameter to match on.
`String`	`toString()` Returns a string representation of this object.
`HttpGatewayRouteMatch`	`withHeaders(Collection<HttpGatewayRouteHeader> headers)` The client request headers to match on.
`HttpGatewayRouteMatch`	`withHeaders(HttpGatewayRouteHeader... headers)` The client request headers to match on.
`HttpGatewayRouteMatch`	`withHostname(GatewayRouteHostnameMatch hostname)` The host name to match on.
`HttpGatewayRouteMatch`	`withMethod(HttpMethod method)` The method to match on.
`HttpGatewayRouteMatch`	`withMethod(String method)` The method to match on.
`HttpGatewayRouteMatch`	`withPath(HttpPathMatch path)` The path to match on.
`HttpGatewayRouteMatch`	`withPrefix(String prefix)` Specifies the path to match requests with.
`HttpGatewayRouteMatch`	`withQueryParameters(Collection<HttpQueryParameter> queryParameters)` The query parameter to match on.
`HttpGatewayRouteMatch`	`withQueryParameters(HttpQueryParameter... queryParameters)` The query parameter to match on.

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

- Constructor Detail
  - HttpGatewayRouteMatch
```
public HttpGatewayRouteMatch()
```
- Method Detail
  - getHeaders
```
public List<HttpGatewayRouteHeader> getHeaders()
```
    The client request headers to match on.
    
    Returns:
    
    The client request headers to match on.
  - setHeaders
```
public void setHeaders(Collection<HttpGatewayRouteHeader> headers)
```
    The client request headers to match on.
    
    Parameters:
    
    headers - The client request headers to match on.
  - withHeaders
```
public HttpGatewayRouteMatch withHeaders(HttpGatewayRouteHeader... headers)
```
    The client request headers to match on.
    
    NOTE: This method appends the values to the existing list (if any). Use setHeaders(java.util.Collection) or withHeaders(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    headers - The client request headers to match on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withHeaders
```
public HttpGatewayRouteMatch withHeaders(Collection<HttpGatewayRouteHeader> headers)
```
    The client request headers to match on.
    
    Parameters:
    
    headers - The client request headers to match on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHostname
```
public void setHostname(GatewayRouteHostnameMatch hostname)
```
    The host name to match on.
    
    Parameters:
    
    hostname - The host name to match on.
  - getHostname
```
public GatewayRouteHostnameMatch getHostname()
```
    The host name to match on.
    
    Returns:
    
    The host name to match on.
  - withHostname
```
public HttpGatewayRouteMatch withHostname(GatewayRouteHostnameMatch hostname)
```
    The host name to match on.
    
    Parameters:
    
    hostname - The host name to match on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMethod
```
public void setMethod(String method)
```
    The method to match on.
    
    Parameters:
    
    method - The method to match on.
    
    See Also:
    
    HttpMethod
  - getMethod
```
public String getMethod()
```
    The method to match on.
    
    Returns:
    
    The method to match on.
    
    See Also:
    
    HttpMethod
  - withMethod
```
public HttpGatewayRouteMatch withMethod(String method)
```
    The method to match on.
    
    Parameters:
    
    method - The method to match on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HttpMethod
  - withMethod
```
public HttpGatewayRouteMatch withMethod(HttpMethod method)
```
    The method to match on.
    
    Parameters:
    
    method - The method to match on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HttpMethod
  - setPath
```
public void setPath(HttpPathMatch path)
```
    The path to match on.
    
    Parameters:
    
    path - The path to match on.
  - getPath
```
public HttpPathMatch getPath()
```
    The path to match on.
    
    Returns:
    
    The path to match on.
  - withPath
```
public HttpGatewayRouteMatch withPath(HttpPathMatch path)
```
    The path to match on.
    
    Parameters:
    
    path - The path to match on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPrefix
```
public void setPrefix(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.
    
    Parameters:
    
    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.
  - getPrefix
```
public String getPrefix()
```
    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.
  - withPrefix
```
public HttpGatewayRouteMatch withPrefix(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getQueryParameters
```
public List<HttpQueryParameter> getQueryParameters()
```
    The query parameter to match on.
    
    Returns:
    
    The query parameter to match on.
  - setQueryParameters
```
public void setQueryParameters(Collection<HttpQueryParameter> queryParameters)
```
    The query parameter to match on.
    
    Parameters:
    
    queryParameters - The query parameter to match on.
  - withQueryParameters
```
public HttpGatewayRouteMatch withQueryParameters(HttpQueryParameter... queryParameters)
```
    The query parameter to match on.
    
    NOTE: This method appends the values to the existing list (if any). Use setQueryParameters(java.util.Collection) or withQueryParameters(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    queryParameters - The query parameter to match on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withQueryParameters
```
public HttpGatewayRouteMatch withQueryParameters(Collection<HttpQueryParameter> queryParameters)
```
    The query parameter to match on.
    
    Parameters:
    
    queryParameters - The query parameter to match on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public HttpGatewayRouteMatch clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class HttpGatewayRouteMatch

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpGatewayRouteMatch

Method Detail

getHeaders

setHeaders

withHeaders

withHeaders

setHostname

getHostname

withHostname

setMethod

getMethod

withMethod

withMethod

setPath

getPath

withPath

setPrefix

getPrefix

withPrefix

getQueryParameters

setQueryParameters

withQueryParameters

withQueryParameters

toString

equals

hashCode

clone

marshall