Package software.amazon.awssdk.services.cloud9.model

Class DescribeEnvironmentMembershipsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloud9.model.Cloud9Request

software.amazon.awssdk.services.cloud9.model.DescribeEnvironmentMembershipsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeEnvironmentMembershipsRequest.Builder,DescribeEnvironmentMembershipsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeEnvironmentMembershipsRequest
extends Cloud9Request
implements ToCopyableBuilder<DescribeEnvironmentMembershipsRequest.Builder,DescribeEnvironmentMembershipsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeEnvironmentMembershipsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeEnvironmentMembershipsRequest.Builder	builder()
String	environmentId()	The ID of the environment to get environment member information about.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPermissions()	For responses, this returns true if the service returned a value for the Permissions property.
Integer	maxResults()	The maximum number of environment members to get information about.
String	nextToken()	During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token.
List<Permissions>	permissions()	The type of environment member permissions to get information about.
List<String>	permissionsAsStrings()	The type of environment member permissions to get information about.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeEnvironmentMembershipsRequest.Builder>	serializableBuilderClass()
DescribeEnvironmentMembershipsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userArn()	The Amazon Resource Name (ARN) of an individual environment member to get information about.

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

userArn

public final String userArn()

The Amazon Resource Name (ARN) of an individual environment member to get information about. If no value is specified, information about all environment members are returned.

Returns:

The Amazon Resource Name (ARN) of an individual environment member to get information about. If no value is specified, information about all environment members are returned.

environmentId

public final String environmentId()

The ID of the environment to get environment member information about.

Returns:

The ID of the environment to get environment member information about.

permissions

public final List<Permissions> permissions()

The type of environment member permissions to get information about. Available values include:

• owner: Owns the environment.

• read-only: Has read-only access to the environment.

• read-write: Has read-write access to the environment.

If no value is specified, information about all environment members are returned.

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

Returns:

The type of environment member permissions to get information about. Available values include:

• owner: Owns the environment.

• read-only: Has read-only access to the environment.

• read-write: Has read-write access to the environment.

If no value is specified, information about all environment members are returned.

hasPermissions

public final boolean hasPermissions()

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

permissionsAsStrings

public final List<String> permissionsAsStrings()

The type of environment member permissions to get information about. Available values include:

• owner: Owns the environment.

• read-only: Has read-only access to the environment.

• read-write: Has read-write access to the environment.

If no value is specified, information about all environment members are returned.

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

Returns:

The type of environment member permissions to get information about. Available values include:

• owner: Owns the environment.

• read-only: Has read-only access to the environment.

• read-write: Has read-write access to the environment.

If no value is specified, information about all environment members are returned.

nextToken

public final String nextToken()

During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

Returns:

During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

maxResults

public final Integer maxResults()

The maximum number of environment members to get information about.

Returns:

The maximum number of environment members to get information about.

toBuilder

public DescribeEnvironmentMembershipsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeEnvironmentMembershipsRequest.Builder,DescribeEnvironmentMembershipsRequest>

Specified by:

toBuilder in class Cloud9Request

builder

public static DescribeEnvironmentMembershipsRequest.Builder builder()

serializableBuilderClass

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