software.amazon.awssdk.services.cleanrooms.model

Class MemberSummary

java.lang.Object

software.amazon.awssdk.services.cleanrooms.model.MemberSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MemberSummary.Builder,MemberSummary>

@Generated(value="software.amazon.awssdk:codegen")
public final class MemberSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MemberSummary.Builder,MemberSummary>

The member object listed by the request.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MemberSummary.Builder

Method Summary

Modifier and Type	Method and Description
List<MemberAbility>	abilities() The abilities granted to the collaboration member.
List<String>	abilitiesAsStrings() The abilities granted to the collaboration member.
String	accountId() The identifier used to reference members of the collaboration.
static MemberSummary.Builder	builder()
Instant	createTime() The time when the member was created.
String	displayName() The member's display name.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAbilities() For responses, this returns true if the service returned a value for the Abilities property.
int	hashCode()
String	membershipArn() The unique ARN for the member's associated membership, if present.
String	membershipId() The unique ID for the member's associated membership, if present.
List<SdkField<?>>	sdkFields()
static Class<? extends MemberSummary.Builder>	serializableBuilderClass()
MemberStatus	status() The status of the member.
String	statusAsString() The status of the member.
MemberSummary.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Instant	updateTime() The time the member metadata was last updated.

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

accountId

public final String accountId()

The identifier used to reference members of the collaboration. Currently only supports AWS Account ID.

Returns:

The identifier used to reference members of the collaboration. Currently only supports AWS Account ID.

status

public final MemberStatus status()

The status of the member. Valid values are `INVITED`, `ACTIVE`, `LEFT`, and `REMOVED`.

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

Returns:

The status of the member. Valid values are `INVITED`, `ACTIVE`, `LEFT`, and `REMOVED`.

See Also:

MemberStatus

statusAsString

public final String statusAsString()

The status of the member. Valid values are `INVITED`, `ACTIVE`, `LEFT`, and `REMOVED`.

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

Returns:

The status of the member. Valid values are `INVITED`, `ACTIVE`, `LEFT`, and `REMOVED`.

See Also:

MemberStatus

displayName

public final String displayName()

The member's display name.

Returns:

The member's display name.

abilities

public final List<MemberAbility> abilities()

The abilities granted to the collaboration member.

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

Returns:

The abilities granted to the collaboration member.

hasAbilities

public final boolean hasAbilities()

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

abilitiesAsStrings

public final List<String> abilitiesAsStrings()

The abilities granted to the collaboration member.

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

Returns:

The abilities granted to the collaboration member.

createTime

public final Instant createTime()

The time when the member was created.

Returns:

The time when the member was created.

updateTime

public final Instant updateTime()

The time the member metadata was last updated.

Returns:

The time the member metadata was last updated.

membershipId

public final String membershipId()

The unique ID for the member's associated membership, if present.

Returns:

The unique ID for the member's associated membership, if present.

membershipArn

public final String membershipArn()

The unique ARN for the member's associated membership, if present.

Returns:

The unique ARN for the member's associated membership, if present.

toBuilder

public MemberSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MemberSummary.Builder,MemberSummary>

builder

public static MemberSummary.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo