Class InstanceConfig

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

Configures the resource instances to use while running the Amazon Braket hybrid job on Amazon Braket.

See Also:

  • Method Details

    • instanceType

      public final InstanceType instanceType()

      Configures the type of resource instances to use while running an Amazon Braket hybrid job.

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

      Returns:
      Configures the type of resource instances to use while running an Amazon Braket hybrid job.
      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      Configures the type of resource instances to use while running an Amazon Braket hybrid job.

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

      Returns:
      Configures the type of resource instances to use while running an Amazon Braket hybrid job.
      See Also:

    • volumeSizeInGb

      public final Integer volumeSizeInGb()

      The size of the storage volume, in GB, to provision.

      Returns:
      The size of the storage volume, in GB, to provision.

    • instanceCount

      public final Integer instanceCount()

      Configures the number of resource instances to use while running an Amazon Braket hybrid job on Amazon Braket. The default value is 1.

      Returns:
      Configures the number of resource instances to use while running an Amazon Braket hybrid job on Amazon Braket. The default value is 1.

    • toBuilder

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

    • builder

      public static InstanceConfig.Builder builder()

    • serializableBuilderClass

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