/* * 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 requirements for a route to match HTTP requests for a virtual router. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class HttpRouteMatch implements Serializable, Cloneable, StructuredPojo { /** ** The client request headers to match on. *
*/ private java.util.List* The client request method to match on. Specify only one. *
*/ private String method; /** ** The client request 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 client request query parameters to match on. *
*/ private java.util.List* The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes. *
*/ private String scheme; /** ** 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 HttpRouteMatch withHeaders(HttpRouteHeader... 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 HttpRouteMatch withHeaders(java.util.Collection* The client request method to match on. Specify only one. *
* * @param method * The client request method to match on. Specify only one. * @see HttpMethod */ public void setMethod(String method) { this.method = method; } /** ** The client request method to match on. Specify only one. *
* * @return The client request method to match on. Specify only one. * @see HttpMethod */ public String getMethod() { return this.method; } /** ** The client request method to match on. Specify only one. *
* * @param method * The client request method to match on. Specify only one. * @return Returns a reference to this object so that method calls can be chained together. * @see HttpMethod */ public HttpRouteMatch withMethod(String method) { setMethod(method); return this; } /** ** The client request method to match on. Specify only one. *
* * @param method * The client request method to match on. Specify only one. * @return Returns a reference to this object so that method calls can be chained together. * @see HttpMethod */ public HttpRouteMatch withMethod(HttpMethod method) { this.method = method.toString(); return this; } /** ** The client request path to match on. *
* * @param path * The client request path to match on. */ public void setPath(HttpPathMatch path) { this.path = path; } /** ** The client request path to match on. *
* * @return The client request path to match on. */ public HttpPathMatch getPath() { return this.path; } /** ** The client request path to match on. *
* * @param path * The client request path to match on. * @return Returns a reference to this object so that method calls can be chained together. */ public HttpRouteMatch 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 HttpRouteMatch 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 HttpRouteMatch withPrefix(String prefix) {
setPrefix(prefix);
return this;
}
/**
* * The client request query parameters to match on. *
* * @return The client request query parameters to match on. */ public java.util.List* The client request query parameters to match on. *
* * @param queryParameters * The client request query parameters to match on. */ public void setQueryParameters(java.util.Collection* The client request query parameters 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 client request query parameters to match on. * @return Returns a reference to this object so that method calls can be chained together. */ public HttpRouteMatch withQueryParameters(HttpQueryParameter... queryParameters) { if (this.queryParameters == null) { setQueryParameters(new java.util.ArrayList* The client request query parameters to match on. *
* * @param queryParameters * The client request query parameters to match on. * @return Returns a reference to this object so that method calls can be chained together. */ public HttpRouteMatch withQueryParameters(java.util.Collection* The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes. *
* * @param scheme * The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes. * @see HttpScheme */ public void setScheme(String scheme) { this.scheme = scheme; } /** ** The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes. *
* * @return The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes. * @see HttpScheme */ public String getScheme() { return this.scheme; } /** ** The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes. *
* * @param scheme * The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes. * @return Returns a reference to this object so that method calls can be chained together. * @see HttpScheme */ public HttpRouteMatch withScheme(String scheme) { setScheme(scheme); return this; } /** ** The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes. *
* * @param scheme * The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes. * @return Returns a reference to this object so that method calls can be chained together. * @see HttpScheme */ public HttpRouteMatch withScheme(HttpScheme scheme) { this.scheme = scheme.toString(); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getHeaders() != null) sb.append("Headers: ").append(getHeaders()).append(","); if (getMethod() != null) sb.append("Method: ").append(getMethod()).append(","); if (getPath() != null) sb.append("Path: ").append(getPath()).append(","); if (getPort() != null) sb.append("Port: ").append(getPort()).append(","); if (getPrefix() != null) sb.append("Prefix: ").append(getPrefix()).append(","); if (getQueryParameters() != null) sb.append("QueryParameters: ").append(getQueryParameters()).append(","); if (getScheme() != null) sb.append("Scheme: ").append(getScheme()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof HttpRouteMatch == false) return false; HttpRouteMatch other = (HttpRouteMatch) obj; if (other.getHeaders() == null ^ this.getHeaders() == null) return false; if (other.getHeaders() != null && other.getHeaders().equals(this.getHeaders()) == false) return false; if (other.getMethod() == null ^ this.getMethod() == null) return false; if (other.getMethod() != null && other.getMethod().equals(this.getMethod()) == false) return false; if (other.getPath() == null ^ this.getPath() == null) return false; if (other.getPath() != null && other.getPath().equals(this.getPath()) == false) return false; if (other.getPort() == null ^ this.getPort() == null) return false; if (other.getPort() != null && other.getPort().equals(this.getPort()) == false) return false; if (other.getPrefix() == null ^ this.getPrefix() == null) return false; if (other.getPrefix() != null && other.getPrefix().equals(this.getPrefix()) == false) return false; if (other.getQueryParameters() == null ^ this.getQueryParameters() == null) return false; if (other.getQueryParameters() != null && other.getQueryParameters().equals(this.getQueryParameters()) == false) return false; if (other.getScheme() == null ^ this.getScheme() == null) return false; if (other.getScheme() != null && other.getScheme().equals(this.getScheme()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getHeaders() == null) ? 0 : getHeaders().hashCode()); hashCode = prime * hashCode + ((getMethod() == null) ? 0 : getMethod().hashCode()); hashCode = prime * hashCode + ((getPath() == null) ? 0 : getPath().hashCode()); hashCode = prime * hashCode + ((getPort() == null) ? 0 : getPort().hashCode()); hashCode = prime * hashCode + ((getPrefix() == null) ? 0 : getPrefix().hashCode()); hashCode = prime * hashCode + ((getQueryParameters() == null) ? 0 : getQueryParameters().hashCode()); hashCode = prime * hashCode + ((getScheme() == null) ? 0 : getScheme().hashCode()); return hashCode; } @Override public HttpRouteMatch clone() { try { return (HttpRouteMatch) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.appmesh.model.transform.HttpRouteMatchMarshaller.getInstance().marshall(this, protocolMarshaller); } }