Class DescribeOptionGroupsRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
Filters the list of option groups to only include groups associated with a specific database engine.This parameter is not currently supported.Filters the list of option groups to only include groups associated with a specific database engine version.An optional pagination token provided by a previous DescribeOptionGroups request.The maximum number of records to include in the response.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
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.toString()
Returns a string representation of this object; useful for testing and debugging.withEngineName
(String engineName) Filters the list of option groups to only include groups associated with a specific database engine.withFilters
(Filter... filters) This parameter is not currently supported.withFilters
(Collection<Filter> filters) This parameter is not currently supported.withMajorEngineVersion
(String majorEngineVersion) Filters the list of option groups to only include groups associated with a specific database engine version.withMarker
(String marker) An optional pagination token provided by a previous DescribeOptionGroups request.withMaxRecords
(Integer maxRecords) The maximum number of records to include in the response.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
-
Constructor Details
-
DescribeOptionGroupsRequest
public DescribeOptionGroupsRequest()
-
-
Method Details
-
setOptionGroupName
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
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
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
This parameter is not currently supported.
- Returns:
- This parameter is not currently supported.
-
setFilters
This parameter is not currently supported.
- Parameters:
filters
- This parameter is not currently supported.
-
withFilters
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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:
-