DescribeOptionGroupsRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.rds.model.DescribeOptionGroupsRequest

All Implemented Interfaces:

Serializable
```
public class DescribeOptionGroupsRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the DescribeOptionGroups operation.
Describes the available option groups.

See Also:
AmazonRDS.describeOptionGroups(DescribeOptionGroupsRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeOptionGroupsRequest()

Constructors
Constructor and Description
`DescribeOptionGroupsRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getEngineName()` Filters the list of option groups to only include groups associated with a specific database engine.
`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`	`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`	`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
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeOptionGroupsRequest
```
public DescribeOptionGroupsRequest()
```
- Method Detail
  - 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.
  - 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.
  - withOptionGroupName
```
public DescribeOptionGroupsRequest withOptionGroupName(String optionGroupName)
```
    The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    optionGroupName - The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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 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.
    Returns a reference to this object so that method calls can be chained together.
    
    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 by MaxRecords.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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
  - 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 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
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    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
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - withEngineName
```
public DescribeOptionGroupsRequest withEngineName(String engineName)
```
    Filters the list of option groups to only include groups associated with a specific database engine.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    engineName - Filters the list of option groups to only include groups associated with a specific database engine.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    A reference to this updated 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 class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class DescribeOptionGroupsRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DescribeOptionGroupsRequest

Method Detail

getOptionGroupName

setOptionGroupName

withOptionGroupName

getMarker

setMarker

withMarker

getMaxRecords

setMaxRecords

withMaxRecords

getEngineName

setEngineName

withEngineName

getMajorEngineVersion

setMajorEngineVersion

withMajorEngineVersion

toString

hashCode

equals