Class Collaboration

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

The multi-party data share environment. The collaboration contains metadata about its purpose and participants.

See Also:

  • Method Details

    • id

      public final String id()

      The unique ID for the collaboration.

      Returns:
      The unique ID for the collaboration.

    • arn

      public final String arn()

      The unique ARN for the collaboration.

      Returns:
      The unique ARN for the collaboration.

    • name

      public final String name()

      A human-readable identifier provided by the collaboration owner. Display names are not unique.

      Returns:
      A human-readable identifier provided by the collaboration owner. Display names are not unique.

    • description

      public final String description()

      A description of the collaboration provided by the collaboration owner.

      Returns:
      A description of the collaboration provided by the collaboration owner.

    • creatorAccountId

      public final String creatorAccountId()

      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.

    • creatorDisplayName

      public final String creatorDisplayName()

      A display name of the collaboration creator.

      Returns:
      A display name of the collaboration creator.

    • createTime

      public final Instant createTime()

      The time when the collaboration was created.

      Returns:
      The time when the collaboration was created.

    • updateTime

      public final Instant updateTime()

      The time the collaboration metadata was last updated.

      Returns:
      The time the collaboration metadata was last updated.

    • memberStatus

      public final MemberStatus memberStatus()

      The status of a member in a collaboration.

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

      Returns:
      The status of a member in a collaboration.
      See Also:

    • memberStatusAsString

      public final String memberStatusAsString()

      The status of a member in a collaboration.

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

      Returns:
      The status of a member in a collaboration.
      See Also:

    • membershipId

      public final String membershipId()

      The unique ID for your membership within the collaboration.

      Returns:
      The unique ID for your membership within the collaboration.

    • membershipArn

      public final String membershipArn()

      The unique ARN for your membership within the collaboration.

      Returns:
      The unique ARN for your membership within the collaboration.

    • dataEncryptionMetadata

      public final DataEncryptionMetadata dataEncryptionMetadata()

      The settings for client-side encryption for cryptographic computing.

      Returns:
      The settings for client-side encryption for cryptographic computing.

    • queryLogStatus

      public final CollaborationQueryLogStatus queryLogStatus()

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

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

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

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

      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 CollaborationJobLogStatus 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 CollaborationJobLogStatus.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 CollaborationJobLogStatus.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:

    • analyticsEngine

      public final AnalyticsEngine analyticsEngine()

      The analytics engine for the collaboration.

      After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.

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

      Returns:
      The analytics engine for the collaboration.

      After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.

      See Also:

    • analyticsEngineAsString

      public final String analyticsEngineAsString()

      The analytics engine for the collaboration.

      After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.

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

      Returns:
      The analytics engine for the collaboration.

      After July 16, 2025, the CLEAN_ROOMS_SQL parameter will no longer be available.

      See Also:

    • autoApprovedChangeTypes

      public final List<AutoApprovedChangeType> autoApprovedChangeTypes()

      The types of change requests that are automatically approved for this collaboration.

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

      Returns:
      The types of change requests that are automatically approved for this collaboration.

    • hasAutoApprovedChangeTypes

      public final boolean hasAutoApprovedChangeTypes()
      For responses, this returns true if the service returned a value for the AutoApprovedChangeTypes 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.

    • autoApprovedChangeTypesAsStrings

      public final List<String> autoApprovedChangeTypesAsStrings()

      The types of change requests that are automatically approved for this collaboration.

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

      Returns:
      The types of change requests that are automatically approved for this collaboration.

    • allowedResultRegions

      public final List<SupportedS3Region> allowedResultRegions()

      The Amazon Web Services Regions where collaboration query results can be stored. Returns the list of Region identifiers that were specified when the collaboration was created. This list is used to enforce regional storage policies and compliance requirements.

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

      Returns:
      The Amazon Web Services Regions where collaboration query results can be stored. Returns the list of Region identifiers that were specified when the collaboration was created. This list is used to enforce regional storage policies and compliance requirements.

    • hasAllowedResultRegions

      public final boolean hasAllowedResultRegions()
      For responses, this returns true if the service returned a value for the AllowedResultRegions 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.

    • allowedResultRegionsAsStrings

      public final List<String> allowedResultRegionsAsStrings()

      The Amazon Web Services Regions where collaboration query results can be stored. Returns the list of Region identifiers that were specified when the collaboration was created. This list is used to enforce regional storage policies and compliance requirements.

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

      Returns:
      The Amazon Web Services Regions where collaboration query results can be stored. Returns the list of Region identifiers that were specified when the collaboration was created. This list is used to enforce regional storage policies and compliance requirements.

    • toBuilder

      public Collaboration.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<Collaboration.Builder,Collaboration>
      Returns:
      a builder for type T

    • builder

      public static Collaboration.Builder builder()

    • serializableBuilderClass

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