Class CollaborationAnalysisTemplate

java.lang.Object
software.amazon.awssdk.services.cleanrooms.model.CollaborationAnalysisTemplate
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CollaborationAnalysisTemplate.Builder,CollaborationAnalysisTemplate>
@Generated("software.amazon.awssdk:codegen") public final class CollaborationAnalysisTemplate extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CollaborationAnalysisTemplate.Builder,CollaborationAnalysisTemplate>

The analysis template within a collaboration.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier of the analysis template.

      Returns:
      The identifier of 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()

      A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

      Returns:
      A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.

    • 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.

    • description

      public final String description()

      The description of the analysis template.

      Returns:
      The description of the analysis template.

    • creatorAccountId

      public final String creatorAccountId()

      The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

      Returns:
      The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.

    • 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 within a collaboration was created.

      Returns:
      The time that the analysis template within a collaboration was created.

    • updateTime

      public final Instant updateTime()

      The time that the analysis template in the collaboration was last updated.

      Returns:
      The time that the analysis template in the collaboration 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 in the collaboration.

      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 in the collaboration.
      See Also:

    • formatAsString

      public final String formatAsString()

      The format of the analysis template in the collaboration.

      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 in the collaboration.
      See Also:

    • source

      public final AnalysisSource source()

      The source of the analysis template within a collaboration.

      Returns:
      The source of the analysis template within a collaboration.

    • sourceMetadata

      public final AnalysisSourceMetadata sourceMetadata()

      The source metadata for the collaboration analysis template.

      Returns:
      The source metadata for the collaboration 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 analysis parameters that have been specified in 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 analysis parameters that have been specified in the analysis template.

    • hasValidations

      public final boolean hasValidations()
      For responses, this returns true if the service returned a value for the Validations 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.

    • validations

      public final List<AnalysisTemplateValidationStatusDetail> validations()

      The validations that were performed.

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

      Returns:
      The validations that were performed.

    • toBuilder

      public CollaborationAnalysisTemplate.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<CollaborationAnalysisTemplate.Builder,CollaborationAnalysisTemplate>
      Returns:
      a builder for type T

    • builder

      public static CollaborationAnalysisTemplate.Builder builder()

    • serializableBuilderClass

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