Class DescribeOptionGroupsRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.rds.model.DescribeOptionGroupsRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class DescribeOptionGroupsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description DescribeOptionGroupsRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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(Filter... filters)
This parameter is not currently supported.DescribeOptionGroupsRequest
withFilters(Collection<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.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setOptionGroupName
public void setOptionGroupName(String optionGroupName)
The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.
- Parameters:
optionGroupName
- The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.
-
getOptionGroupName
public String getOptionGroupName()
The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.
- Returns:
- The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.
-
withOptionGroupName
public DescribeOptionGroupsRequest withOptionGroupName(String optionGroupName)
The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.
- Parameters:
optionGroupName
- The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getFilters
public List<Filter> getFilters()
This parameter is not currently supported.
- Returns:
- This parameter is not currently supported.
-
setFilters
public void setFilters(Collection<Filter> filters)
This parameter is not currently supported.
- Parameters:
filters
- This parameter is not currently supported.
-
withFilters
public DescribeOptionGroupsRequest withFilters(Filter... filters)
This parameter is not currently supported.
NOTE: This method appends the values to the existing list (if any). Use
setFilters(java.util.Collection)
orwithFilters(java.util.Collection)
if you want to override the existing values.- Parameters:
filters
- This parameter is not currently supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withFilters
public DescribeOptionGroupsRequest withFilters(Collection<Filter> filters)
This parameter is not currently supported.
- Parameters:
filters
- This parameter is not currently supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMarker
public void setMarker(String 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
.- Parameters:
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 byMaxRecords
.
-
getMarker
public String getMarker()
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
.- Returns:
- 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
.
-
withMarker
public DescribeOptionGroupsRequest withMarker(String 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
.- Parameters:
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 byMaxRecords
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMaxRecords
public void setMaxRecords(Integer 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.
- Parameters:
maxRecords
- The maximum number of records to include in the response. If more records exist than the specifiedMaxRecords
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.
-
getMaxRecords
public Integer getMaxRecords()
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.
- Returns:
- 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.
-
withMaxRecords
public DescribeOptionGroupsRequest withMaxRecords(Integer 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.
- Parameters:
maxRecords
- The maximum number of records to include in the response. If more records exist than the specifiedMaxRecords
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:
- Returns a reference to this object so that method calls can be chained together.
-
setEngineName
public void setEngineName(String engineName)
Filters the list of option groups to only include groups associated with a specific database engine.
- Parameters:
engineName
- Filters the list of option groups to only include groups associated with a specific database engine.
-
getEngineName
public String getEngineName()
Filters the list of option groups to only include groups associated with a specific database engine.
- Returns:
- Filters the list of option groups to only include groups associated with a specific database engine.
-
withEngineName
public DescribeOptionGroupsRequest withEngineName(String engineName)
Filters the list of option groups to only include groups associated with a specific database engine.
- Parameters:
engineName
- Filters the list of option groups to only include groups associated with a specific database engine.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMajorEngineVersion
public void setMajorEngineVersion(String 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.
- Parameters:
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.
-
getMajorEngineVersion
public String getMajorEngineVersion()
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.
- Returns:
- 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.
-
withMajorEngineVersion
public DescribeOptionGroupsRequest withMajorEngineVersion(String 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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public DescribeOptionGroupsRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-