Class ProtectedQuerySummary

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

The protected query summary for the objects listed by the request.

See Also:

  • Method Details

    • id

      public final String id()

      The unique ID of the protected query.

      Returns:
      The unique ID of the protected query.

    • membershipId

      public final String membershipId()

      The unique ID for the membership that initiated the protected query.

      Returns:
      The unique ID for the membership that initiated the protected query.

    • membershipArn

      public final String membershipArn()

      The unique ARN for the membership that initiated the protected query.

      Returns:
      The unique ARN for the membership that initiated the protected query.

    • createTime

      public final Instant createTime()

      The time the protected query was created.

      Returns:
      The time the protected query was created.

    • status

      public final ProtectedQueryStatus status()

      The status of the protected 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 protected query.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the protected 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 protected query.
      See Also:

    • hasReceiverConfigurations

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

    • receiverConfigurations

      public final List<ReceiverConfiguration> receiverConfigurations()

      The receiver configuration.

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

      Returns:
      The receiver configuration.

    • toBuilder

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

    • builder

      public static ProtectedQuerySummary.Builder builder()

    • serializableBuilderClass

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