Class ProtectedQuery

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

The parameters for an Clean Rooms protected query.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier for a protected query instance.

      Returns:
      The identifier for a protected query instance.

    • membershipId

      public final String membershipId()

      The identifier for the membership.

      Returns:
      The identifier for the membership.

    • membershipArn

      public final String membershipArn()

      The ARN of the membership.

      Returns:
      The ARN of the membership.

    • createTime

      public final Instant createTime()

      The time at which the protected query was created.

      Returns:
      The time at which the protected query was created.

    • sqlParameters

      public final ProtectedQuerySQLParameters sqlParameters()

      The protected query SQL parameters.

      Returns:
      The protected query SQL parameters.

    • status

      public final ProtectedQueryStatus status()

      The status of the query.

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

      Returns:
      The status of the query.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the query.

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

      Returns:
      The status of the query.
      See Also:

    • resultConfiguration

      public final ProtectedQueryResultConfiguration resultConfiguration()

      Contains any details needed to write the query results.

      Returns:
      Contains any details needed to write the query results.

    • statistics

      public final ProtectedQueryStatistics statistics()

      Statistics about protected query execution.

      Returns:
      Statistics about protected query execution.

    • result

      public final ProtectedQueryResult result()

      The result of the protected query.

      Returns:
      The result of the protected query.

    • error

      public final ProtectedQueryError error()

      An error thrown by the protected query.

      Returns:
      An error thrown by the protected query.

    • differentialPrivacy

      public final DifferentialPrivacyParameters differentialPrivacy()

      The sensitivity parameters of the differential privacy results of the protected query.

      Returns:
      The sensitivity parameters of the differential privacy results of the protected query.

    • computeConfiguration

      public final ComputeConfiguration computeConfiguration()

      The compute configuration for the protected query.

      Returns:
      The compute configuration for the protected query.

    • toBuilder

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

    • builder

      public static ProtectedQuery.Builder builder()

    • serializableBuilderClass

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