RetrieveEnvironmentInfoRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.elasticbeanstalk.model.RetrieveEnvironmentInfoRequest

All Implemented Interfaces:

Serializable
```
public class RetrieveEnvironmentInfoRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the RetrieveEnvironmentInfo operation.
Retrieves the compiled information from a RequestEnvironmentInfo request.

Related Topics
- RequestEnvironmentInfo
See Also:
AWSElasticBeanstalk.retrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest), Serialized Form

Constructor Summary

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

Method Summary

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

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
  - RetrieveEnvironmentInfoRequest
```
public RetrieveEnvironmentInfoRequest()
```
    Default constructor for a new RetrieveEnvironmentInfoRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.
  - RetrieveEnvironmentInfoRequest
```
public RetrieveEnvironmentInfoRequest(String infoType)
```
    Constructs a new RetrieveEnvironmentInfoRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
    
    Parameters:
    infoType - The type of information to retrieve.
  - RetrieveEnvironmentInfoRequest
```
public RetrieveEnvironmentInfoRequest(EnvironmentInfoType infoType)
```
    Constructs a new RetrieveEnvironmentInfoRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
    
    Parameters:
    infoType - The type of information to retrieve.
- Method Detail
  - getEnvironmentId
```
public String getEnvironmentId()
```
    The ID of the data's environment.
    If no such environment is found, 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 data's environment.
    If no such environment is found, 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 data's environment.
    If no such environment is found, 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 data's environment.
    If no such environment is found, 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 RetrieveEnvironmentInfoRequest withEnvironmentId(String environmentId)
```
    The ID of the data's environment.
    If no such environment is found, 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 data's environment.
    If no such environment is found, 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 data's environment.
    If no such environment is found, 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 data's environment.
    If no such environment is found, 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 data's environment.
    If no such environment is found, 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 data's environment.
    If no such environment is found, 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 RetrieveEnvironmentInfoRequest withEnvironmentName(String environmentName)
```
    The name of the data's environment.
    If no such environment is found, 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 data's environment.
    If no such environment is found, 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 retrieve.
    Constraints:
    Allowed Values: tail
    
    Returns:
    The type of information to retrieve.
    See Also:
    EnvironmentInfoType
  - setInfoType
```
public void setInfoType(String infoType)
```
    The type of information to retrieve.
    Constraints:
    Allowed Values: tail
    
    Parameters:
    infoType - The type of information to retrieve.
    See Also:
    EnvironmentInfoType
  - withInfoType
```
public RetrieveEnvironmentInfoRequest withInfoType(String infoType)
```
    The type of information to retrieve.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: tail
    
    Parameters:
    infoType - The type of information to retrieve.
    
    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 retrieve.
    Constraints:
    Allowed Values: tail
    
    Parameters:
    infoType - The type of information to retrieve.
    See Also:
    EnvironmentInfoType
  - withInfoType
```
public RetrieveEnvironmentInfoRequest withInfoType(EnvironmentInfoType infoType)
```
    The type of information to retrieve.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: tail
    
    Parameters:
    infoType - The type of information to retrieve.
    
    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

Did this page help you?

Class RetrieveEnvironmentInfoRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

RetrieveEnvironmentInfoRequest

RetrieveEnvironmentInfoRequest

RetrieveEnvironmentInfoRequest

Method Detail

getEnvironmentId

setEnvironmentId

withEnvironmentId

getEnvironmentName

setEnvironmentName

withEnvironmentName

getInfoType

setInfoType

withInfoType

setInfoType

withInfoType

toString

hashCode

equals