/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.appmesh.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* An object that represents the criteria for determining a request match. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class HttpGatewayRouteMatch implements Serializable, Cloneable, StructuredPojo { /** ** The client request headers to match on. *
*/ private java.util.List* The host name to match on. *
*/ private GatewayRouteHostnameMatch hostname; /** ** The method to match on. *
*/ private String method; /** ** The path to match on. *
*/ private HttpPathMatch path; /** ** The port number to match on. *
*/ private Integer port; /** *
* 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
.
*
* The query parameter to match on. *
*/ private java.util.List* The client request headers to match on. *
* * @return The client request headers to match on. */ public java.util.List* The client request headers to match on. *
* * @param headers * The client request headers to match on. */ public void setHeaders(java.util.Collection* The client request headers to match on. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setHeaders(java.util.Collection)} or {@link #withHeaders(java.util.Collection)} if you want to override * the existing values. *
* * @param headers * The client request headers to match on. * @return Returns a reference to this object so that method calls can be chained together. */ public HttpGatewayRouteMatch withHeaders(HttpGatewayRouteHeader... headers) { if (this.headers == null) { setHeaders(new java.util.ArrayList* The client request headers to match on. *
* * @param headers * The client request headers to match on. * @return Returns a reference to this object so that method calls can be chained together. */ public HttpGatewayRouteMatch withHeaders(java.util.Collection* The host name to match on. *
* * @param hostname * The host name to match on. */ public void setHostname(GatewayRouteHostnameMatch hostname) { this.hostname = hostname; } /** ** The host name to match on. *
* * @return The host name to match on. */ public GatewayRouteHostnameMatch getHostname() { return this.hostname; } /** ** The host name to match on. *
* * @param hostname * The host name to match on. * @return Returns a reference to this object so that method calls can be chained together. */ public HttpGatewayRouteMatch withHostname(GatewayRouteHostnameMatch hostname) { setHostname(hostname); return this; } /** ** The method to match on. *
* * @param method * The method to match on. * @see HttpMethod */ public void setMethod(String method) { this.method = method; } /** ** The method to match on. *
* * @return The method to match on. * @see HttpMethod */ public String getMethod() { return this.method; } /** ** The method to match on. *
* * @param method * The method to match on. * @return Returns a reference to this object so that method calls can be chained together. * @see HttpMethod */ public HttpGatewayRouteMatch withMethod(String method) { setMethod(method); return this; } /** ** The method to match on. *
* * @param method * The method to match on. * @return Returns a reference to this object so that method calls can be chained together. * @see HttpMethod */ public HttpGatewayRouteMatch withMethod(HttpMethod method) { this.method = method.toString(); return this; } /** ** The path to match on. *
* * @param path * The path to match on. */ public void setPath(HttpPathMatch path) { this.path = path; } /** ** The path to match on. *
* * @return The path to match on. */ public HttpPathMatch getPath() { return this.path; } /** ** The path to match on. *
* * @param path * The path to match on. * @return Returns a reference to this object so that method calls can be chained together. */ public HttpGatewayRouteMatch withPath(HttpPathMatch path) { setPath(path); return this; } /** ** The port number to match on. *
* * @param port * The port number to match on. */ public void setPort(Integer port) { this.port = port; } /** ** The port number to match on. *
* * @return The port number to match on. */ public Integer getPort() { return this.port; } /** ** The port number to match on. *
* * @param port * The port number to match on. * @return Returns a reference to this object so that method calls can be chained together. */ public HttpGatewayRouteMatch withPort(Integer port) { setPort(port); return this; } /** *
* 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
.
*
/
, 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
.
*/
public void setPrefix(String prefix) {
this.prefix = 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
.
*
/
, 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
.
*/
public String getPrefix() {
return this.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
.
*
/
, 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
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HttpGatewayRouteMatch withPrefix(String prefix) {
setPrefix(prefix);
return this;
}
/**
* * The query parameter to match on. *
* * @return The query parameter to match on. */ public java.util.List* The query parameter to match on. *
* * @param queryParameters * The query parameter to match on. */ public void setQueryParameters(java.util.Collection* The query parameter to match on. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setQueryParameters(java.util.Collection)} or {@link #withQueryParameters(java.util.Collection)} if you * want to override the existing values. *
* * @param queryParameters * The query parameter to match on. * @return Returns a reference to this object so that method calls can be chained together. */ public HttpGatewayRouteMatch withQueryParameters(HttpQueryParameter... queryParameters) { if (this.queryParameters == null) { setQueryParameters(new java.util.ArrayList* The query parameter to match on. *
* * @param queryParameters * The query parameter to match on. * @return Returns a reference to this object so that method calls can be chained together. */ public HttpGatewayRouteMatch withQueryParameters(java.util.Collection