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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAnalysisRuleCustom.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AdditionalAnalysesadditionalAnalyses()An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.StringadditionalAnalysesAsString()An indicator as to whether additional analyses (such as Clean Rooms ML) can be applied to the output of the direct query.List<String>allowedAnalyses()The ARN of the analysis templates that are allowed by the custom analysis rule.List<String>allowedAnalysisProviders()The IDs of the Amazon Web Services accounts that are allowed to query by the custom analysis rule.static AnalysisRuleCustom.Builderbuilder()DifferentialPrivacyConfigurationdifferentialPrivacy()The differential privacy configuration.List<String>disallowedOutputColumns()A list of columns that aren't allowed to be shown in the query output.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAllowedAnalyses()For responses, this returns true if the service returned a value for the AllowedAnalyses property.booleanhasAllowedAnalysisProviders()For responses, this returns true if the service returned a value for the AllowedAnalysisProviders property.booleanhasDisallowedOutputColumns()For responses, this returns true if the service returned a value for the DisallowedOutputColumns property.inthashCode()Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends AnalysisRuleCustom.Builder>serializableBuilderClass()AnalysisRuleCustom.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 theisEmpty()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 theisEmpty()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
allowedAnalysesisANY_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
allowedAnalysesisANY_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,
additionalAnalyseswill returnAdditionalAnalyses.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromadditionalAnalysesAsString().- 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:
AdditionalAnalyses
-
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,
additionalAnalyseswill returnAdditionalAnalyses.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromadditionalAnalysesAsString().- 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:
AdditionalAnalyses
-
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 theisEmpty()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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AnalysisRuleCustom.Builder,AnalysisRuleCustom>
-
builder
public static AnalysisRuleCustom.Builder builder()
-
serializableBuilderClass
public static Class<? extends AnalysisRuleCustom.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-