com.amazonaws.services.neptune.model.DescribeDBClusterEndpointsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-neptune Show documentation
/*
* Copyright 2019-2024 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.neptune.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeDBClusterEndpointsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase
* string.
*
*/
private String dBClusterIdentifier;
/**
*
* The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
*
*/
private String dBClusterEndpointIdentifier;
/**
*
* A set of name-value pairs that define which endpoints to include in the output. The filters are specified as
* name-value pairs, in the format
* Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name
* can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type,
* db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the
* db-cluster-endpoint-type filter can be one or more of: reader, writer,
* custom. Values for the db-cluster-endpoint-custom-type filter can be one
* or more of: reader, any. Values for the
* db-cluster-endpoint-status filter can be one or more of: available,
* creating, deleting, inactive, modifying.
*
*/
private java.util.List filters;
/**
*
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a pagination token called a marker is included in the response so you can retrieve
* the remaining results.
*
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
*
*/
private Integer maxRecords;
/**
*
* An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this
* parameter is specified, the response includes only records beyond the marker, up to the value specified by
* MaxRecords.
*
*/
private String marker;
/**
*
* The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase
* string.
*
*
* @param dBClusterIdentifier
* The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a
* lowercase string.
*/
public void setDBClusterIdentifier(String dBClusterIdentifier) {
this.dBClusterIdentifier = dBClusterIdentifier;
}
/**
*
* The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase
* string.
*
*
* @return The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a
* lowercase string.
*/
public String getDBClusterIdentifier() {
return this.dBClusterIdentifier;
}
/**
*
* The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase
* string.
*
*
* @param dBClusterIdentifier
* The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a
* lowercase string.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBClusterEndpointsRequest withDBClusterIdentifier(String dBClusterIdentifier) {
setDBClusterIdentifier(dBClusterIdentifier);
return this;
}
/**
*
* The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
*
*
* @param dBClusterEndpointIdentifier
* The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
*/
public void setDBClusterEndpointIdentifier(String dBClusterEndpointIdentifier) {
this.dBClusterEndpointIdentifier = dBClusterEndpointIdentifier;
}
/**
*
* The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
*
*
* @return The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
*/
public String getDBClusterEndpointIdentifier() {
return this.dBClusterEndpointIdentifier;
}
/**
*
* The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
*
*
* @param dBClusterEndpointIdentifier
* The identifier of the endpoint to describe. This parameter is stored as a lowercase string.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBClusterEndpointsRequest withDBClusterEndpointIdentifier(String dBClusterEndpointIdentifier) {
setDBClusterEndpointIdentifier(dBClusterEndpointIdentifier);
return this;
}
/**
*
* A set of name-value pairs that define which endpoints to include in the output. The filters are specified as
* name-value pairs, in the format
* Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name
* can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type,
* db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the
* db-cluster-endpoint-type filter can be one or more of: reader, writer,
* custom. Values for the db-cluster-endpoint-custom-type filter can be one
* or more of: reader, any. Values for the
* db-cluster-endpoint-status filter can be one or more of: available,
* creating, deleting, inactive, modifying.
*
*
* @return A set of name-value pairs that define which endpoints to include in the output. The filters are specified
* as name-value pairs, in the format
* Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....
* Name can be one of: db-cluster-endpoint-type,
* db-cluster-endpoint-custom-type, db-cluster-endpoint-id,
* db-cluster-endpoint-status. Values for the
* db-cluster-endpoint-type filter can be one or more of: reader,
* writer, custom. Values for the
* db-cluster-endpoint-custom-type filter can be one or more of: reader,
* any. Values for the db-cluster-endpoint-status filter can be one
* or more of: available, creating, deleting, inactive,
* modifying.
*/
public java.util.List getFilters() {
return filters;
}
/**
*
* A set of name-value pairs that define which endpoints to include in the output. The filters are specified as
* name-value pairs, in the format
* Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name
* can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type,
* db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the
* db-cluster-endpoint-type filter can be one or more of: reader, writer,
* custom. Values for the db-cluster-endpoint-custom-type filter can be one
* or more of: reader, any. Values for the
* db-cluster-endpoint-status filter can be one or more of: available,
* creating, deleting, inactive, modifying.
*
*
* @param filters
* A set of name-value pairs that define which endpoints to include in the output. The filters are specified
* as name-value pairs, in the format
* Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....
* Name can be one of: db-cluster-endpoint-type,
* db-cluster-endpoint-custom-type, db-cluster-endpoint-id,
* db-cluster-endpoint-status. Values for the
* db-cluster-endpoint-type filter can be one or more of: reader,
* writer, custom. Values for the
* db-cluster-endpoint-custom-type filter can be one or more of: reader,
* any. Values for the db-cluster-endpoint-status filter can be one or
* more of: available, creating, deleting, inactive,
* modifying.
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new java.util.ArrayList(filters);
}
/**
*
* A set of name-value pairs that define which endpoints to include in the output. The filters are specified as
* name-value pairs, in the format
* Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name
* can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type,
* db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the
* db-cluster-endpoint-type filter can be one or more of: reader, writer,
* custom. Values for the db-cluster-endpoint-custom-type filter can be one
* or more of: reader, any. Values for the
* db-cluster-endpoint-status filter can be one or more of: available,
* creating, deleting, inactive, modifying.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param filters
* A set of name-value pairs that define which endpoints to include in the output. The filters are specified
* as name-value pairs, in the format
* Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....
* Name can be one of: db-cluster-endpoint-type,
* db-cluster-endpoint-custom-type, db-cluster-endpoint-id,
* db-cluster-endpoint-status. Values for the
* db-cluster-endpoint-type filter can be one or more of: reader,
* writer, custom. Values for the
* db-cluster-endpoint-custom-type filter can be one or more of: reader,
* any. Values for the db-cluster-endpoint-status filter can be one or
* more of: available, creating, deleting, inactive,
* modifying.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBClusterEndpointsRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new java.util.ArrayList(filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* A set of name-value pairs that define which endpoints to include in the output. The filters are specified as
* name-value pairs, in the format
* Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name
* can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type,
* db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the
* db-cluster-endpoint-type filter can be one or more of: reader, writer,
* custom. Values for the db-cluster-endpoint-custom-type filter can be one
* or more of: reader, any. Values for the
* db-cluster-endpoint-status filter can be one or more of: available,
* creating, deleting, inactive, modifying.
*
*
* @param filters
* A set of name-value pairs that define which endpoints to include in the output. The filters are specified
* as name-value pairs, in the format
* Name=endpoint_type,Values=endpoint_type1,endpoint_type2,....
* Name can be one of: db-cluster-endpoint-type,
* db-cluster-endpoint-custom-type, db-cluster-endpoint-id,
* db-cluster-endpoint-status. Values for the
* db-cluster-endpoint-type filter can be one or more of: reader,
* writer, custom. Values for the
* db-cluster-endpoint-custom-type filter can be one or more of: reader,
* any. Values for the db-cluster-endpoint-status filter can be one or
* more of: available, creating, deleting, inactive,
* modifying.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBClusterEndpointsRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a pagination token called a marker is included in the response so you can retrieve
* the remaining results.
*
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
*
*
* @param maxRecords
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a pagination token called a marker is included in the response so you can
* retrieve the remaining results.
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
*/
public void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
/**
*
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a pagination token called a marker is included in the response so you can retrieve
* the remaining results.
*
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
*
*
* @return The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a pagination token called a marker is included in the response so you can
* retrieve the remaining results.
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
*/
public Integer getMaxRecords() {
return this.maxRecords;
}
/**
*
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a pagination token called a marker is included in the response so you can retrieve
* the remaining results.
*
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
*
*
* @param maxRecords
* The maximum number of records to include in the response. If more records exist than the specified
* MaxRecords value, a pagination token called a marker is included in the response so you can
* retrieve the remaining results.
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBClusterEndpointsRequest withMaxRecords(Integer maxRecords) {
setMaxRecords(maxRecords);
return this;
}
/**
*
* An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this
* parameter is specified, the response includes only records beyond the marker, up to the value specified by
* MaxRecords.
*
*
* @param marker
* An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If
* this parameter is specified, the response includes only records beyond the marker, up to the value
* specified by MaxRecords.
*/
public void setMarker(String marker) {
this.marker = marker;
}
/**
*
* An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this
* parameter is specified, the response includes only records beyond the marker, up to the value specified by
* MaxRecords.
*
*
* @return An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If
* this parameter is specified, the response includes only records beyond the marker, up to the value
* specified by MaxRecords.
*/
public String getMarker() {
return this.marker;
}
/**
*
* An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this
* parameter is specified, the response includes only records beyond the marker, up to the value specified by
* MaxRecords.
*
*
* @param marker
* An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If
* this parameter is specified, the response includes only records beyond the marker, up to the value
* specified by MaxRecords.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBClusterEndpointsRequest withMarker(String marker) {
setMarker(marker);
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 (getDBClusterIdentifier() != null)
sb.append("DBClusterIdentifier: ").append(getDBClusterIdentifier()).append(",");
if (getDBClusterEndpointIdentifier() != null)
sb.append("DBClusterEndpointIdentifier: ").append(getDBClusterEndpointIdentifier()).append(",");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getMaxRecords() != null)
sb.append("MaxRecords: ").append(getMaxRecords()).append(",");
if (getMarker() != null)
sb.append("Marker: ").append(getMarker());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeDBClusterEndpointsRequest == false)
return false;
DescribeDBClusterEndpointsRequest other = (DescribeDBClusterEndpointsRequest) obj;
if (other.getDBClusterIdentifier() == null ^ this.getDBClusterIdentifier() == null)
return false;
if (other.getDBClusterIdentifier() != null && other.getDBClusterIdentifier().equals(this.getDBClusterIdentifier()) == false)
return false;
if (other.getDBClusterEndpointIdentifier() == null ^ this.getDBClusterEndpointIdentifier() == null)
return false;
if (other.getDBClusterEndpointIdentifier() != null && other.getDBClusterEndpointIdentifier().equals(this.getDBClusterEndpointIdentifier()) == false)
return false;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
return false;
if (other.getMaxRecords() == null ^ this.getMaxRecords() == null)
return false;
if (other.getMaxRecords() != null && other.getMaxRecords().equals(this.getMaxRecords()) == false)
return false;
if (other.getMarker() == null ^ this.getMarker() == null)
return false;
if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDBClusterIdentifier() == null) ? 0 : getDBClusterIdentifier().hashCode());
hashCode = prime * hashCode + ((getDBClusterEndpointIdentifier() == null) ? 0 : getDBClusterEndpointIdentifier().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getMaxRecords() == null) ? 0 : getMaxRecords().hashCode());
hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode());
return hashCode;
}
@Override
public DescribeDBClusterEndpointsRequest clone() {
return (DescribeDBClusterEndpointsRequest) super.clone();
}
}