Class UpdateConfiguredTableRequest

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.UpdateConfiguredTableRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateConfiguredTableRequest.Builder,UpdateConfiguredTableRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateConfiguredTableRequest extends CleanRoomsRequest implements ToCopyableBuilder<UpdateConfiguredTableRequest.Builder,UpdateConfiguredTableRequest>

  • Method Details

    • configuredTableIdentifier

      public final String configuredTableIdentifier()

      The identifier for the configured table to update. Currently accepts the configured table ID.

      Returns:
      The identifier for the configured table to update. Currently accepts the configured table ID.

    • name

      public final String name()

      A new name for the configured table.

      Returns:
      A new name for the configured table.

    • description

      public final String description()

      A new description for the configured table.

      Returns:
      A new description for the configured table.

    • tableReference

      public final TableReference tableReference()
      Returns the value of the TableReference property for this object.
      Returns:
      The value of the TableReference property for this object.

    • hasAllowedColumns

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

    • allowedColumns

      public final List<String> allowedColumns()

      The columns of the underlying table that can be used by collaborations or analysis rules.

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

      Returns:
      The columns of the underlying table that can be used by collaborations or analysis rules.

    • analysisMethod

      public final AnalysisMethod analysisMethod()

      The analysis method for the configured table.

      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 return AnalysisMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from analysisMethodAsString().

      Returns:
      The analysis method for the configured table.

      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

      public final String analysisMethodAsString()

      The analysis method for the configured table.

      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 return AnalysisMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from analysisMethodAsString().

      Returns:
      The analysis method for the configured table.

      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

      public final List<SelectedAnalysisMethod> selectedAnalysisMethods()

      The selected analysis methods for the table configuration update.

      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 table configuration update.

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

    • selectedAnalysisMethodsAsStrings

      public final List<String> selectedAnalysisMethodsAsStrings()

      The selected analysis methods for the table configuration update.

      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 table configuration update.

    • toBuilder

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

    • builder

      public static UpdateConfiguredTableRequest.Builder builder()

    • serializableBuilderClass

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