Class SchemaStatusDetail
- java.lang.Object
-
- software.amazon.awssdk.services.cleanrooms.model.SchemaStatusDetail
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<SchemaStatusDetail.Builder,SchemaStatusDetail>
@Generated("software.amazon.awssdk:codegen") public final class SchemaStatusDetail extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SchemaStatusDetail.Builder,SchemaStatusDetail>
Information about the schema status.
A status of
READYmeans that based on the schema analysis rule, queries of the given analysis rule type are properly configured to run queries on this schema.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceSchemaStatusDetail.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AnalysisRuleTypeanalysisRuleType()The analysis rule type for which the schema status has been evaluated.StringanalysisRuleTypeAsString()The analysis rule type for which the schema status has been evaluated.AnalysisTypeanalysisType()The type of analysis that can be performed on the schema.StringanalysisTypeAsString()The type of analysis that can be performed on the schema.static SchemaStatusDetail.Builderbuilder()List<SchemaConfiguration>configurations()The configuration details of the schema analysis rule for the given type.List<String>configurationsAsStrings()The configuration details of the schema analysis rule for the given type.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasConfigurations()For responses, this returns true if the service returned a value for the Configurations property.inthashCode()booleanhasReasons()For responses, this returns true if the service returned a value for the Reasons property.List<SchemaStatusReason>reasons()The reasons why the schema status is set to its current state.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends SchemaStatusDetail.Builder>serializableBuilderClass()SchemaStatusstatus()The status of the schema, indicating if it is ready to query.StringstatusAsString()The status of the schema, indicating if it is ready to query.SchemaStatusDetail.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
-
status
public final SchemaStatus status()
The status of the schema, indicating if it is ready to query.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnSchemaStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the schema, indicating if it is ready to query.
- See Also:
SchemaStatus
-
statusAsString
public final String statusAsString()
The status of the schema, indicating if it is ready to query.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnSchemaStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the schema, indicating if it is ready to query.
- See Also:
SchemaStatus
-
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 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.
-
reasons
public final List<SchemaStatusReason> reasons()
The reasons why the schema status is set to its current state.
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 why the schema status is set to its current state.
-
analysisRuleType
public final AnalysisRuleType analysisRuleType()
The analysis rule type for which the schema status has been evaluated.
If the service returns an enum value that is not available in the current SDK version,
analysisRuleTypewill returnAnalysisRuleType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromanalysisRuleTypeAsString().- Returns:
- The analysis rule type for which the schema status has been evaluated.
- See Also:
AnalysisRuleType
-
analysisRuleTypeAsString
public final String analysisRuleTypeAsString()
The analysis rule type for which the schema status has been evaluated.
If the service returns an enum value that is not available in the current SDK version,
analysisRuleTypewill returnAnalysisRuleType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromanalysisRuleTypeAsString().- Returns:
- The analysis rule type for which the schema status has been evaluated.
- See Also:
AnalysisRuleType
-
configurations
public final List<SchemaConfiguration> configurations()
The configuration details of the schema analysis rule for the given type.
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
hasConfigurations()method.- Returns:
- The configuration details of the schema analysis rule for the given type.
-
hasConfigurations
public final boolean hasConfigurations()
For responses, this returns true if the service returned a value for the Configurations 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.
-
configurationsAsStrings
public final List<String> configurationsAsStrings()
The configuration details of the schema analysis rule for the given type.
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
hasConfigurations()method.- Returns:
- The configuration details of the schema analysis rule for the given type.
-
analysisType
public final AnalysisType analysisType()
The type of analysis that can be performed on the schema.
A schema can have an
analysisTypeofDIRECT_ANALYSIS,ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION, or both.If the service returns an enum value that is not available in the current SDK version,
analysisTypewill returnAnalysisType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromanalysisTypeAsString().- Returns:
- The type of analysis that can be performed on the schema.
A schema can have an
analysisTypeofDIRECT_ANALYSIS,ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION, or both. - See Also:
AnalysisType
-
analysisTypeAsString
public final String analysisTypeAsString()
The type of analysis that can be performed on the schema.
A schema can have an
analysisTypeofDIRECT_ANALYSIS,ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION, or both.If the service returns an enum value that is not available in the current SDK version,
analysisTypewill returnAnalysisType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromanalysisTypeAsString().- Returns:
- The type of analysis that can be performed on the schema.
A schema can have an
analysisTypeofDIRECT_ANALYSIS,ADDITIONAL_ANALYSIS_FOR_AUDIENCE_GENERATION, or both. - See Also:
AnalysisType
-
toBuilder
public SchemaStatusDetail.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<SchemaStatusDetail.Builder,SchemaStatusDetail>
-
builder
public static SchemaStatusDetail.Builder builder()
-
serializableBuilderClass
public static Class<? extends SchemaStatusDetail.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
-
-