Schema (AWS Java SDK :: Services :: Clean Rooms 2.20.75 API)

java.lang.Object
- software.amazon.awssdk.services.cleanrooms.model.Schema

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Schema.Builder,Schema>

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

A schema is a relation within a collaboration.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Schema.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Schema.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AnalysisMethod`	`analysisMethod()` The analysis method for the schema.
`String`	`analysisMethodAsString()` The analysis method for the schema.
`List<AnalysisRuleType>`	`analysisRuleTypes()` The analysis rule types associated with the schema.
`List<String>`	`analysisRuleTypesAsStrings()` The analysis rule types associated with the schema.
`static Schema.Builder`	`builder()`
`String`	`collaborationArn()` The unique ARN for the collaboration that the schema belongs to.
`String`	`collaborationId()` The unique ID for the collaboration that the schema belongs to.
`List<Column>`	`columns()` The columns for the relation this schema represents.
`Instant`	`createTime()` The time the schema was created.
`String`	`creatorAccountId()` The unique account ID for the AWS account that owns the schema.
`String`	`description()` A description for the schema.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAnalysisRuleTypes()` For responses, this returns true if the service returned a value for the AnalysisRuleTypes property.
`boolean`	`hasColumns()` For responses, this returns true if the service returned a value for the Columns property.
`int`	`hashCode()`
`boolean`	`hasPartitionKeys()` For responses, this returns true if the service returned a value for the PartitionKeys property.
`String`	`name()` A name for the schema.
`List<Column>`	`partitionKeys()` The partition keys for the dataset underlying this schema.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Schema.Builder>`	`serializableBuilderClass()`
`Schema.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`SchemaType`	`type()` The type of schema.
`String`	`typeAsString()` The type of schema.
`Instant`	`updateTime()` The time the schema was last updated.

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
  - hasColumns
```
public final boolean hasColumns()
```
    For responses, this returns true if the service returned a value for the Columns 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.
  - columns
```
public final List<Column> columns()
```
    The columns for the relation this schema represents.
    
    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 hasColumns() method.
    
    Returns:
    
    The columns for the relation this schema represents.
  - hasPartitionKeys
```
public final boolean hasPartitionKeys()
```
    For responses, this returns true if the service returned a value for the PartitionKeys 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.
  - partitionKeys
```
public final List<Column> partitionKeys()
```
    The partition keys for the dataset underlying this 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 hasPartitionKeys() method.
    
    Returns:
    
    The partition keys for the dataset underlying this schema.
  - analysisRuleTypes
```
public final List<AnalysisRuleType> analysisRuleTypes()
```
    The analysis rule types associated with the schema. Valued values are LIST and AGGREGATION. Currently, only one entry is present.
    
    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 analysis rule types associated with the schema. Valued values are LIST and AGGREGATION. Currently, only one entry is present.
  - 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 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.
  - analysisRuleTypesAsStrings
```
public final List<String> analysisRuleTypesAsStrings()
```
    The analysis rule types associated with the schema. Valued values are LIST and AGGREGATION. Currently, only one entry is present.
    
    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 analysis rule types associated with the schema. Valued values are LIST and AGGREGATION. Currently, only one entry is present.
  - analysisMethod
```
public final AnalysisMethod analysisMethod()
```
    The analysis method for the schema. The only valid value is currently DIRECT_QUERY.
    
    If the service returns an enum value that is not available in the current SDK version, analysisMethod will return AnalysisMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from analysisMethodAsString().
    
    Returns:
    
    The analysis method for the schema. The only valid value is currently DIRECT_QUERY.
    
    See Also:
    
    AnalysisMethod
  - analysisMethodAsString
```
public final String analysisMethodAsString()
```
    The analysis method for the schema. The only valid value is currently DIRECT_QUERY.
    
    If the service returns an enum value that is not available in the current SDK version, analysisMethod will return AnalysisMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from analysisMethodAsString().
    
    Returns:
    
    The analysis method for the schema. The only valid value is currently DIRECT_QUERY.
    
    See Also:
    
    AnalysisMethod
  - creatorAccountId
```
public final String creatorAccountId()
```
    The unique account ID for the AWS account that owns the schema.
    
    Returns:
    
    The unique account ID for the AWS account that owns the schema.
  - name
```
public final String name()
```
    A name for the schema. The schema relation is referred to by this name when queried by a protected query.
    
    Returns:
    
    A name for the schema. The schema relation is referred to by this name when queried by a protected query.
  - collaborationId
```
public final String 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
```
public final String collaborationArn()
```
    The unique ARN for the collaboration that the schema belongs to.
    
    Returns:
    
    The unique ARN for the collaboration that the schema belongs to.
  - description
```
public final String description()
```
    A description for the schema.
    
    Returns:
    
    A description for the schema.
  - createTime
```
public final Instant createTime()
```
    The time the schema was created.
    
    Returns:
    
    The time the schema was created.
  - updateTime
```
public final Instant updateTime()
```
    The time the schema was last updated.
    
    Returns:
    
    The time the schema was last updated.
  - type
```
public final SchemaType type()
```
    The type of schema. The only valid value is currently `TABLE`.
    
    If the service returns an enum value that is not available in the current SDK version, type will return SchemaType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of schema. The only valid value is currently `TABLE`.
    
    See Also:
    
    SchemaType
  - typeAsString
```
public final String typeAsString()
```
    The type of schema. The only valid value is currently `TABLE`.
    
    If the service returns an enum value that is not available in the current SDK version, type will return SchemaType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of schema. The only valid value is currently `TABLE`.
    
    See Also:
    
    SchemaType
  - toBuilder
```
public Schema.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Schema.Builder,Schema>
  - builder
```
public static Schema.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Schema.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class Schema

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasColumns

columns

hasPartitionKeys

partitionKeys

analysisRuleTypes

hasAnalysisRuleTypes

analysisRuleTypesAsStrings

analysisMethod

analysisMethodAsString

creatorAccountId

name

collaborationId

collaborationArn

description

createTime

updateTime

type

typeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields