AnalysisTemplate (AWS Java SDK :: Services

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

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

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

The analysis template.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AnalysisTemplate.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<AnalysisParameter>`	`analysisParameters()` The parameters of the analysis template.
`String`	`arn()` The Amazon Resource Name (ARN) of the analysis template.
`static AnalysisTemplate.Builder`	`builder()`
`String`	`collaborationArn()` The unique ARN for the analysis template’s associated collaboration.
`String`	`collaborationId()` The unique ID for the associated collaboration of the analysis template.
`Instant`	`createTime()` The time that the analysis template was created.
`String`	`description()` The description of the analysis template.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`AnalysisFormat`	`format()` The format of the analysis template.
`String`	`formatAsString()` The format of the analysis template.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAnalysisParameters()` For responses, this returns true if the service returned a value for the AnalysisParameters property.
`int`	`hashCode()`
`String`	`id()` The identifier for the analysis template.
`String`	`membershipArn()` The Amazon Resource Name (ARN) of the member who created the analysis template.
`String`	`membershipId()` The identifier of a member who created the analysis template.
`String`	`name()` The name of the analysis template.
`AnalysisSchema`	`schema()` The entire schema object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AnalysisTemplate.Builder>`	`serializableBuilderClass()`
`AnalysisSource`	`source()` The source of the analysis template.
`AnalysisTemplate.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Instant`	`updateTime()` The time that the analysis template 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
  - id
```
public final String id()
```
    The identifier for the analysis template.
    
    Returns:
    
    The identifier for the analysis template.
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) of the analysis template.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the analysis template.
  - collaborationId
```
public final String collaborationId()
```
    The unique ID for the associated collaboration of the analysis template.
    
    Returns:
    
    The unique ID for the associated collaboration of the analysis template.
  - collaborationArn
```
public final String collaborationArn()
```
    The unique ARN for the analysis template’s associated collaboration.
    
    Returns:
    
    The unique ARN for the analysis template’s associated collaboration.
  - membershipId
```
public final String membershipId()
```
    The identifier of a member who created the analysis template.
    
    Returns:
    
    The identifier of a member who created the analysis template.
  - membershipArn
```
public final String membershipArn()
```
    The Amazon Resource Name (ARN) of the member who created the analysis template.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the member who created the analysis template.
  - description
```
public final String description()
```
    The description of the analysis template.
    
    Returns:
    
    The description of the analysis template.
  - name
```
public final String name()
```
    The name of the analysis template.
    
    Returns:
    
    The name of the analysis template.
  - createTime
```
public final Instant createTime()
```
    The time that the analysis template was created.
    
    Returns:
    
    The time that the analysis template was created.
  - updateTime
```
public final Instant updateTime()
```
    The time that the analysis template was last updated.
    
    Returns:
    
    The time that the analysis template was last updated.
  - schema
```
public final AnalysisSchema schema()
```
    The entire schema object.
    
    Returns:
    
    The entire schema object.
  - format
```
public final AnalysisFormat format()
```
    The format of the analysis template.
    
    If the service returns an enum value that is not available in the current SDK version, format will return AnalysisFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().
    
    Returns:
    
    The format of the analysis template.
    
    See Also:
    
    AnalysisFormat
  - formatAsString
```
public final String formatAsString()
```
    The format of the analysis template.
    
    If the service returns an enum value that is not available in the current SDK version, format will return AnalysisFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().
    
    Returns:
    
    The format of the analysis template.
    
    See Also:
    
    AnalysisFormat
  - source
```
public final AnalysisSource source()
```
    The source of the analysis template.
    
    Returns:
    
    The source of the analysis template.
  - hasAnalysisParameters
```
public final boolean hasAnalysisParameters()
```
    For responses, this returns true if the service returned a value for the AnalysisParameters 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.
  - analysisParameters
```
public final List<AnalysisParameter> analysisParameters()
```
    The parameters of the analysis template.
    
    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 hasAnalysisParameters() method.
    
    Returns:
    
    The parameters of the analysis template.
  - toBuilder
```
public AnalysisTemplate.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AnalysisTemplate.Builder,AnalysisTemplate>
  - builder
```
public static AnalysisTemplate.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AnalysisTemplate.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 AnalysisTemplate

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

id

arn

collaborationId

collaborationArn

membershipId

membershipArn

description

name

createTime

updateTime

schema

format

formatAsString

source

hasAnalysisParameters

analysisParameters

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields