/* * 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.apigateway.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

* The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) * has. *

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class EndpointConfiguration implements Serializable, Cloneable, StructuredPojo { /** *

* A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API * and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain * name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE. *

*/ private java.util.List types; /** *

* A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for * PRIVATE endpoint type. *

*/ private java.util.List vpcEndpointIds; /** *

* A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API * and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain * name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE. *

* * @return A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an * edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional * API and its custom domain name, the endpoint type is REGIONAL. For a private API, the * endpoint type is PRIVATE. * @see EndpointType */ public java.util.List getTypes() { return types; } /** *

* A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API * and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain * name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE. *

* * @param types * A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized * API and its custom domain name, the endpoint type is "EDGE". For a regional API and its * custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is * PRIVATE. * @see EndpointType */ public void setTypes(java.util.Collection types) { if (types == null) { this.types = null; return; } this.types = new java.util.ArrayList(types); } /** *

* A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API * and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain * name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setTypes(java.util.Collection)} or {@link #withTypes(java.util.Collection)} if you want to override the * existing values. *

* * @param types * A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized * API and its custom domain name, the endpoint type is "EDGE". For a regional API and its * custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is * PRIVATE. * @return Returns a reference to this object so that method calls can be chained together. * @see EndpointType */ public EndpointConfiguration withTypes(String... types) { if (this.types == null) { setTypes(new java.util.ArrayList(types.length)); } for (String ele : types) { this.types.add(ele); } return this; } /** *

* A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API * and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain * name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE. *

* * @param types * A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized * API and its custom domain name, the endpoint type is "EDGE". For a regional API and its * custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is * PRIVATE. * @return Returns a reference to this object so that method calls can be chained together. * @see EndpointType */ public EndpointConfiguration withTypes(java.util.Collection types) { setTypes(types); return this; } /** *

* A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API * and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain * name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE. *

* * @param types * A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized * API and its custom domain name, the endpoint type is "EDGE". For a regional API and its * custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is * PRIVATE. * @return Returns a reference to this object so that method calls can be chained together. * @see EndpointType */ public EndpointConfiguration withTypes(EndpointType... types) { java.util.ArrayList typesCopy = new java.util.ArrayList(types.length); for (EndpointType value : types) { typesCopy.add(value.toString()); } if (getTypes() == null) { setTypes(typesCopy); } else { getTypes().addAll(typesCopy); } return this; } /** *

* A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for * PRIVATE endpoint type. *

* * @return A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only * supported for PRIVATE endpoint type. */ public java.util.List getVpcEndpointIds() { return vpcEndpointIds; } /** *

* A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for * PRIVATE endpoint type. *

* * @param vpcEndpointIds * A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported * for PRIVATE endpoint type. */ public void setVpcEndpointIds(java.util.Collection vpcEndpointIds) { if (vpcEndpointIds == null) { this.vpcEndpointIds = null; return; } this.vpcEndpointIds = new java.util.ArrayList(vpcEndpointIds); } /** *

* A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for * PRIVATE endpoint type. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setVpcEndpointIds(java.util.Collection)} or {@link #withVpcEndpointIds(java.util.Collection)} if you want * to override the existing values. *

* * @param vpcEndpointIds * A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported * for PRIVATE endpoint type. * @return Returns a reference to this object so that method calls can be chained together. */ public EndpointConfiguration withVpcEndpointIds(String... vpcEndpointIds) { if (this.vpcEndpointIds == null) { setVpcEndpointIds(new java.util.ArrayList(vpcEndpointIds.length)); } for (String ele : vpcEndpointIds) { this.vpcEndpointIds.add(ele); } return this; } /** *

* A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for * PRIVATE endpoint type. *

* * @param vpcEndpointIds * A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported * for PRIVATE endpoint type. * @return Returns a reference to this object so that method calls can be chained together. */ public EndpointConfiguration withVpcEndpointIds(java.util.Collection vpcEndpointIds) { setVpcEndpointIds(vpcEndpointIds); 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 (getTypes() != null) sb.append("Types: ").append(getTypes()).append(","); if (getVpcEndpointIds() != null) sb.append("VpcEndpointIds: ").append(getVpcEndpointIds()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof EndpointConfiguration == false) return false; EndpointConfiguration other = (EndpointConfiguration) obj; if (other.getTypes() == null ^ this.getTypes() == null) return false; if (other.getTypes() != null && other.getTypes().equals(this.getTypes()) == false) return false; if (other.getVpcEndpointIds() == null ^ this.getVpcEndpointIds() == null) return false; if (other.getVpcEndpointIds() != null && other.getVpcEndpointIds().equals(this.getVpcEndpointIds()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getTypes() == null) ? 0 : getTypes().hashCode()); hashCode = prime * hashCode + ((getVpcEndpointIds() == null) ? 0 : getVpcEndpointIds().hashCode()); return hashCode; } @Override public EndpointConfiguration clone() { try { return (EndpointConfiguration) 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.apigateway.model.transform.EndpointConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller); } }