Package software.amazon.awssdk.services.cleanrooms.model

Class CreateCollaborationRequest

    • Method Detail

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

        Custom ML modeling is in beta release and is subject to change. For beta terms and conditions, see Betas and Previews in the Amazon Web Services Service Terms.

        Returns:
        The ML abilities granted to the collaboration creator.

        Custom ML modeling is in beta release and is subject to change. For beta terms and conditions, see Betas and Previews in the Amazon Web Services Service Terms.

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

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

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

      • 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