ListEnvironmentsRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.datazone.model.DataZoneRequest
    - - software.amazon.awssdk.services.datazone.model.ListEnvironmentsRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ListEnvironmentsRequest.Builder,ListEnvironmentsRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ListEnvironmentsRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ListEnvironmentsRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`awsAccountId()` The identifier of the Amazon Web Services account where you want to list environments.
`String`	`awsAccountRegion()` The Amazon Web Services region where you want to list environments.
`static ListEnvironmentsRequest.Builder`	`builder()`
`String`	`domainIdentifier()` The identifier of the Amazon DataZone domain.
`String`	`environmentBlueprintIdentifier()` The identifier of the Amazon DataZone blueprint.
`String`	`environmentProfileIdentifier()` The identifier of the environment profile.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`maxResults()` The maximum number of environments to return in a single call to `ListEnvironments`.
`String`	`name()`
`String`	`nextToken()` When the number of environments is greater than the default value for the `MaxResults` parameter, or if you explicitly specify a value for `MaxResults` that is less than the number of environments, the response includes a pagination token named `NextToken`.
`String`	`projectIdentifier()` The identifier of the Amazon DataZone project.
`String`	`provider()` The provider of the environment.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListEnvironmentsRequest.Builder>`	`serializableBuilderClass()`
`EnvironmentStatus`	`status()` The status of the environments that you want to list.
`String`	`statusAsString()` The status of the environments that you want to list.
`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
  - awsAccountId
```
public final String awsAccountId()
```
    The identifier of the Amazon Web Services account where you want to list environments.
    
    Returns:
    
    The identifier of the Amazon Web Services account where you want to list environments.
  - awsAccountRegion
```
public final String awsAccountRegion()
```
    The Amazon Web Services region where you want to list environments.
    
    Returns:
    
    The Amazon Web Services region where you want to list environments.
  - domainIdentifier
```
public final String domainIdentifier()
```
    The identifier of the Amazon DataZone domain.
    
    Returns:
    
    The identifier of the Amazon DataZone domain.
  - environmentBlueprintIdentifier
```
public final String environmentBlueprintIdentifier()
```
    The identifier of the Amazon DataZone blueprint.
    
    Returns:
    
    The identifier of the Amazon DataZone blueprint.
  - environmentProfileIdentifier
```
public final String environmentProfileIdentifier()
```
    The identifier of the environment profile.
    
    Returns:
    
    The identifier of the environment profile.
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of environments to return in a single call to ListEnvironments. When the number of environments to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEnvironments to list the next set of environments.
    
    Returns:
    
    The maximum number of environments to return in a single call to ListEnvironments. When the number of environments to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListEnvironments to list the next set of environments.
  - name
```
public final String name()
```
    Returns:
  - nextToken
```
public final String nextToken()
```
    When the number of environments is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environments, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironments to list the next set of environments.
    
    Returns:
    
    When the number of environments is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of environments, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListEnvironments to list the next set of environments.
  - projectIdentifier
```
public final String projectIdentifier()
```
    The identifier of the Amazon DataZone project.
    
    Returns:
    
    The identifier of the Amazon DataZone project.
  - provider
```
public final String provider()
```
    The provider of the environment.
    
    Returns:
    
    The provider of the environment.
  - status
```
public final EnvironmentStatus status()
```
    The status of the environments that you want to list.
    
    If the service returns an enum value that is not available in the current SDK version, status will return EnvironmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the environments that you want to list.
    
    See Also:
    
    EnvironmentStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the environments that you want to list.
    
    If the service returns an enum value that is not available in the current SDK version, status will return EnvironmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the environments that you want to list.
    
    See Also:
    
    EnvironmentStatus
  - toBuilder
```
public ListEnvironmentsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListEnvironmentsRequest.Builder,ListEnvironmentsRequest>
    
    Specified by:
    
    toBuilder in class DataZoneRequest
  - 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

Class ListEnvironmentsRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

awsAccountId

awsAccountRegion

domainIdentifier

environmentBlueprintIdentifier

environmentProfileIdentifier

maxResults

name

nextToken

projectIdentifier

provider

status

statusAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields