Package software.amazon.awssdk.services.braket.model

Class CreateJobRequest

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

  • Method Details

    • algorithmSpecification

      public final AlgorithmSpecification algorithmSpecification()

      Definition of the Amazon Braket job to be created. Specifies the container image the job uses and information about the Python scripts used for entry and training.

      Returns:
      Definition of the Amazon Braket job to be created. Specifies the container image the job uses and information about the Python scripts used for entry and training.

    • hasAssociations

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

    • associations

      public final List<Association> associations()

      The list of Amazon Braket resources associated with the hybrid job.

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

      Returns:
      The list of Amazon Braket resources associated with the hybrid job.

    • checkpointConfig

      public final JobCheckpointConfig checkpointConfig()

      Information about the output locations for job checkpoint data.

      Returns:
      Information about the output locations for job checkpoint data.

    • clientToken

      public final String clientToken()

      A unique token that guarantees that the call to this API is idempotent.

      Returns:
      A unique token that guarantees that the call to this API is idempotent.

    • deviceConfig

      public final DeviceConfig deviceConfig()

      The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.

      Returns:
      The quantum processing unit (QPU) or simulator used to create an Amazon Braket job.

    • hasHyperParameters

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

    • hyperParameters

      public final Map<String,String> hyperParameters()

      Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the training job. The values are set with a string of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.

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

      Returns:
      Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the training job. The values are set with a string of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.

    • hasInputDataConfig

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

    • inputDataConfig

      public final List<InputFileConfig> inputDataConfig()

      A list of parameters that specify the name and type of input data and where it is located.

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

      Returns:
      A list of parameters that specify the name and type of input data and where it is located.

    • instanceConfig

      public final InstanceConfig instanceConfig()

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

      Returns:
      Configuration of the resource instances to use while running the hybrid job on Amazon Braket.

    • jobName

      public final String jobName()

      The name of the Amazon Braket job.

      Returns:
      The name of the Amazon Braket job.

    • outputDataConfig

      public final JobOutputDataConfig outputDataConfig()

      The path to the S3 location where you want to store job artifacts and the encryption key used to store them.

      Returns:
      The path to the S3 location where you want to store job artifacts and the encryption key used to store them.

    • roleArn

      public final String roleArn()

      The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output resources to the users' s3 buckets.

      Returns:
      The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output resources to the users' s3 buckets.

    • stoppingCondition

      public final JobStoppingCondition stoppingCondition()

      The user-defined criteria that specifies when a job stops running.

      Returns:
      The user-defined criteria that specifies when a job stops running.

    • 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()

      A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

      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:
      A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.

    • toBuilder

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

    • builder

      public static CreateJobRequest.Builder builder()

    • serializableBuilderClass

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