com.amazonaws.services.rds.model

Class DescribeOptionGroupsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rds.model.DescribeOptionGroupsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeOptionGroupsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeOptionGroupsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeOptionGroupsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getEngineName() A filter to only include option groups associated with this database engine.
List<Filter>	getFilters() This parameter isn't 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) A filter to only include option groups associated with this database engine.
void	setFilters(Collection<Filter> filters) This parameter isn't 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.
DescribeOptionGroupsRequest	withEngineName(String engineName) A filter to only include option groups associated with this database engine.
DescribeOptionGroupsRequest	withFilters(Collection<Filter> filters) This parameter isn't currently supported.
DescribeOptionGroupsRequest	withFilters(Filter... filters) This parameter isn't 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

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeOptionGroupsRequest

public DescribeOptionGroupsRequest()

Method Detail

setOptionGroupName

public void setOptionGroupName(String optionGroupName)

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

Parameters:

optionGroupName - The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

getOptionGroupName

public String getOptionGroupName()

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

Returns:

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

withOptionGroupName

public DescribeOptionGroupsRequest withOptionGroupName(String optionGroupName)

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

Parameters:

optionGroupName - The name of the option group to describe. Can't 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 isn't currently supported.

Returns:

This parameter isn't currently supported.

setFilters

public void setFilters(Collection<Filter> filters)

This parameter isn't currently supported.

Parameters:

filters - This parameter isn't currently supported.

withFilters

public DescribeOptionGroupsRequest withFilters(Filter... filters)

This parameter isn't currently supported.

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.

Parameters:

filters - This parameter isn't 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 isn't currently supported.

Parameters:

filters - This parameter isn't 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 by MaxRecords.

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 by MaxRecords.

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 you can retrieve the remaining results.

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 you can retrieve the remaining results.

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 you can retrieve the remaining results.

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 you can retrieve the remaining results.

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 you can retrieve the remaining results.

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 you can retrieve the remaining results.

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)

A filter to only include option groups associated with this database engine.

Valid Values:

• db2-ae

• db2-se

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

Parameters:

engineName - A filter to only include option groups associated with this database engine.

Valid Values:

• db2-ae

• db2-se

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

getEngineName

public String getEngineName()

A filter to only include option groups associated with this database engine.

Valid Values:

• db2-ae

• db2-se

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

Returns:

A filter to only include option groups associated with this database engine.

Valid Values:

• db2-ae

• db2-se

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

withEngineName

public DescribeOptionGroupsRequest withEngineName(String engineName)

A filter to only include option groups associated with this database engine.

Valid Values:

• db2-ae

• db2-se

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

Parameters:

engineName - A filter to only include option groups associated with this database engine.

Valid Values:

• db2-ae

• db2-se

• mariadb

• mysql

• oracle-ee

• oracle-ee-cdb

• oracle-se2

• oracle-se2-cdb

• postgres

• sqlserver-ee

• sqlserver-se

• sqlserver-ex

• sqlserver-web

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeOptionGroupsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()