Class Membership

java.lang.Object
software.amazon.awssdk.services.cleanrooms.model.Membership
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Membership.Builder,Membership>
@Generated("software.amazon.awssdk:codegen") public final class Membership extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Membership.Builder,Membership>

The membership object.

See Also:

  • Method Details

    • 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 Amazon Web Services account ID.

      Returns:
      The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services 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.

      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.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the membership.

      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.
      See Also:

    • 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.

    • mlMemberAbilities

      public final MLMemberAbilities mlMemberAbilities()

      Specifies the ML member abilities that are granted to a collaboration member.

      Returns:
      Specifies the ML member abilities that are granted to a collaboration member.

    • queryLogStatus

      public final MembershipQueryLogStatus queryLogStatus()

      An indicator as to whether query logging has been enabled or disabled for the membership.

      When ENABLED, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.

      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 membership.

      When ENABLED, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.

      See Also:

    • queryLogStatusAsString

      public final String queryLogStatusAsString()

      An indicator as to whether query logging has been enabled or disabled for the membership.

      When ENABLED, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.

      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 membership.

      When ENABLED, Clean Rooms logs details about queries run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.

      See Also:

    • jobLogStatus

      public final MembershipJobLogStatus jobLogStatus()

      An indicator as to whether job logging has been enabled or disabled for the collaboration.

      When ENABLED, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.

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

      Returns:
      An indicator as to whether job logging has been enabled or disabled for the collaboration.

      When ENABLED, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.

      See Also:

    • jobLogStatusAsString

      public final String jobLogStatusAsString()

      An indicator as to whether job logging has been enabled or disabled for the collaboration.

      When ENABLED, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.

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

      Returns:
      An indicator as to whether job logging has been enabled or disabled for the collaboration.

      When ENABLED, Clean Rooms logs details about jobs run within this collaboration and those logs can be viewed in Amazon CloudWatch Logs. The default value is DISABLED.

      See Also:

    • defaultResultConfiguration

      public final MembershipProtectedQueryResultConfiguration defaultResultConfiguration()

      The default protected query result configuration as specified by the member who can receive results.

      Returns:
      The default protected query result configuration as specified by the member who can receive results.

    • defaultJobResultConfiguration

      public final MembershipProtectedJobResultConfiguration defaultJobResultConfiguration()

      The default job result configuration for the membership.

      Returns:
      The default job result configuration for the membership.

    • paymentConfiguration

      public final MembershipPaymentConfiguration paymentConfiguration()

      The payment responsibilities accepted by the collaboration member.

      Returns:
      The payment responsibilities accepted by the collaboration member.

    • toBuilder

      public Membership.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Membership.Builder,Membership>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.