software.amazon.awssdk.services.elasticbeanstalk.model

Class DescribeEnvironmentsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeEnvironmentsRequest.Builder,DescribeEnvironmentsRequest>

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

Request to describe one or more environments.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeEnvironmentsRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	applicationName() If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.
static DescribeEnvironmentsRequest.Builder	builder()
List<String>	environmentIds() If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.
List<String>	environmentNames() If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEnvironmentIds() Returns true if the EnvironmentIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasEnvironmentNames() Returns true if the EnvironmentNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
Instant	includedDeletedBackTo() If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.
Boolean	includeDeleted() Indicates whether to include deleted environments:
Integer	maxRecords() For a paginated request.
String	nextToken() For a paginated request.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeEnvironmentsRequest.Builder>	serializableBuilderClass()
DescribeEnvironmentsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	versionLabel() If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

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

applicationName

public String applicationName()

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

Returns:

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

versionLabel

public String versionLabel()

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

Returns:

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

hasEnvironmentIds

public boolean hasEnvironmentIds()

Returns true if the EnvironmentIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

environmentIds

public List<String> environmentIds()

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasEnvironmentIds() to see if a value was sent in this field.

Returns:

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

hasEnvironmentNames

public boolean hasEnvironmentNames()

Returns true if the EnvironmentNames property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

environmentNames

public List<String> environmentNames()

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasEnvironmentNames() to see if a value was sent in this field.

Returns:

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

includeDeleted

public Boolean includeDeleted()

Indicates whether to include deleted environments:

true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

false: Do not include deleted environments.

Returns:

Indicates whether to include deleted environments:

true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

false: Do not include deleted environments.

includedDeletedBackTo

public Instant includedDeletedBackTo()

If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

Returns:

If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

maxRecords

public Integer maxRecords()

For a paginated request. Specify a maximum number of environments to include in each response.

If no MaxRecords is specified, all available environments are retrieved in a single response.

Returns:

For a paginated request. Specify a maximum number of environments to include in each response.

If no MaxRecords is specified, all available environments are retrieved in a single response.

nextToken

public String nextToken()

For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

If no NextToken is specified, the first page is retrieved.

Returns:

For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

If no NextToken is specified, the first page is retrieved.

toBuilder

public DescribeEnvironmentsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeEnvironmentsRequest.Builder,DescribeEnvironmentsRequest>

Specified by:

toBuilder in class ElasticBeanstalkRequest

builder

public static DescribeEnvironmentsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo