com.amazonaws.services.elasticbeanstalk.model

Class RequestEnvironmentInfoRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticbeanstalk.model.RequestEnvironmentInfoRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class RequestEnvironmentInfoRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the RequestEnvironmentInfo operation.

Initiates a request to compile the specified type of information of the deployed environment.

Setting the InfoType to tail compiles the last lines from the application server log files of every Amazon EC2 instance in your environment.

Setting the InfoType to bundle compresses the application server log files for every Amazon EC2 instance into a .zip file. Legacy and .NET containers do not support bundle logs.

Use RetrieveEnvironmentInfo to obtain the set of logs.

Related Topics

• RetrieveEnvironmentInfo

See Also:

AWSElasticBeanstalk.requestEnvironmentInfo(RequestEnvironmentInfoRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RequestEnvironmentInfoRequest() Default constructor for a new RequestEnvironmentInfoRequest object.
RequestEnvironmentInfoRequest(EnvironmentInfoType infoType) Constructs a new RequestEnvironmentInfoRequest object.
RequestEnvironmentInfoRequest(String infoType) Constructs a new RequestEnvironmentInfoRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
RequestEnvironmentInfoRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getEnvironmentId() The ID of the environment of the requested data.
String	getEnvironmentName() The name of the environment of the requested data.
String	getInfoType() The type of information to request.
int	hashCode()
void	setEnvironmentId(String environmentId) The ID of the environment of the requested data.
void	setEnvironmentName(String environmentName) The name of the environment of the requested data.
void	setInfoType(EnvironmentInfoType infoType) The type of information to request.
void	setInfoType(String infoType) The type of information to request.
String	toString() Returns a string representation of this object; useful for testing and debugging.
RequestEnvironmentInfoRequest	withEnvironmentId(String environmentId) The ID of the environment of the requested data.
RequestEnvironmentInfoRequest	withEnvironmentName(String environmentName) The name of the environment of the requested data.
RequestEnvironmentInfoRequest	withInfoType(EnvironmentInfoType infoType) The type of information to request.
RequestEnvironmentInfoRequest	withInfoType(String infoType) The type of information to request.

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

RequestEnvironmentInfoRequest

public RequestEnvironmentInfoRequest()

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

RequestEnvironmentInfoRequest

public RequestEnvironmentInfoRequest(String infoType)

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

Parameters:

infoType - The type of information to request.

RequestEnvironmentInfoRequest

public RequestEnvironmentInfoRequest(EnvironmentInfoType infoType)

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

Parameters:

infoType - The type of information to request.

Method Detail

getEnvironmentId

public String getEnvironmentId()

The ID of the environment of the requested data.

If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

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

Returns:

The ID of the environment of the requested data.

If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

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

setEnvironmentId

public void setEnvironmentId(String environmentId)

The ID of the environment of the requested data.

If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

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

Parameters:

environmentId - The ID of the environment of the requested data.

If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

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

withEnvironmentId

public RequestEnvironmentInfoRequest withEnvironmentId(String environmentId)

The ID of the environment of the requested data.

If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

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

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

Parameters:

environmentId - The ID of the environment of the requested data.

If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

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

Returns:

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

getEnvironmentName

public String getEnvironmentName()

The name of the environment of the requested data.

If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

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

Constraints:
Length: 4 - 23

Returns:

The name of the environment of the requested data.

If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

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

setEnvironmentName

public void setEnvironmentName(String environmentName)

The name of the environment of the requested data.

If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

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

Constraints:
Length: 4 - 23

Parameters:

environmentName - The name of the environment of the requested data.

If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

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

withEnvironmentName

public RequestEnvironmentInfoRequest withEnvironmentName(String environmentName)

The name of the environment of the requested data.

If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

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

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 of the requested data.

If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

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

Returns:

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

getInfoType

public String getInfoType()

The type of information to request.

Constraints:
Allowed Values: tail, bundle

Returns:

The type of information to request.

See Also:

EnvironmentInfoType

setInfoType

public void setInfoType(String infoType)

The type of information to request.

Constraints:
Allowed Values: tail, bundle

Parameters:

infoType - The type of information to request.

See Also:

EnvironmentInfoType

withInfoType

public RequestEnvironmentInfoRequest withInfoType(String infoType)

The type of information to request.

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

Constraints:
Allowed Values: tail, bundle

Parameters:

infoType - The type of information to request.

Returns:

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

See Also:

EnvironmentInfoType

setInfoType

public void setInfoType(EnvironmentInfoType infoType)

The type of information to request.

Constraints:
Allowed Values: tail, bundle

Parameters:

infoType - The type of information to request.

See Also:

EnvironmentInfoType

withInfoType

public RequestEnvironmentInfoRequest withInfoType(EnvironmentInfoType infoType)

The type of information to request.

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

Constraints:
Allowed Values: tail, bundle

Parameters:

infoType - The type of information to request.

Returns:

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

See Also:

EnvironmentInfoType

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