Class ProtectedQueryInputParameters

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

Provides information necessary to perform the protected query.

See Also:

  • Method Details

    • sqlParameters

      public final ProtectedQuerySQLParameters sqlParameters()
      Returns the value of the SqlParameters property for this object.
      Returns:
      The value of the SqlParameters property for this object.

    • computeConfiguration

      public final ComputeConfiguration computeConfiguration()

      Provides configuration information for the workers that will perform the protected query.

      Returns:
      Provides configuration information for the workers that will perform the protected query.

    • resultFormat

      public final ResultFormat resultFormat()

      The format in which the query results should be returned. If not specified, defaults to CSV.

      If the service returns an enum value that is not available in the current SDK version, resultFormat will return ResultFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resultFormatAsString().

      Returns:
      The format in which the query results should be returned. If not specified, defaults to CSV.
      See Also:

    • resultFormatAsString

      public final String resultFormatAsString()

      The format in which the query results should be returned. If not specified, defaults to CSV.

      If the service returns an enum value that is not available in the current SDK version, resultFormat will return ResultFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resultFormatAsString().

      Returns:
      The format in which the query results should be returned. If not specified, defaults to CSV.
      See Also:

    • toBuilder

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

    • builder

      public static ProtectedQueryInputParameters.Builder builder()

    • serializableBuilderClass

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