Class AnalysisTemplateValidationStatusDetail

java.lang.Object

software.amazon.awssdk.services.cleanrooms.model.AnalysisTemplateValidationStatusDetail

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AnalysisTemplateValidationStatusDetail.Builder,AnalysisTemplateValidationStatusDetail>

@Generated("software.amazon.awssdk:codegen")
public final class AnalysisTemplateValidationStatusDetail
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AnalysisTemplateValidationStatusDetail.Builder,AnalysisTemplateValidationStatusDetail>

The status details of the analysis template validation. Clean Rooms Differential Privacy uses a general-purpose query structure to support complex SQL queries and validates whether an analysis template fits that general-purpose query structure. Validation is performed when analysis templates are created and fetched. Because analysis templates are immutable by design, we recommend that you create analysis templates after you associate the configured tables with their analysis rule to your collaboration.

For more information, see https://docs.aws.amazon.com/clean-rooms/latest/userguide/analysis-rules-custom.html#custom-diff-privacy.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AnalysisTemplateValidationStatusDetail.Builder

Method Summary

Modifier and Type	Method	Description
static AnalysisTemplateValidationStatusDetail.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final boolean	hasReasons()	For responses, this returns true if the service returned a value for the Reasons property.
final List<AnalysisTemplateValidationStatusReason>	reasons()	The reasons for the validation results.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends AnalysisTemplateValidationStatusDetail.Builder>	serializableBuilderClass()
final AnalysisTemplateValidationStatus	status()	The status of the validation.
final String	statusAsString()	The status of the validation.
AnalysisTemplateValidationStatusDetail.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.
final AnalysisTemplateValidationType	type()	The type of validation that was performed.
final String	typeAsString()	The type of validation that was performed.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

type

public final AnalysisTemplateValidationType type()

The type of validation that was performed.

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

Returns:

The type of validation that was performed.

See Also:

• AnalysisTemplateValidationType

typeAsString

public final String typeAsString()

The type of validation that was performed.

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

Returns:

The type of validation that was performed.

See Also:

• AnalysisTemplateValidationType

status

public final AnalysisTemplateValidationStatus status()

The status of the validation.

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

Returns:

The status of the validation.

See Also:

• AnalysisTemplateValidationStatus

statusAsString

public final String statusAsString()

The status of the validation.

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

Returns:

The status of the validation.

See Also:

• AnalysisTemplateValidationStatus

hasReasons

public final boolean hasReasons()

For responses, this returns true if the service returned a value for the Reasons 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.

reasons

public final List<AnalysisTemplateValidationStatusReason> reasons()

The reasons for the validation results.

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

Returns:

The reasons for the validation results.

toBuilder

public AnalysisTemplateValidationStatusDetail.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<AnalysisTemplateValidationStatusDetail.Builder,AnalysisTemplateValidationStatusDetail>

Returns:

a builder for type T

builder

public static AnalysisTemplateValidationStatusDetail.Builder builder()

serializableBuilderClass

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