Membership (AWS Java SDK :: Services :: Clean Rooms 2.20.75 API)

java.lang.Object
- software.amazon.awssdk.services.cleanrooms.model.Membership

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Membership.Builder,Membership>

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

The membership object.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Membership.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The unique ARN for the membership.
`static Membership.Builder`	`builder()`
`String`	`collaborationArn()` The unique ARN for the membership's associated collaboration.
`String`	`collaborationCreatorAccountId()` The identifier used to reference members of the collaboration.
`String`	`collaborationCreatorDisplayName()` The display name of the collaboration creator.
`String`	`collaborationId()` The unique ID for the membership's collaboration.
`String`	`collaborationName()` The name of the membership's collaboration.
`Instant`	`createTime()` The time when the membership was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasMemberAbilities()` For responses, this returns true if the service returned a value for the MemberAbilities property.
`String`	`id()` The unique ID of the membership.
`List<MemberAbility>`	`memberAbilities()` The abilities granted to the collaboration member.
`List<String>`	`memberAbilitiesAsStrings()` The abilities granted to the collaboration member.
`MembershipQueryLogStatus`	`queryLogStatus()` An indicator as to whether query logging has been enabled or disabled for the collaboration.
`String`	`queryLogStatusAsString()` An indicator as to whether query logging has been enabled or disabled for the collaboration.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Membership.Builder>`	`serializableBuilderClass()`
`MembershipStatus`	`status()` The status of the membership.
`String`	`statusAsString()` The status of the membership.
`Membership.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Instant`	`updateTime()` The time the membership 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
  - id
```
public final String id()
```
    The unique ID of the membership.
    
    Returns:
    
    The unique ID of the membership.
  - arn
```
public final String arn()
```
    The unique ARN for the membership.
    
    Returns:
    
    The unique ARN for the membership.
  - collaborationArn
```
public final String collaborationArn()
```
    The unique ARN for the membership's associated collaboration.
    
    Returns:
    
    The unique ARN for the membership's associated collaboration.
  - collaborationId
```
public final String collaborationId()
```
    The unique ID for the membership's collaboration.
    
    Returns:
    
    The unique ID for the membership's collaboration.
  - collaborationCreatorAccountId
```
public final String collaborationCreatorAccountId()
```
    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.
  - collaborationCreatorDisplayName
```
public final String collaborationCreatorDisplayName()
```
    The display name of the collaboration creator.
    
    Returns:
    
    The display name of the collaboration creator.
  - collaborationName
```
public final String collaborationName()
```
    The name of the membership's collaboration.
    
    Returns:
    
    The name of the membership's collaboration.
  - createTime
```
public final Instant createTime()
```
    The time when the membership was created.
    
    Returns:
    
    The time when the membership was created.
  - updateTime
```
public final Instant updateTime()
```
    The time the membership metadata was last updated.
    
    Returns:
    
    The time the membership metadata was last updated.
  - status
```
public final MembershipStatus status()
```
    The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and `COLLABORATION_DELETED`.
    
    If the service returns an enum value that is not available in the current SDK version, status will return MembershipStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and `COLLABORATION_DELETED`.
    
    See Also:
    
    MembershipStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and `COLLABORATION_DELETED`.
    
    If the service returns an enum value that is not available in the current SDK version, status will return MembershipStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the membership. Valid values are `ACTIVE`, `REMOVED`, and `COLLABORATION_DELETED`.
    
    See Also:
    
    MembershipStatus
  - memberAbilities
```
public final List<MemberAbility> memberAbilities()
```
    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 hasMemberAbilities() method.
    
    Returns:
    
    The abilities granted to the collaboration member.
  - hasMemberAbilities
```
public final boolean hasMemberAbilities()
```
    For responses, this returns true if the service returned a value for the MemberAbilities 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.
  - memberAbilitiesAsStrings
```
public final List<String> memberAbilitiesAsStrings()
```
    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 hasMemberAbilities() method.
    
    Returns:
    
    The abilities granted to the collaboration member.
  - queryLogStatus
```
public final MembershipQueryLogStatus queryLogStatus()
```
    An indicator as to whether query logging has been enabled or disabled for the collaboration.
    
    If the service returns an enum value that is not available in the current SDK version, queryLogStatus will return MembershipQueryLogStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryLogStatusAsString().
    
    Returns:
    
    An indicator as to whether query logging has been enabled or disabled for the collaboration.
    
    See Also:
    
    MembershipQueryLogStatus
  - queryLogStatusAsString
```
public final String queryLogStatusAsString()
```
    An indicator as to whether query logging has been enabled or disabled for the collaboration.
    
    If the service returns an enum value that is not available in the current SDK version, queryLogStatus will return MembershipQueryLogStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryLogStatusAsString().
    
    Returns:
    
    An indicator as to whether query logging has been enabled or disabled for the collaboration.
    
    See Also:
    
    MembershipQueryLogStatus
  - toBuilder
```
public Membership.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Membership.Builder,Membership>
  - builder
```
public static Membership.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Membership.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

Class Membership

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

id

arn

collaborationArn

collaborationId

collaborationCreatorAccountId

collaborationCreatorDisplayName

collaborationName

createTime

updateTime

status

statusAsString

memberAbilities

hasMemberAbilities

memberAbilitiesAsStrings

queryLogStatus

queryLogStatusAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields