software.amazon.awssdk.services.m2.model

Class ListEnvironmentsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.m2.model.M2Request

software.amazon.awssdk.services.m2.model.ListEnvironmentsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListEnvironmentsRequest.Builder,ListEnvironmentsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListEnvironmentsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListEnvironmentsRequest.Builder	builder()
EngineType	engineType() The engine type for the environment.
String	engineTypeAsString() The engine type for the environment.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasNames() For responses, this returns true if the service returned a value for the Names property.
Integer	maxResults() The maximum number of environments to return.
List<String>	names() The name of the environment.
String	nextToken() A pagination token to control the number of environments displayed in the list.
List<SdkField<?>>	sdkFields()
static Class<? extends ListEnvironmentsRequest.Builder>	serializableBuilderClass()
ListEnvironmentsRequest.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

engineType

public final EngineType engineType()

The engine type for the environment.

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

Returns:

The engine type for the environment.

See Also:

EngineType

engineTypeAsString

public final String engineTypeAsString()

The engine type for the environment.

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

Returns:

The engine type for the environment.

See Also:

EngineType

maxResults

public final Integer maxResults()

The maximum number of environments to return.

Returns:

The maximum number of environments to return.

hasNames

public final boolean hasNames()

For responses, this returns true if the service returned a value for the Names 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.

names

public final List<String> names()

The name of the environment.

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 hasNames() method.

Returns:

The name of the environment.

nextToken

public final String nextToken()

A pagination token to control the number of environments displayed in the list.

Returns:

A pagination token to control the number of environments displayed in the list.

toBuilder

public ListEnvironmentsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListEnvironmentsRequest.Builder,ListEnvironmentsRequest>

Specified by:

toBuilder in class M2Request

builder

public static ListEnvironmentsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListEnvironmentsRequest.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