Class SchemaSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SchemaSummary.Builder,
SchemaSummary>
The schema summary for the objects listed by the request.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal AnalysisMethod
The analysis method for the associated schema.final String
The analysis method for the associated schema.final List
<AnalysisRuleType> The types of analysis rules that are associated with this schema object.The types of analysis rules that are associated with this schema object.static SchemaSummary.Builder
builder()
final String
The unique ARN for the collaboration that the schema belongs to.final String
The unique ID for the collaboration that the schema belongs to.final Instant
The time the schema object was created.final String
The unique account ID for the Amazon Web Services account that owns the schema.final boolean
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 boolean
For responses, this returns true if the service returned a value for the AnalysisRuleTypes property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SelectedAnalysisMethods property.final String
name()
The name for the schema object.final List
<SelectedAnalysisMethod> The selected analysis methods for the schema.The selected analysis methods for the schema.static Class
<? extends SchemaSummary.Builder> 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 SchemaType
type()
The type of schema object.final String
The type of schema object.final Instant
The time the schema object was last updated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
-
type
The type of schema object.
If the service returns an enum value that is not available in the current SDK version,
type
will returnSchemaType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of schema object.
- See Also:
-
typeAsString
The type of schema object.
If the service returns an enum value that is not available in the current SDK version,
type
will returnSchemaType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of schema object.
- See Also:
-
creatorAccountId
The unique account ID for the Amazon Web Services account that owns the schema.
- Returns:
- The unique account ID for the Amazon Web Services account that owns the schema.
-
createTime
The time the schema object was created.
- Returns:
- The time the schema object was created.
-
updateTime
The time the schema object was last updated.
- Returns:
- The time the schema object was last updated.
-
collaborationId
The unique ID for the collaboration that the schema belongs to.
- Returns:
- The unique ID for the collaboration that the schema belongs to.
-
collaborationArn
The unique ARN for the collaboration that the schema belongs to.
- Returns:
- The unique ARN for the collaboration that the schema belongs to.
-
analysisRuleTypes
The types of analysis rules that are associated with this schema object.
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
hasAnalysisRuleTypes()
method.- Returns:
- The types of analysis rules that are associated with this schema object.
-
hasAnalysisRuleTypes
public final boolean hasAnalysisRuleTypes()For responses, this returns true if the service returned a value for the AnalysisRuleTypes 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. -
analysisRuleTypesAsStrings
The types of analysis rules that are associated with this schema object.
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
hasAnalysisRuleTypes()
method.- Returns:
- The types of analysis rules that are associated with this schema object.
-
analysisMethod
The analysis method for the associated schema.
DIRECT_QUERY
allows SQL queries to be run directly on this table.DIRECT_JOB
allows PySpark jobs to be run directly on this table.MULTIPLE
allows both SQL queries and PySpark jobs to be run directly on this table.If the service returns an enum value that is not available in the current SDK version,
analysisMethod
will returnAnalysisMethod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromanalysisMethodAsString()
.- Returns:
- The analysis method for the associated schema.
DIRECT_QUERY
allows SQL queries to be run directly on this table.DIRECT_JOB
allows PySpark jobs to be run directly on this table.MULTIPLE
allows both SQL queries and PySpark jobs to be run directly on this table. - See Also:
-
analysisMethodAsString
The analysis method for the associated schema.
DIRECT_QUERY
allows SQL queries to be run directly on this table.DIRECT_JOB
allows PySpark jobs to be run directly on this table.MULTIPLE
allows both SQL queries and PySpark jobs to be run directly on this table.If the service returns an enum value that is not available in the current SDK version,
analysisMethod
will returnAnalysisMethod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromanalysisMethodAsString()
.- Returns:
- The analysis method for the associated schema.
DIRECT_QUERY
allows SQL queries to be run directly on this table.DIRECT_JOB
allows PySpark jobs to be run directly on this table.MULTIPLE
allows both SQL queries and PySpark jobs to be run directly on this table. - See Also:
-
selectedAnalysisMethods
The selected analysis methods for the schema.
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
hasSelectedAnalysisMethods()
method.- Returns:
- The selected analysis methods for the schema.
-
hasSelectedAnalysisMethods
public final boolean hasSelectedAnalysisMethods()For responses, this returns true if the service returned a value for the SelectedAnalysisMethods 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. -
selectedAnalysisMethodsAsStrings
The selected analysis methods for the schema.
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
hasSelectedAnalysisMethods()
method.- Returns:
- The selected analysis methods for the schema.
-
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 interfaceToCopyableBuilder<SchemaSummary.Builder,
SchemaSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-