com.amazonaws.services.rds.model.DescribeDBEngineVersionsRequest Maven / Gradle / Ivy
/*
* Copyright 2010-2011 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 com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.rds.AmazonRDS#describeDBEngineVersions(DescribeDBEngineVersionsRequest) DescribeDBEngineVersions operation}.
*
* Returns a list of the available DB engines.
*
*
* @see com.amazonaws.services.rds.AmazonRDS#describeDBEngineVersions(DescribeDBEngineVersionsRequest)
*/
public class DescribeDBEngineVersionsRequest extends AmazonWebServiceRequest {
/**
* The database engine to return.
*/
private String engine;
/**
* The database engine version to return.
*/
private String engineVersion;
/**
* The name of a specific database parameter group family to return
* details for.
*/
private String dBParameterGroupFamily;
/**
* The maximum number of records to include in the response. If more than
* the MaxRecords value is available, a marker is included
* in the response so that the following results can be retrieved.
*/
private Integer maxRecords;
/**
* The marker provided in the previous request. If this parameter is
* specified, the response includes records beyond the marker only, up to
* 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;
/**
* Default constructor for a new DescribeDBEngineVersionsRequest object. Callers should use the
* setter or fluent setter (with...) methods to initialize this object after creating it.
*/
public DescribeDBEngineVersionsRequest() {}
/**
* The database engine to return.
*
* @return The database engine to return.
*/
public String getEngine() {
return engine;
}
/**
* 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.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param engine The database engine to return.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeDBEngineVersionsRequest withEngine(String engine) {
this.engine = engine;
return this;
}
/**
* The database engine version to return.
*
* @return The database engine version to return.
*/
public String getEngineVersion() {
return engineVersion;
}
/**
* The database engine version to return.
*
* @param engineVersion The database engine version to return.
*/
public void setEngineVersion(String engineVersion) {
this.engineVersion = engineVersion;
}
/**
* The database engine version to return.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param engineVersion The database engine version to return.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeDBEngineVersionsRequest withEngineVersion(String engineVersion) {
this.engineVersion = engineVersion;
return this;
}
/**
* The name of a specific database parameter group family to return
* details for.
*
* @return The name of a specific database parameter group family to return
* details for.
*/
public String getDBParameterGroupFamily() {
return dBParameterGroupFamily;
}
/**
* The name of a specific database parameter group family to return
* details for.
*
* @param dBParameterGroupFamily The name of a specific database parameter group family to return
* details for.
*/
public void setDBParameterGroupFamily(String dBParameterGroupFamily) {
this.dBParameterGroupFamily = dBParameterGroupFamily;
}
/**
* The name of a specific database parameter group family to return
* details for.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param dBParameterGroupFamily The name of a specific database parameter group family to return
* details for.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeDBEngineVersionsRequest withDBParameterGroupFamily(String dBParameterGroupFamily) {
this.dBParameterGroupFamily = dBParameterGroupFamily;
return this;
}
/**
* The maximum number of records to include in the response. If more than
* the MaxRecords value is available, a marker is included
* in the response so that the following results can be retrieved.
*
* @return The maximum number of records to include in the response. If more than
* the MaxRecords value is available, a marker is included
* in the response so that the following results can be retrieved.
*/
public Integer getMaxRecords() {
return maxRecords;
}
/**
* The maximum number of records to include in the response. If more than
* the MaxRecords value is available, a marker is included
* in the response so that the following results can be retrieved.
*
* @param maxRecords The maximum number of records to include in the response. If more than
* the MaxRecords value is available, a marker is included
* in the response so that the following results can be retrieved.
*/
public void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
/**
* The maximum number of records to include in the response. If more than
* the MaxRecords value is available, a marker is included
* in the response so that the following results can be retrieved.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param maxRecords The maximum number of records to include in the response. If more than
* the MaxRecords value is available, a marker is included
* in the response so that the following results can be retrieved.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeDBEngineVersionsRequest withMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
return this;
}
/**
* The marker provided in the previous request. If this parameter is
* specified, the response includes records beyond the marker only, up to
* MaxRecords.
*
* @return The marker provided in the previous request. If this parameter is
* specified, the response includes records beyond the marker only, up to
* MaxRecords.
*/
public String getMarker() {
return marker;
}
/**
* The marker provided in the previous request. If this parameter is
* specified, the response includes records beyond the marker only, up to
* MaxRecords.
*
* @param marker The marker provided in the previous request. If this parameter is
* specified, the response includes records beyond the marker only, up to
* MaxRecords.
*/
public void setMarker(String marker) {
this.marker = marker;
}
/**
* The marker provided in the previous request. If this parameter is
* specified, the response includes records beyond the marker only, up to
* MaxRecords.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param marker The marker provided in the previous request. If this parameter is
* specified, the response includes records beyond the marker only, up to
* MaxRecords.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeDBEngineVersionsRequest withMarker(String marker) {
this.marker = marker;
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 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.
*/
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.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param defaultOnly Indicates that only the default version of the specified engine or
* engine and major version combination is returned.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeDBEngineVersionsRequest withDefaultOnly(Boolean defaultOnly) {
this.defaultOnly = 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 getDefaultOnly() {
return defaultOnly;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
sb.append("Engine: " + engine + ", ");
sb.append("EngineVersion: " + engineVersion + ", ");
sb.append("DBParameterGroupFamily: " + dBParameterGroupFamily + ", ");
sb.append("MaxRecords: " + maxRecords + ", ");
sb.append("Marker: " + marker + ", ");
sb.append("DefaultOnly: " + defaultOnly + ", ");
sb.append("}");
return sb.toString();
}
}