All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.rds.model.DBProxyEndpoint Maven / Gradle / Ivy

Go to download

The AWS Java SDK for Amazon RDS module holds the client classes that are used for communicating with Amazon Relational Database Service

There is a newer version: 1.12.780
Show newest version
/*
 * Copyright 2016-2021 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.rds.model;

import java.io.Serializable;
import javax.annotation.Generated;

/**
 * 

* The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one endpoint for * each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same DB proxy. These endpoints * can be read/write or read-only. They can also reside in different VPCs than the associated DB proxy. *

*

* This data type is used as a response element in the DescribeDBProxyEndpoints operation. *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DBProxyEndpoint implements Serializable, Cloneable { /** *

* The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, * digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens. *

*/ private String dBProxyEndpointName; /** *

* The Amazon Resource Name (ARN) for the DB proxy endpoint. *

*/ private String dBProxyEndpointArn; /** *

* The identifier for the DB proxy that is associated with this DB proxy endpoint. *

*/ private String dBProxyName; /** *

* The current status of this DB proxy endpoint. A status of available means the endpoint is ready to * handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to * resolve an issue. *

*/ private String status; /** *

* Provides the VPC ID of the DB proxy endpoint. *

*/ private String vpcId; /** *

* Provides a list of VPC security groups that the DB proxy endpoint belongs to. *

*/ private com.amazonaws.internal.SdkInternalList vpcSecurityGroupIds; /** *

* The EC2 subnet IDs for the DB proxy endpoint. *

*/ private com.amazonaws.internal.SdkInternalList vpcSubnetIds; /** *

* The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string * for a database client application. *

*/ private String endpoint; /** *

* The date and time when the DB proxy endpoint was first created. *

*/ private java.util.Date createdDate; /** *

* A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. *

*/ private String targetRole; /** *

* A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB * proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be * either read/write or read-only. *

*/ private Boolean isDefault; /** *

* The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, * digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens. *

* * @param dBProxyEndpointName * The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII * letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens. */ public void setDBProxyEndpointName(String dBProxyEndpointName) { this.dBProxyEndpointName = dBProxyEndpointName; } /** *

* The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, * digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens. *

* * @return The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII * letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens. */ public String getDBProxyEndpointName() { return this.dBProxyEndpointName; } /** *

* The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, * digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens. *

* * @param dBProxyEndpointName * The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII * letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens. * @return Returns a reference to this object so that method calls can be chained together. */ public DBProxyEndpoint withDBProxyEndpointName(String dBProxyEndpointName) { setDBProxyEndpointName(dBProxyEndpointName); return this; } /** *

* The Amazon Resource Name (ARN) for the DB proxy endpoint. *

* * @param dBProxyEndpointArn * The Amazon Resource Name (ARN) for the DB proxy endpoint. */ public void setDBProxyEndpointArn(String dBProxyEndpointArn) { this.dBProxyEndpointArn = dBProxyEndpointArn; } /** *

* The Amazon Resource Name (ARN) for the DB proxy endpoint. *

* * @return The Amazon Resource Name (ARN) for the DB proxy endpoint. */ public String getDBProxyEndpointArn() { return this.dBProxyEndpointArn; } /** *

* The Amazon Resource Name (ARN) for the DB proxy endpoint. *

* * @param dBProxyEndpointArn * The Amazon Resource Name (ARN) for the DB proxy endpoint. * @return Returns a reference to this object so that method calls can be chained together. */ public DBProxyEndpoint withDBProxyEndpointArn(String dBProxyEndpointArn) { setDBProxyEndpointArn(dBProxyEndpointArn); return this; } /** *

* The identifier for the DB proxy that is associated with this DB proxy endpoint. *

* * @param dBProxyName * The identifier for the DB proxy that is associated with this DB proxy endpoint. */ public void setDBProxyName(String dBProxyName) { this.dBProxyName = dBProxyName; } /** *

* The identifier for the DB proxy that is associated with this DB proxy endpoint. *

* * @return The identifier for the DB proxy that is associated with this DB proxy endpoint. */ public String getDBProxyName() { return this.dBProxyName; } /** *

* The identifier for the DB proxy that is associated with this DB proxy endpoint. *

* * @param dBProxyName * The identifier for the DB proxy that is associated with this DB proxy endpoint. * @return Returns a reference to this object so that method calls can be chained together. */ public DBProxyEndpoint withDBProxyName(String dBProxyName) { setDBProxyName(dBProxyName); return this; } /** *

* The current status of this DB proxy endpoint. A status of available means the endpoint is ready to * handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to * resolve an issue. *

* * @param status * The current status of this DB proxy endpoint. A status of available means the endpoint is * ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take * some action to resolve an issue. * @see DBProxyEndpointStatus */ public void setStatus(String status) { this.status = status; } /** *

* The current status of this DB proxy endpoint. A status of available means the endpoint is ready to * handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to * resolve an issue. *

* * @return The current status of this DB proxy endpoint. A status of available means the endpoint is * ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take * some action to resolve an issue. * @see DBProxyEndpointStatus */ public String getStatus() { return this.status; } /** *

* The current status of this DB proxy endpoint. A status of available means the endpoint is ready to * handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to * resolve an issue. *

* * @param status * The current status of this DB proxy endpoint. A status of available means the endpoint is * ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take * some action to resolve an issue. * @return Returns a reference to this object so that method calls can be chained together. * @see DBProxyEndpointStatus */ public DBProxyEndpoint withStatus(String status) { setStatus(status); return this; } /** *

* The current status of this DB proxy endpoint. A status of available means the endpoint is ready to * handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to * resolve an issue. *

* * @param status * The current status of this DB proxy endpoint. A status of available means the endpoint is * ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take * some action to resolve an issue. * @return Returns a reference to this object so that method calls can be chained together. * @see DBProxyEndpointStatus */ public DBProxyEndpoint withStatus(DBProxyEndpointStatus status) { this.status = status.toString(); return this; } /** *

* Provides the VPC ID of the DB proxy endpoint. *

* * @param vpcId * Provides the VPC ID of the DB proxy endpoint. */ public void setVpcId(String vpcId) { this.vpcId = vpcId; } /** *

* Provides the VPC ID of the DB proxy endpoint. *

* * @return Provides the VPC ID of the DB proxy endpoint. */ public String getVpcId() { return this.vpcId; } /** *

* Provides the VPC ID of the DB proxy endpoint. *

* * @param vpcId * Provides the VPC ID of the DB proxy endpoint. * @return Returns a reference to this object so that method calls can be chained together. */ public DBProxyEndpoint withVpcId(String vpcId) { setVpcId(vpcId); return this; } /** *

* Provides a list of VPC security groups that the DB proxy endpoint belongs to. *

* * @return Provides a list of VPC security groups that the DB proxy endpoint belongs to. */ public java.util.List getVpcSecurityGroupIds() { if (vpcSecurityGroupIds == null) { vpcSecurityGroupIds = new com.amazonaws.internal.SdkInternalList(); } return vpcSecurityGroupIds; } /** *

* Provides a list of VPC security groups that the DB proxy endpoint belongs to. *

* * @param vpcSecurityGroupIds * Provides a list of VPC security groups that the DB proxy endpoint belongs to. */ public void setVpcSecurityGroupIds(java.util.Collection vpcSecurityGroupIds) { if (vpcSecurityGroupIds == null) { this.vpcSecurityGroupIds = null; return; } this.vpcSecurityGroupIds = new com.amazonaws.internal.SdkInternalList(vpcSecurityGroupIds); } /** *

* Provides a list of VPC security groups that the DB proxy endpoint belongs to. *

*

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

* * @param vpcSecurityGroupIds * Provides a list of VPC security groups that the DB proxy endpoint belongs to. * @return Returns a reference to this object so that method calls can be chained together. */ public DBProxyEndpoint withVpcSecurityGroupIds(String... vpcSecurityGroupIds) { if (this.vpcSecurityGroupIds == null) { setVpcSecurityGroupIds(new com.amazonaws.internal.SdkInternalList(vpcSecurityGroupIds.length)); } for (String ele : vpcSecurityGroupIds) { this.vpcSecurityGroupIds.add(ele); } return this; } /** *

* Provides a list of VPC security groups that the DB proxy endpoint belongs to. *

* * @param vpcSecurityGroupIds * Provides a list of VPC security groups that the DB proxy endpoint belongs to. * @return Returns a reference to this object so that method calls can be chained together. */ public DBProxyEndpoint withVpcSecurityGroupIds(java.util.Collection vpcSecurityGroupIds) { setVpcSecurityGroupIds(vpcSecurityGroupIds); return this; } /** *

* The EC2 subnet IDs for the DB proxy endpoint. *

* * @return The EC2 subnet IDs for the DB proxy endpoint. */ public java.util.List getVpcSubnetIds() { if (vpcSubnetIds == null) { vpcSubnetIds = new com.amazonaws.internal.SdkInternalList(); } return vpcSubnetIds; } /** *

* The EC2 subnet IDs for the DB proxy endpoint. *

* * @param vpcSubnetIds * The EC2 subnet IDs for the DB proxy endpoint. */ public void setVpcSubnetIds(java.util.Collection vpcSubnetIds) { if (vpcSubnetIds == null) { this.vpcSubnetIds = null; return; } this.vpcSubnetIds = new com.amazonaws.internal.SdkInternalList(vpcSubnetIds); } /** *

* The EC2 subnet IDs for the DB proxy endpoint. *

*

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

* * @param vpcSubnetIds * The EC2 subnet IDs for the DB proxy endpoint. * @return Returns a reference to this object so that method calls can be chained together. */ public DBProxyEndpoint withVpcSubnetIds(String... vpcSubnetIds) { if (this.vpcSubnetIds == null) { setVpcSubnetIds(new com.amazonaws.internal.SdkInternalList(vpcSubnetIds.length)); } for (String ele : vpcSubnetIds) { this.vpcSubnetIds.add(ele); } return this; } /** *

* The EC2 subnet IDs for the DB proxy endpoint. *

* * @param vpcSubnetIds * The EC2 subnet IDs for the DB proxy endpoint. * @return Returns a reference to this object so that method calls can be chained together. */ public DBProxyEndpoint withVpcSubnetIds(java.util.Collection vpcSubnetIds) { setVpcSubnetIds(vpcSubnetIds); return this; } /** *

* The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string * for a database client application. *

* * @param endpoint * The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection * string for a database client application. */ public void setEndpoint(String endpoint) { this.endpoint = endpoint; } /** *

* The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string * for a database client application. *

* * @return The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the * connection string for a database client application. */ public String getEndpoint() { return this.endpoint; } /** *

* The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string * for a database client application. *

* * @param endpoint * The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection * string for a database client application. * @return Returns a reference to this object so that method calls can be chained together. */ public DBProxyEndpoint withEndpoint(String endpoint) { setEndpoint(endpoint); return this; } /** *

* The date and time when the DB proxy endpoint was first created. *

* * @param createdDate * The date and time when the DB proxy endpoint was first created. */ public void setCreatedDate(java.util.Date createdDate) { this.createdDate = createdDate; } /** *

* The date and time when the DB proxy endpoint was first created. *

* * @return The date and time when the DB proxy endpoint was first created. */ public java.util.Date getCreatedDate() { return this.createdDate; } /** *

* The date and time when the DB proxy endpoint was first created. *

* * @param createdDate * The date and time when the DB proxy endpoint was first created. * @return Returns a reference to this object so that method calls can be chained together. */ public DBProxyEndpoint withCreatedDate(java.util.Date createdDate) { setCreatedDate(createdDate); return this; } /** *

* A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. *

* * @param targetRole * A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. * @see DBProxyEndpointTargetRole */ public void setTargetRole(String targetRole) { this.targetRole = targetRole; } /** *

* A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. *

* * @return A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. * @see DBProxyEndpointTargetRole */ public String getTargetRole() { return this.targetRole; } /** *

* A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. *

* * @param targetRole * A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. * @return Returns a reference to this object so that method calls can be chained together. * @see DBProxyEndpointTargetRole */ public DBProxyEndpoint withTargetRole(String targetRole) { setTargetRole(targetRole); return this; } /** *

* A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. *

* * @param targetRole * A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. * @return Returns a reference to this object so that method calls can be chained together. * @see DBProxyEndpointTargetRole */ public DBProxyEndpoint withTargetRole(DBProxyEndpointTargetRole targetRole) { this.targetRole = targetRole.toString(); return this; } /** *

* A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB * proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be * either read/write or read-only. *

* * @param isDefault * A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default * DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy * can be either read/write or read-only. */ public void setIsDefault(Boolean isDefault) { this.isDefault = isDefault; } /** *

* A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB * proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be * either read/write or read-only. *

* * @return A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default * DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB * proxy can be either read/write or read-only. */ public Boolean getIsDefault() { return this.isDefault; } /** *

* A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB * proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be * either read/write or read-only. *

* * @param isDefault * A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default * DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy * can be either read/write or read-only. * @return Returns a reference to this object so that method calls can be chained together. */ public DBProxyEndpoint withIsDefault(Boolean isDefault) { setIsDefault(isDefault); return this; } /** *

* A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB * proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be * either read/write or read-only. *

* * @return A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default * DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB * proxy can be either read/write or read-only. */ public Boolean isDefault() { return this.isDefault; } /** * 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 (getDBProxyEndpointName() != null) sb.append("DBProxyEndpointName: ").append(getDBProxyEndpointName()).append(","); if (getDBProxyEndpointArn() != null) sb.append("DBProxyEndpointArn: ").append(getDBProxyEndpointArn()).append(","); if (getDBProxyName() != null) sb.append("DBProxyName: ").append(getDBProxyName()).append(","); if (getStatus() != null) sb.append("Status: ").append(getStatus()).append(","); if (getVpcId() != null) sb.append("VpcId: ").append(getVpcId()).append(","); if (getVpcSecurityGroupIds() != null) sb.append("VpcSecurityGroupIds: ").append(getVpcSecurityGroupIds()).append(","); if (getVpcSubnetIds() != null) sb.append("VpcSubnetIds: ").append(getVpcSubnetIds()).append(","); if (getEndpoint() != null) sb.append("Endpoint: ").append(getEndpoint()).append(","); if (getCreatedDate() != null) sb.append("CreatedDate: ").append(getCreatedDate()).append(","); if (getTargetRole() != null) sb.append("TargetRole: ").append(getTargetRole()).append(","); if (getIsDefault() != null) sb.append("IsDefault: ").append(getIsDefault()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DBProxyEndpoint == false) return false; DBProxyEndpoint other = (DBProxyEndpoint) obj; if (other.getDBProxyEndpointName() == null ^ this.getDBProxyEndpointName() == null) return false; if (other.getDBProxyEndpointName() != null && other.getDBProxyEndpointName().equals(this.getDBProxyEndpointName()) == false) return false; if (other.getDBProxyEndpointArn() == null ^ this.getDBProxyEndpointArn() == null) return false; if (other.getDBProxyEndpointArn() != null && other.getDBProxyEndpointArn().equals(this.getDBProxyEndpointArn()) == false) return false; if (other.getDBProxyName() == null ^ this.getDBProxyName() == null) return false; if (other.getDBProxyName() != null && other.getDBProxyName().equals(this.getDBProxyName()) == false) return false; if (other.getStatus() == null ^ this.getStatus() == null) return false; if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false) return false; if (other.getVpcId() == null ^ this.getVpcId() == null) return false; if (other.getVpcId() != null && other.getVpcId().equals(this.getVpcId()) == false) return false; if (other.getVpcSecurityGroupIds() == null ^ this.getVpcSecurityGroupIds() == null) return false; if (other.getVpcSecurityGroupIds() != null && other.getVpcSecurityGroupIds().equals(this.getVpcSecurityGroupIds()) == false) return false; if (other.getVpcSubnetIds() == null ^ this.getVpcSubnetIds() == null) return false; if (other.getVpcSubnetIds() != null && other.getVpcSubnetIds().equals(this.getVpcSubnetIds()) == false) return false; if (other.getEndpoint() == null ^ this.getEndpoint() == null) return false; if (other.getEndpoint() != null && other.getEndpoint().equals(this.getEndpoint()) == false) return false; if (other.getCreatedDate() == null ^ this.getCreatedDate() == null) return false; if (other.getCreatedDate() != null && other.getCreatedDate().equals(this.getCreatedDate()) == false) return false; if (other.getTargetRole() == null ^ this.getTargetRole() == null) return false; if (other.getTargetRole() != null && other.getTargetRole().equals(this.getTargetRole()) == false) return false; if (other.getIsDefault() == null ^ this.getIsDefault() == null) return false; if (other.getIsDefault() != null && other.getIsDefault().equals(this.getIsDefault()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getDBProxyEndpointName() == null) ? 0 : getDBProxyEndpointName().hashCode()); hashCode = prime * hashCode + ((getDBProxyEndpointArn() == null) ? 0 : getDBProxyEndpointArn().hashCode()); hashCode = prime * hashCode + ((getDBProxyName() == null) ? 0 : getDBProxyName().hashCode()); hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode()); hashCode = prime * hashCode + ((getVpcId() == null) ? 0 : getVpcId().hashCode()); hashCode = prime * hashCode + ((getVpcSecurityGroupIds() == null) ? 0 : getVpcSecurityGroupIds().hashCode()); hashCode = prime * hashCode + ((getVpcSubnetIds() == null) ? 0 : getVpcSubnetIds().hashCode()); hashCode = prime * hashCode + ((getEndpoint() == null) ? 0 : getEndpoint().hashCode()); hashCode = prime * hashCode + ((getCreatedDate() == null) ? 0 : getCreatedDate().hashCode()); hashCode = prime * hashCode + ((getTargetRole() == null) ? 0 : getTargetRole().hashCode()); hashCode = prime * hashCode + ((getIsDefault() == null) ? 0 : getIsDefault().hashCode()); return hashCode; } @Override public DBProxyEndpoint clone() { try { return (DBProxyEndpoint) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy