com.amazonaws.services.docdb.model.DescribeDBEngineVersionsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-docdb 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.docdb.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* Represents the input to DescribeDBEngineVersions.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeDBEngineVersionsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The database engine to return.
*
*/
private String engine;
/**
*
* The database engine version to return.
*
*
* Example: 3.6.0
*
*/
private String engineVersion;
/**
*
* The name of a specific parameter group family to return details for.
*
*
* Constraints:
*
*
* -
*
* If provided, must match an existing DBParameterGroupFamily.
*
*
*
*/
private String dBParameterGroupFamily;
/**
*
* This parameter is not currently supported.
*
*/
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 (marker) is included in the response so that the remaining
* results can be retrieved.
*
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
*
*/
private Integer maxRecords;
/**
*
* An optional pagination token provided by a previous request. If this parameter is specified, the response
* includes only records beyond the marker, up to the value specified by MaxRecords.
*
*/
private String marker;
/**
*
* Indicates that only the default version of the specified engine or engine and major version combination is
* returned.
*
*/
private Boolean defaultOnly;
/**
*
* If this parameter is specified and the requested engine supports the CharacterSetName parameter for
* CreateDBInstance, the response includes a list of supported character sets for each engine version.
*
*/
private Boolean listSupportedCharacterSets;
/**
*
* If this parameter is specified and the requested engine supports the TimeZone parameter for
* CreateDBInstance, the response includes a list of supported time zones for each engine version.
*
*/
private Boolean listSupportedTimezones;
/**
*
* The database engine to return.
*
*
* @param engine
* The database engine to return.
*/
public void setEngine(String engine) {
this.engine = engine;
}
/**
*
* The database engine to return.
*
*
* @return The database engine to return.
*/
public String getEngine() {
return this.engine;
}
/**
*
* The database engine to return.
*
*
* @param engine
* The database engine to return.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBEngineVersionsRequest withEngine(String engine) {
setEngine(engine);
return this;
}
/**
*
* The database engine version to return.
*
*
* Example: 3.6.0
*
*
* @param engineVersion
* The database engine version to return.
*
* Example: 3.6.0
*/
public void setEngineVersion(String engineVersion) {
this.engineVersion = engineVersion;
}
/**
*
* The database engine version to return.
*
*
* Example: 3.6.0
*
*
* @return The database engine version to return.
*
* Example: 3.6.0
*/
public String getEngineVersion() {
return this.engineVersion;
}
/**
*
* The database engine version to return.
*
*
* Example: 3.6.0
*
*
* @param engineVersion
* The database engine version to return.
*
* Example: 3.6.0
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBEngineVersionsRequest withEngineVersion(String engineVersion) {
setEngineVersion(engineVersion);
return this;
}
/**
*
* The name of a specific parameter group family to return details for.
*
*
* Constraints:
*
*
* -
*
* If provided, must match an existing DBParameterGroupFamily.
*
*
*
*
* @param dBParameterGroupFamily
* The name of a specific parameter group family to return details for.
*
* Constraints:
*
*
* -
*
* If provided, must match an existing DBParameterGroupFamily.
*
*
*/
public void setDBParameterGroupFamily(String dBParameterGroupFamily) {
this.dBParameterGroupFamily = dBParameterGroupFamily;
}
/**
*
* The name of a specific parameter group family to return details for.
*
*
* Constraints:
*
*
* -
*
* If provided, must match an existing DBParameterGroupFamily.
*
*
*
*
* @return The name of a specific parameter group family to return details for.
*
* Constraints:
*
*
* -
*
* If provided, must match an existing DBParameterGroupFamily.
*
*
*/
public String getDBParameterGroupFamily() {
return this.dBParameterGroupFamily;
}
/**
*
* The name of a specific parameter group family to return details for.
*
*
* Constraints:
*
*
* -
*
* If provided, must match an existing DBParameterGroupFamily.
*
*
*
*
* @param dBParameterGroupFamily
* The name of a specific parameter group family to return details for.
*
* Constraints:
*
*
* -
*
* If provided, must match an existing DBParameterGroupFamily.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBEngineVersionsRequest withDBParameterGroupFamily(String dBParameterGroupFamily) {
setDBParameterGroupFamily(dBParameterGroupFamily);
return this;
}
/**
*
* This parameter is not currently supported.
*
*
* @return This parameter is not currently supported.
*/
public java.util.List getFilters() {
return filters;
}
/**
*
* This parameter is not currently supported.
*
*
* @param filters
* This parameter is not currently supported.
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new java.util.ArrayList(filters);
}
/**
*
* This parameter is not currently supported.
*
*
* 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
* This parameter is not currently supported.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBEngineVersionsRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new java.util.ArrayList(filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* This parameter is not currently supported.
*
*
* @param filters
* This parameter is not currently supported.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBEngineVersionsRequest 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 (marker) is included in the response so that the remaining
* results can be retrieved.
*
*
* 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 (marker) is included in the response so that the
* remaining results can be retrieved.
*
* 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 (marker) is included in the response so that the remaining
* results can be retrieved.
*
*
* 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 (marker) is included in the response so that the
* remaining results can be retrieved.
*
* 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 (marker) is included in the response so that the remaining
* results can be retrieved.
*
*
* 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 (marker) is included in the response so that the
* remaining results can be retrieved.
*
* Default: 100
*
*
* Constraints: Minimum 20, maximum 100.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBEngineVersionsRequest withMaxRecords(Integer maxRecords) {
setMaxRecords(maxRecords);
return this;
}
/**
*
* An optional pagination token provided by a previous 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 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 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 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 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 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 DescribeDBEngineVersionsRequest withMarker(String marker) {
setMarker(marker);
return this;
}
/**
*
* Indicates that only the default version of the specified engine or engine and major version combination is
* returned.
*
*
* @param defaultOnly
* Indicates that only the default version of the specified engine or engine and major version combination is
* returned.
*/
public void setDefaultOnly(Boolean defaultOnly) {
this.defaultOnly = defaultOnly;
}
/**
*
* Indicates that only the default version of the specified engine or engine and major version combination is
* returned.
*
*
* @return Indicates that only the default version of the specified engine or engine and major version combination
* is returned.
*/
public Boolean getDefaultOnly() {
return this.defaultOnly;
}
/**
*
* Indicates that only the default version of the specified engine or engine and major version combination is
* returned.
*
*
* @param defaultOnly
* Indicates that only the default version of the specified engine or engine and major version combination is
* returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBEngineVersionsRequest withDefaultOnly(Boolean defaultOnly) {
setDefaultOnly(defaultOnly);
return this;
}
/**
*
* Indicates that only the default version of the specified engine or engine and major version combination is
* returned.
*
*
* @return Indicates that only the default version of the specified engine or engine and major version combination
* is returned.
*/
public Boolean isDefaultOnly() {
return this.defaultOnly;
}
/**
*
* If this parameter is specified and the requested engine supports the CharacterSetName parameter for
* CreateDBInstance, the response includes a list of supported character sets for each engine version.
*
*
* @param listSupportedCharacterSets
* If this parameter is specified and the requested engine supports the CharacterSetName
* parameter for CreateDBInstance, the response includes a list of supported character sets for
* each engine version.
*/
public void setListSupportedCharacterSets(Boolean listSupportedCharacterSets) {
this.listSupportedCharacterSets = listSupportedCharacterSets;
}
/**
*
* If this parameter is specified and the requested engine supports the CharacterSetName parameter for
* CreateDBInstance, the response includes a list of supported character sets for each engine version.
*
*
* @return If this parameter is specified and the requested engine supports the CharacterSetName
* parameter for CreateDBInstance, the response includes a list of supported character sets for
* each engine version.
*/
public Boolean getListSupportedCharacterSets() {
return this.listSupportedCharacterSets;
}
/**
*
* If this parameter is specified and the requested engine supports the CharacterSetName parameter for
* CreateDBInstance, the response includes a list of supported character sets for each engine version.
*
*
* @param listSupportedCharacterSets
* If this parameter is specified and the requested engine supports the CharacterSetName
* parameter for CreateDBInstance, the response includes a list of supported character sets for
* each engine version.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBEngineVersionsRequest withListSupportedCharacterSets(Boolean listSupportedCharacterSets) {
setListSupportedCharacterSets(listSupportedCharacterSets);
return this;
}
/**
*
* If this parameter is specified and the requested engine supports the CharacterSetName parameter for
* CreateDBInstance, the response includes a list of supported character sets for each engine version.
*
*
* @return If this parameter is specified and the requested engine supports the CharacterSetName
* parameter for CreateDBInstance, the response includes a list of supported character sets for
* each engine version.
*/
public Boolean isListSupportedCharacterSets() {
return this.listSupportedCharacterSets;
}
/**
*
* If this parameter is specified and the requested engine supports the TimeZone parameter for
* CreateDBInstance, the response includes a list of supported time zones for each engine version.
*
*
* @param listSupportedTimezones
* If this parameter is specified and the requested engine supports the TimeZone parameter for
* CreateDBInstance, the response includes a list of supported time zones for each engine
* version.
*/
public void setListSupportedTimezones(Boolean listSupportedTimezones) {
this.listSupportedTimezones = listSupportedTimezones;
}
/**
*
* If this parameter is specified and the requested engine supports the TimeZone parameter for
* CreateDBInstance, the response includes a list of supported time zones for each engine version.
*
*
* @return If this parameter is specified and the requested engine supports the TimeZone parameter for
* CreateDBInstance, the response includes a list of supported time zones for each engine
* version.
*/
public Boolean getListSupportedTimezones() {
return this.listSupportedTimezones;
}
/**
*
* If this parameter is specified and the requested engine supports the TimeZone parameter for
* CreateDBInstance, the response includes a list of supported time zones for each engine version.
*
*
* @param listSupportedTimezones
* If this parameter is specified and the requested engine supports the TimeZone parameter for
* CreateDBInstance, the response includes a list of supported time zones for each engine
* version.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeDBEngineVersionsRequest withListSupportedTimezones(Boolean listSupportedTimezones) {
setListSupportedTimezones(listSupportedTimezones);
return this;
}
/**
*
* If this parameter is specified and the requested engine supports the TimeZone parameter for
* CreateDBInstance, the response includes a list of supported time zones for each engine version.
*
*
* @return If this parameter is specified and the requested engine supports the TimeZone parameter for
* CreateDBInstance, the response includes a list of supported time zones for each engine
* version.
*/
public Boolean isListSupportedTimezones() {
return this.listSupportedTimezones;
}
/**
* 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 (getEngine() != null)
sb.append("Engine: ").append(getEngine()).append(",");
if (getEngineVersion() != null)
sb.append("EngineVersion: ").append(getEngineVersion()).append(",");
if (getDBParameterGroupFamily() != null)
sb.append("DBParameterGroupFamily: ").append(getDBParameterGroupFamily()).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()).append(",");
if (getDefaultOnly() != null)
sb.append("DefaultOnly: ").append(getDefaultOnly()).append(",");
if (getListSupportedCharacterSets() != null)
sb.append("ListSupportedCharacterSets: ").append(getListSupportedCharacterSets()).append(",");
if (getListSupportedTimezones() != null)
sb.append("ListSupportedTimezones: ").append(getListSupportedTimezones());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeDBEngineVersionsRequest == false)
return false;
DescribeDBEngineVersionsRequest other = (DescribeDBEngineVersionsRequest) obj;
if (other.getEngine() == null ^ this.getEngine() == null)
return false;
if (other.getEngine() != null && other.getEngine().equals(this.getEngine()) == false)
return false;
if (other.getEngineVersion() == null ^ this.getEngineVersion() == null)
return false;
if (other.getEngineVersion() != null && other.getEngineVersion().equals(this.getEngineVersion()) == false)
return false;
if (other.getDBParameterGroupFamily() == null ^ this.getDBParameterGroupFamily() == null)
return false;
if (other.getDBParameterGroupFamily() != null && other.getDBParameterGroupFamily().equals(this.getDBParameterGroupFamily()) == 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;
if (other.getDefaultOnly() == null ^ this.getDefaultOnly() == null)
return false;
if (other.getDefaultOnly() != null && other.getDefaultOnly().equals(this.getDefaultOnly()) == false)
return false;
if (other.getListSupportedCharacterSets() == null ^ this.getListSupportedCharacterSets() == null)
return false;
if (other.getListSupportedCharacterSets() != null && other.getListSupportedCharacterSets().equals(this.getListSupportedCharacterSets()) == false)
return false;
if (other.getListSupportedTimezones() == null ^ this.getListSupportedTimezones() == null)
return false;
if (other.getListSupportedTimezones() != null && other.getListSupportedTimezones().equals(this.getListSupportedTimezones()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEngine() == null) ? 0 : getEngine().hashCode());
hashCode = prime * hashCode + ((getEngineVersion() == null) ? 0 : getEngineVersion().hashCode());
hashCode = prime * hashCode + ((getDBParameterGroupFamily() == null) ? 0 : getDBParameterGroupFamily().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());
hashCode = prime * hashCode + ((getDefaultOnly() == null) ? 0 : getDefaultOnly().hashCode());
hashCode = prime * hashCode + ((getListSupportedCharacterSets() == null) ? 0 : getListSupportedCharacterSets().hashCode());
hashCode = prime * hashCode + ((getListSupportedTimezones() == null) ? 0 : getListSupportedTimezones().hashCode());
return hashCode;
}
@Override
public DescribeDBEngineVersionsRequest clone() {
return (DescribeDBEngineVersionsRequest) super.clone();
}
}