Class DescribeConfigurationSettingsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticbeanstalk.model.DescribeConfigurationSettingsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeConfigurationSettingsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Result message containing all of the configuration settings for a specified solution stack or configuration template.

See Also:

• Serialized Form

Field Summary

Fields inherited from class AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
DescribeConfigurationSettingsRequest()	Default constructor for DescribeConfigurationSettingsRequest object.
DescribeConfigurationSettingsRequest(String applicationName)	Constructs a new DescribeConfigurationSettingsRequest object.

Method Summary

Modifier and Type	Method	Description
DescribeConfigurationSettingsRequest	clone()	Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getApplicationName()	The application for the environment or configuration template.
String	getEnvironmentName()	The name of the environment to describe.
String	getTemplateName()	The name of the configuration template to describe.
int	hashCode()
void	setApplicationName(String applicationName)	The application for the environment or configuration template.
void	setEnvironmentName(String environmentName)	The name of the environment to describe.
void	setTemplateName(String templateName)	The name of the configuration template to describe.
String	toString()	Returns a string representation of this object; useful for testing and debugging.
DescribeConfigurationSettingsRequest	withApplicationName(String applicationName)	The application for the environment or configuration template.
DescribeConfigurationSettingsRequest	withEnvironmentName(String environmentName)	The name of the environment to describe.
DescribeConfigurationSettingsRequest	withTemplateName(String templateName)	The name of the configuration template to describe.

Methods inherited from class 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

Methods inherited from class Object

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

Constructor Details

DescribeConfigurationSettingsRequest

public DescribeConfigurationSettingsRequest()

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

DescribeConfigurationSettingsRequest

public DescribeConfigurationSettingsRequest(String applicationName)

Constructs a new DescribeConfigurationSettingsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

applicationName - The application for the environment or configuration template.

Method Details

setApplicationName

public void setApplicationName(String applicationName)

The application for the environment or configuration template.

Parameters:

applicationName - The application for the environment or configuration template.

getApplicationName

public String getApplicationName()

The application for the environment or configuration template.

Returns:

The application for the environment or configuration template.

withApplicationName

public DescribeConfigurationSettingsRequest withApplicationName(String applicationName)

The application for the environment or configuration template.

Parameters:

applicationName - The application for the environment or configuration template.

Returns:

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

setTemplateName

public void setTemplateName(String templateName)

The name of the configuration template to describe.

Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

Parameters:

templateName - The name of the configuration template to describe.

Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

getTemplateName

public String getTemplateName()

The name of the configuration template to describe.

Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

Returns:

The name of the configuration template to describe.

Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

withTemplateName

public DescribeConfigurationSettingsRequest withTemplateName(String templateName)

The name of the configuration template to describe.

Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

Parameters:

templateName - The name of the configuration template to describe.

Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

Returns:

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

setEnvironmentName

public void setEnvironmentName(String environmentName)

The name of the environment to describe.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Parameters:

environmentName - The name of the environment to describe.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

getEnvironmentName

public String getEnvironmentName()

The name of the environment to describe.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Returns:

The name of the environment to describe.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

withEnvironmentName

public DescribeConfigurationSettingsRequest withEnvironmentName(String environmentName)

The name of the environment to describe.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Parameters:

environmentName - The name of the environment to describe.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

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 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 DescribeConfigurationSettingsRequest 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()