Class CreateCollaborationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cleanrooms.model.CleanRoomsRequest
software.amazon.awssdk.services.cleanrooms.model.CreateCollaborationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateCollaborationRequest.Builder,CreateCollaborationRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateCollaborationRequest extends CleanRoomsRequest implements ToCopyableBuilder<CreateCollaborationRequest.Builder,CreateCollaborationRequest>

  • Method Details

    • hasMembers

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

    • members

      public final List<MemberSpecification> members()

      A list of initial members, not including the creator. This list is immutable.

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

      Returns:
      A list of initial members, not including the creator. This list is immutable.

    • name

      public final String name()

      The display name for a collaboration.

      Returns:
      The display name for a collaboration.

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

    • creatorMemberAbilities

      public final List<MemberAbility> creatorMemberAbilities()

      The abilities granted to the collaboration creator.

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

      Returns:
      The abilities granted to the collaboration creator.

    • hasCreatorMemberAbilities

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

    • creatorMemberAbilitiesAsStrings

      public final List<String> creatorMemberAbilitiesAsStrings()

      The abilities granted to the collaboration creator.

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

      Returns:
      The abilities granted to the collaboration creator.

    • creatorMLMemberAbilities

      public final MLMemberAbilities creatorMLMemberAbilities()

      The ML abilities granted to the collaboration creator.

      Returns:
      The ML abilities granted to the collaboration creator.

    • creatorDisplayName

      public final String creatorDisplayName()

      The display name of the collaboration creator.

      Returns:
      The display name of the collaboration creator.

    • dataEncryptionMetadata

      public final DataEncryptionMetadata dataEncryptionMetadata()

      The settings for client-side encryption with Cryptographic Computing for Clean Rooms.

      Returns:
      The settings for client-side encryption with Cryptographic Computing for Clean Rooms.

    • 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()

      Specifies whether job logs are enabled for this collaboration.

      When ENABLED, Clean Rooms logs details about jobs run within this collaboration; 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:
      Specifies whether job logs are enabled for this collaboration.

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

      See Also:

    • jobLogStatusAsString

      public final String jobLogStatusAsString()

      Specifies whether job logs are enabled for this collaboration.

      When ENABLED, Clean Rooms logs details about jobs run within this collaboration; 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:
      Specifies whether job logs are enabled for this collaboration.

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

      See Also:

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

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

      Returns:
      An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

    • creatorPaymentConfiguration

      public final PaymentConfiguration creatorPaymentConfiguration()

      The collaboration creator's payment responsibilities set by the collaboration creator.

      If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer.

      Returns:
      The collaboration creator's payment responsibilities set by the collaboration creator.

      If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer.

    • analyticsEngine

      public final AnalyticsEngine analyticsEngine()

      The analytics engine.

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

    • analyticsEngineAsString

      public final String analyticsEngineAsString()

      The analytics engine.

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

    • toBuilder

      public CreateCollaborationRequest.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<CreateCollaborationRequest.Builder,CreateCollaborationRequest>
      Specified by:
      toBuilder in class CleanRoomsRequest
      Returns:
      a builder for type T

    • builder

      public static CreateCollaborationRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateCollaborationRequest.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)
      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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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