com.amazonaws.services.elasticbeanstalk.model

Class DescribeConfigurationOptionsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticbeanstalk.model.DescribeConfigurationOptionsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeConfigurationOptionsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeConfigurationOptions operation.

Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.

See Also:

AWSElasticBeanstalk.describeConfigurationOptions(DescribeConfigurationOptionsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeConfigurationOptionsRequest() Default constructor for a new DescribeConfigurationOptionsRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
DescribeConfigurationOptionsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getApplicationName() The name of the application associated with the configuration template or environment.
String	getEnvironmentName() The name of the environment whose configuration options you want to describe.
List<OptionSpecification>	getOptions() If specified, restricts the descriptions to only the specified options.
String	getSolutionStackName() The name of the solution stack whose configuration options you want to describe.
String	getTemplateName() The name of the configuration template whose configuration options you want to describe.
int	hashCode()
void	setApplicationName(String applicationName) The name of the application associated with the configuration template or environment.
void	setEnvironmentName(String environmentName) The name of the environment whose configuration options you want to describe.
void	setOptions(Collection<OptionSpecification> options) If specified, restricts the descriptions to only the specified options.
void	setSolutionStackName(String solutionStackName) The name of the solution stack whose configuration options you want to describe.
void	setTemplateName(String templateName) The name of the configuration template whose configuration options you want to describe.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeConfigurationOptionsRequest	withApplicationName(String applicationName) The name of the application associated with the configuration template or environment.
DescribeConfigurationOptionsRequest	withEnvironmentName(String environmentName) The name of the environment whose configuration options you want to describe.
DescribeConfigurationOptionsRequest	withOptions(Collection<OptionSpecification> options) If specified, restricts the descriptions to only the specified options.
DescribeConfigurationOptionsRequest	withOptions(OptionSpecification... options) If specified, restricts the descriptions to only the specified options.
DescribeConfigurationOptionsRequest	withSolutionStackName(String solutionStackName) The name of the solution stack whose configuration options you want to describe.
DescribeConfigurationOptionsRequest	withTemplateName(String templateName) The name of the configuration template whose configuration options you want to describe.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeConfigurationOptionsRequest

public DescribeConfigurationOptionsRequest()

Default constructor for a new DescribeConfigurationOptionsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

Method Detail

getApplicationName

public String getApplicationName()

The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.

Constraints:
Length: 1 - 100

Returns:

The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.

setApplicationName

public void setApplicationName(String applicationName)

The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.

Constraints:
Length: 1 - 100

Parameters:

applicationName - The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.

withApplicationName

public DescribeConfigurationOptionsRequest withApplicationName(String applicationName)

The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:

applicationName - The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.

Returns:

A reference to this updated object so that method calls can be chained together.

getTemplateName

public String getTemplateName()

The name of the configuration template whose configuration options you want to describe.

Constraints:
Length: 1 - 100

Returns:

The name of the configuration template whose configuration options you want to describe.

setTemplateName

public void setTemplateName(String templateName)

The name of the configuration template whose configuration options you want to describe.

Constraints:
Length: 1 - 100

Parameters:

templateName - The name of the configuration template whose configuration options you want to describe.

withTemplateName

public DescribeConfigurationOptionsRequest withTemplateName(String templateName)

The name of the configuration template whose configuration options you want to describe.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:

templateName - The name of the configuration template whose configuration options you want to describe.

Returns:

A reference to this updated object so that method calls can be chained together.

getEnvironmentName

public String getEnvironmentName()

The name of the environment whose configuration options you want to describe.

Constraints:
Length: 4 - 23

Returns:

The name of the environment whose configuration options you want to describe.

setEnvironmentName

public void setEnvironmentName(String environmentName)

The name of the environment whose configuration options you want to describe.

Constraints:
Length: 4 - 23

Parameters:

environmentName - The name of the environment whose configuration options you want to describe.

withEnvironmentName

public DescribeConfigurationOptionsRequest withEnvironmentName(String environmentName)

The name of the environment whose configuration options you want to describe.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 4 - 23

Parameters:

environmentName - The name of the environment whose configuration options you want to describe.

Returns:

A reference to this updated object so that method calls can be chained together.

getSolutionStackName

public String getSolutionStackName()

The name of the solution stack whose configuration options you want to describe.

Constraints:
Length: 0 - 100

Returns:

The name of the solution stack whose configuration options you want to describe.

setSolutionStackName

public void setSolutionStackName(String solutionStackName)

The name of the solution stack whose configuration options you want to describe.

Constraints:
Length: 0 - 100

Parameters:

solutionStackName - The name of the solution stack whose configuration options you want to describe.

withSolutionStackName

public DescribeConfigurationOptionsRequest withSolutionStackName(String solutionStackName)

The name of the solution stack whose configuration options you want to describe.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 100

Parameters:

solutionStackName - The name of the solution stack whose configuration options you want to describe.

Returns:

A reference to this updated object so that method calls can be chained together.

getOptions

public List<OptionSpecification> getOptions()

If specified, restricts the descriptions to only the specified options.

Returns:

If specified, restricts the descriptions to only the specified options.

setOptions

public void setOptions(Collection<OptionSpecification> options)

If specified, restricts the descriptions to only the specified options.

Parameters:

options - If specified, restricts the descriptions to only the specified options.

withOptions

public DescribeConfigurationOptionsRequest withOptions(OptionSpecification... options)

If specified, restricts the descriptions to only the specified options.

NOTE: This method appends the values to the existing list (if any). Use setOptions(java.util.Collection) or withOptions(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.

Parameters:

options - If specified, restricts the descriptions to only the specified options.

Returns:

A reference to this updated object so that method calls can be chained together.

withOptions

public DescribeConfigurationOptionsRequest withOptions(Collection<OptionSpecification> options)

If specified, restricts the descriptions to only the specified options.

Returns a reference to this object so that method calls can be chained together.

Parameters:

options - If specified, restricts the descriptions to only the specified options.

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

clone

public DescribeConfigurationOptionsRequest 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 class AmazonWebServiceRequest

See Also:

Object.clone()