software.amazon.awssdk.services.elasticbeanstalk.model

Class RetrieveEnvironmentInfoRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.elasticbeanstalk.model.ElasticBeanstalkRequest

software.amazon.awssdk.services.elasticbeanstalk.model.RetrieveEnvironmentInfoRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RetrieveEnvironmentInfoRequest.Builder,RetrieveEnvironmentInfoRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class RetrieveEnvironmentInfoRequest
extends ElasticBeanstalkRequest
implements ToCopyableBuilder<RetrieveEnvironmentInfoRequest.Builder,RetrieveEnvironmentInfoRequest>

Request to download logs retrieved with RequestEnvironmentInfo.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RetrieveEnvironmentInfoRequest.Builder

Method Summary

Modifier and Type	Method and Description
static RetrieveEnvironmentInfoRequest.Builder	builder()
String	environmentId() The ID of the data's environment.
String	environmentName() The name of the data's environment.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
EnvironmentInfoType	infoType() The type of information to retrieve.
String	infoTypeAsString() The type of information to retrieve.
List<SdkField<?>>	sdkFields()
static Class<? extends RetrieveEnvironmentInfoRequest.Builder>	serializableBuilderClass()
RetrieveEnvironmentInfoRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

environmentId

public final 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:

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.

environmentName

public final 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:

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.

infoType

public final EnvironmentInfoType infoType()

The type of information to retrieve.

If the service returns an enum value that is not available in the current SDK version, infoType will return EnvironmentInfoType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from infoTypeAsString().

Returns:

The type of information to retrieve.

See Also:

EnvironmentInfoType

infoTypeAsString

public final String infoTypeAsString()

The type of information to retrieve.

If the service returns an enum value that is not available in the current SDK version, infoType will return EnvironmentInfoType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from infoTypeAsString().

Returns:

The type of information to retrieve.

See Also:

EnvironmentInfoType

toBuilder

public RetrieveEnvironmentInfoRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RetrieveEnvironmentInfoRequest.Builder,RetrieveEnvironmentInfoRequest>

Specified by:

toBuilder in class ElasticBeanstalkRequest

builder

public static RetrieveEnvironmentInfoRequest.Builder builder()

serializableBuilderClass

public static Class<? extends RetrieveEnvironmentInfoRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo