Class CreateAnalysisTemplateRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cleanrooms.model.CleanRoomsRequest
software.amazon.awssdk.services.cleanrooms.model.CreateAnalysisTemplateRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateAnalysisTemplateRequest.Builder,CreateAnalysisTemplateRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateAnalysisTemplateRequest extends CleanRoomsRequest implements ToCopyableBuilder<CreateAnalysisTemplateRequest.Builder,CreateAnalysisTemplateRequest>

  • Method Details

    • description

      public final String description()

      The description of the analysis template.

      Returns:
      The description of the analysis template.

    • membershipIdentifier

      public final String membershipIdentifier()

      The identifier for a membership resource.

      Returns:
      The identifier for a membership resource.

    • name

      public final String name()

      The name of the analysis template.

      Returns:
      The name of the analysis template.

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

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

    • source

      public final AnalysisSource source()

      The information in the analysis template. Currently supports text, the query text for the analysis template.

      Returns:
      The information in the analysis template. Currently supports text, the query text for the analysis template.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

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

      Returns:
      An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

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

    • schema

      public final AnalysisSchema schema()
      Returns the value of the Schema property for this object.
      Returns:
      The value of the Schema property for this object.

    • toBuilder

      public CreateAnalysisTemplateRequest.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<CreateAnalysisTemplateRequest.Builder,CreateAnalysisTemplateRequest>
      Specified by:
      toBuilder in class CleanRoomsRequest
      Returns:
      a builder for type T

    • builder

      public static CreateAnalysisTemplateRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateAnalysisTemplateRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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