public class DescribeOptionGroupsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
DescribeOptionGroups operation.
Describes the available option groups.
NOOP| Constructor and Description |
|---|
DescribeOptionGroupsRequest() |
| Modifier and Type | Method and Description |
|---|---|
DescribeOptionGroupsRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(Object obj) |
String |
getEngineName()
Filters the list of option groups to only include groups associated
with a specific database engine.
|
List<Filter> |
getFilters()
This parameter is not currently supported.
|
String |
getMajorEngineVersion()
Filters the list of option groups to only include groups associated
with a specific database engine version.
|
String |
getMarker()
An optional pagination token provided by a previous
DescribeOptionGroups request.
|
Integer |
getMaxRecords()
The maximum number of records to include in the response.
|
String |
getOptionGroupName()
The name of the option group to describe.
|
int |
hashCode() |
void |
setEngineName(String engineName)
Filters the list of option groups to only include groups associated
with a specific database engine.
|
void |
setFilters(Collection<Filter> filters)
This parameter is not currently supported.
|
void |
setMajorEngineVersion(String majorEngineVersion)
Filters the list of option groups to only include groups associated
with a specific database engine version.
|
void |
setMarker(String marker)
An optional pagination token provided by a previous
DescribeOptionGroups request.
|
void |
setMaxRecords(Integer maxRecords)
The maximum number of records to include in the response.
|
void |
setOptionGroupName(String optionGroupName)
The name of the option group to describe.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeOptionGroupsRequest |
withEngineName(String engineName)
Filters the list of option groups to only include groups associated
with a specific database engine.
|
DescribeOptionGroupsRequest |
withFilters(Collection<Filter> filters)
This parameter is not currently supported.
|
DescribeOptionGroupsRequest |
withFilters(Filter... filters)
This parameter is not currently supported.
|
DescribeOptionGroupsRequest |
withMajorEngineVersion(String majorEngineVersion)
Filters the list of option groups to only include groups associated
with a specific database engine version.
|
DescribeOptionGroupsRequest |
withMarker(String marker)
An optional pagination token provided by a previous
DescribeOptionGroups request.
|
DescribeOptionGroupsRequest |
withMaxRecords(Integer maxRecords)
The maximum number of records to include in the response.
|
DescribeOptionGroupsRequest |
withOptionGroupName(String optionGroupName)
The name of the option group to describe.
|
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic String getOptionGroupName()
public void setOptionGroupName(String optionGroupName)
optionGroupName - The name of the option group to describe. Cannot be supplied together
with EngineName or MajorEngineVersion.public DescribeOptionGroupsRequest withOptionGroupName(String optionGroupName)
Returns a reference to this object so that method calls can be chained together.
optionGroupName - The name of the option group to describe. Cannot be supplied together
with EngineName or MajorEngineVersion.public List<Filter> getFilters()
public void setFilters(Collection<Filter> filters)
filters - This parameter is not currently supported.public DescribeOptionGroupsRequest withFilters(Filter... filters)
NOTE: This method appends the values to the existing list (if
any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the
existing values.
Returns a reference to this object so that method calls can be chained together.
filters - This parameter is not currently supported.public DescribeOptionGroupsRequest withFilters(Collection<Filter> filters)
Returns a reference to this object so that method calls can be chained together.
filters - This parameter is not currently supported.public String getMarker()
MaxRecords.MaxRecords.public void setMarker(String marker)
MaxRecords.marker - An optional pagination token provided by a previous
DescribeOptionGroups request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords.public DescribeOptionGroupsRequest withMarker(String marker)
MaxRecords.
Returns a reference to this object so that method calls can be chained together.
marker - An optional pagination token provided by a previous
DescribeOptionGroups request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
specified by MaxRecords.public Integer getMaxRecords()
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
MaxRecords value, a
pagination token called a 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)
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
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 that
the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
public DescribeOptionGroupsRequest withMaxRecords(Integer maxRecords)
MaxRecords value, a
pagination token called a marker is included in the response so that
the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
Returns a reference to this object so that method calls can be chained together.
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 that
the remaining results can be retrieved. Default: 100
Constraints: Minimum 20, maximum 100.
public String getEngineName()
public void setEngineName(String engineName)
engineName - Filters the list of option groups to only include groups associated
with a specific database engine.public DescribeOptionGroupsRequest withEngineName(String engineName)
Returns a reference to this object so that method calls can be chained together.
engineName - Filters the list of option groups to only include groups associated
with a specific database engine.public String getMajorEngineVersion()
public void setMajorEngineVersion(String majorEngineVersion)
majorEngineVersion - Filters the list of option groups to only include groups associated
with a specific database engine version. If specified, then EngineName
must also be specified.public DescribeOptionGroupsRequest withMajorEngineVersion(String majorEngineVersion)
Returns a reference to this object so that method calls can be chained together.
majorEngineVersion - Filters the list of option groups to only include groups associated
with a specific database engine version. If specified, then EngineName
must also be specified.public String toString()
toString in class ObjectObject.toString()public DescribeOptionGroupsRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.