software.amazon.awssdk.services.elasticbeanstalk.model

Class RequestEnvironmentInfoRequest

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.RequestEnvironmentInfoRequest

All Implemented Interfaces:

ToCopyableBuilder<RequestEnvironmentInfoRequest.Builder,RequestEnvironmentInfoRequest>

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

Request to retrieve logs from an environment and store them in your Elastic Beanstalk storage bucket.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RequestEnvironmentInfoRequest.Builder

Method Summary

Modifier and Type	Method and Description
static RequestEnvironmentInfoRequest.Builder	builder()
String	environmentId() The ID of the environment of the requested data.
String	environmentName() The name of the environment of the requested data.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
EnvironmentInfoType	infoType() The type of information to request.
String	infoTypeAsString() The type of information to request.
static Class<? extends RequestEnvironmentInfoRequest.Builder>	serializableBuilderClass()
RequestEnvironmentInfoRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

environmentId

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

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.

environmentName

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

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.

infoType

public EnvironmentInfoType infoType()

The type of information to request.

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 request.

See Also:

EnvironmentInfoType

infoTypeAsString

public String infoTypeAsString()

The type of information to request.

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 request.

See Also:

EnvironmentInfoType

toBuilder

public RequestEnvironmentInfoRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<RequestEnvironmentInfoRequest.Builder,RequestEnvironmentInfoRequest>

Specified by:

toBuilder in class ElasticBeanstalkRequest

Returns:

a builder for type T

builder

public static RequestEnvironmentInfoRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value