Class AnalysisRuleCustom

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

A type of analysis rule that enables the table owner to approve custom SQL queries on their configured tables. It supports differential privacy.

See Also:

  • Method Details

    • hasAllowedAnalyses

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

    • allowedAnalyses

      public final List<String> allowedAnalyses()

      The ARN of the analysis templates that are allowed by the custom analysis rule.

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

      Returns:
      The ARN of the analysis templates that are allowed by the custom analysis rule.

    • hasAllowedAnalysisProviders

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

    • allowedAnalysisProviders

      public final List<String> allowedAnalysisProviders()

      The IDs of the Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when allowedAnalyses is ANY_QUERY.

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

      Returns:
      The IDs of the Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when allowedAnalyses is ANY_QUERY.

    • additionalAnalyses

      public final AdditionalAnalyses additionalAnalyses()

      An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.

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

      Returns:
      An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.
      See Also:

    • additionalAnalysesAsString

      public final String additionalAnalysesAsString()

      An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.

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

      Returns:
      An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.
      See Also:

    • hasDisallowedOutputColumns

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

    • disallowedOutputColumns

      public final List<String> disallowedOutputColumns()

      A list of columns that aren't allowed to be shown in the query output.

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

      Returns:
      A list of columns that aren't allowed to be shown in the query output.

    • differentialPrivacy

      public final DifferentialPrivacyConfiguration differentialPrivacy()

      The differential privacy configuration.

      Returns:
      The differential privacy configuration.

    • toBuilder

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

    • builder

      public static AnalysisRuleCustom.Builder builder()

    • serializableBuilderClass

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