Class ScriptModeConfig

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

Contains information about algorithm scripts used for the Amazon Braket hybrid job.

See Also:

  • Method Details

    • entryPoint

      public final String entryPoint()

      The entry point in the algorithm scripts from where the execution begins in the hybrid job.

      Returns:
      The entry point in the algorithm scripts from where the execution begins in the hybrid job.

    • s3Uri

      public final String s3Uri()

      The URI that specifies the S3 path to the algorithm scripts used by an Amazon Braket hybrid job.

      Returns:
      The URI that specifies the S3 path to the algorithm scripts used by an Amazon Braket hybrid job.

    • compressionType

      public final CompressionType compressionType()

      The type of compression used to store the algorithm scripts in Amazon S3 storage.

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

      Returns:
      The type of compression used to store the algorithm scripts in Amazon S3 storage.
      See Also:

    • compressionTypeAsString

      public final String compressionTypeAsString()

      The type of compression used to store the algorithm scripts in Amazon S3 storage.

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

      Returns:
      The type of compression used to store the algorithm scripts in Amazon S3 storage.
      See Also:

    • toBuilder

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

    • builder

      public static ScriptModeConfig.Builder builder()

    • serializableBuilderClass

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