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() For responses, this returns true if the service returned a value for the EnvironmentIds property.
boolean	hasEnvironmentNames() For responses, this returns true if the service returned a value for the EnvironmentNames property.
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 final 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 final 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 final boolean hasEnvironmentIds()

For responses, this returns true if the service returned a value for the EnvironmentIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

environmentIds

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEnvironmentIds() method.

Returns:

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

hasEnvironmentNames

public final boolean hasEnvironmentNames()

For responses, this returns true if the service returned a value for the EnvironmentNames property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

environmentNames

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEnvironmentNames() method.

Returns:

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

includeDeleted

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