HttpRouteMatch (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class HttpRouteMatch
extends Object
implements Serializable, Cloneable, StructuredPojo
```
An object that represents the requirements for a route to match HTTP requests for a virtual router.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

HttpRouteMatch()

Constructors
Constructor and Description
`HttpRouteMatch()`

Method Summary

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

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

- Constructor Detail
  - HttpRouteMatch
```
public HttpRouteMatch()
```
- Method Detail
  - getHeaders
```
public List<HttpRouteHeader> getHeaders()
```
    The client request headers to match on.
    
    Returns:
    
    The client request headers to match on.
  - setHeaders
```
public void setHeaders(Collection<HttpRouteHeader> headers)
```
    The client request headers to match on.
    
    Parameters:
    
    headers - The client request headers to match on.
  - withHeaders
```
public HttpRouteMatch withHeaders(HttpRouteHeader... 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 HttpRouteMatch withHeaders(Collection<HttpRouteHeader> 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.
  - setMethod
```
public void setMethod(String method)
```
    The client request method to match on. Specify only one.
    
    Parameters:
    
    method - The client request method to match on. Specify only one.
    
    See Also:
    
    HttpMethod
  - getMethod
```
public String getMethod()
```
    The client request method to match on. Specify only one.
    
    Returns:
    
    The client request method to match on. Specify only one.
    
    See Also:
    
    HttpMethod
  - withMethod
```
public HttpRouteMatch withMethod(String method)
```
    The client request method to match on. Specify only one.
    
    Parameters:
    
    method - The client request method to match on. Specify only one.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HttpMethod
  - withMethod
```
public HttpRouteMatch withMethod(HttpMethod method)
```
    The client request method to match on. Specify only one.
    
    Parameters:
    
    method - The client request method to match on. Specify only one.
    
    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 client request path to match on.
    
    Parameters:
    
    path - The client request path to match on.
  - getPath
```
public HttpPathMatch getPath()
```
    The client request path to match on.
    
    Returns:
    
    The client request path to match on.
  - withPath
```
public HttpRouteMatch withPath(HttpPathMatch path)
```
    The client request path to match on.
    
    Parameters:
    
    path - The client request 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 HttpRouteMatch 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 client request query parameters to match on.
    
    Returns:
    
    The client request query parameters to match on.
  - setQueryParameters
```
public void setQueryParameters(Collection<HttpQueryParameter> queryParameters)
```
    The client request query parameters to match on.
    
    Parameters:
    
    queryParameters - The client request query parameters to match on.
  - withQueryParameters
```
public HttpRouteMatch withQueryParameters(HttpQueryParameter... queryParameters)
```
    The client request query parameters 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 client request query parameters to match on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withQueryParameters
```
public HttpRouteMatch withQueryParameters(Collection<HttpQueryParameter> queryParameters)
```
    The client request query parameters to match on.
    
    Parameters:
    
    queryParameters - The client request query parameters to match on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setScheme
```
public void setScheme(String scheme)
```
    The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
    
    Parameters:
    
    scheme - The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
    
    See Also:
    
    HttpScheme
  - getScheme
```
public String getScheme()
```
    The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
    
    Returns:
    
    The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
    
    See Also:
    
    HttpScheme
  - withScheme
```
public HttpRouteMatch withScheme(String scheme)
```
    The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
    
    Parameters:
    
    scheme - The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HttpScheme
  - withScheme
```
public HttpRouteMatch withScheme(HttpScheme scheme)
```
    The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
    
    Parameters:
    
    scheme - The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    HttpScheme
  - 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 HttpRouteMatch 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 HttpRouteMatch

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpRouteMatch

Method Detail

getHeaders

setHeaders

withHeaders

withHeaders

setMethod

getMethod

withMethod

withMethod

setPath

getPath

withPath

setPrefix

getPrefix

withPrefix

getQueryParameters

setQueryParameters

withQueryParameters

withQueryParameters

setScheme

getScheme

withScheme

withScheme

toString

equals

hashCode

clone

marshall