Interface CreateJobRequest.Builder

All Superinterfaces:
AwsRequest.Builder, BraketRequest.Builder, Buildable, CopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>, SdkBuilder<CreateJobRequest.Builder,CreateJobRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateJobRequest
@Mutable @NotThreadSafe public static interface CreateJobRequest.Builder extends BraketRequest.Builder, SdkPojo, CopyableBuilder<CreateJobRequest.Builder,CreateJobRequest>

  • Method Details

    • clientToken

      CreateJobRequest.Builder clientToken(String clientToken)

      The client token associated with this request that guarantees that the request is idempotent.

      Parameters:
      clientToken - The client token associated with this request that guarantees that the request is idempotent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • algorithmSpecification

      CreateJobRequest.Builder algorithmSpecification(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • algorithmSpecification

      default CreateJobRequest.Builder algorithmSpecification(Consumer<AlgorithmSpecification.Builder> 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.

      This is a convenience method that creates an instance of the AlgorithmSpecification.Builder avoiding the need to create one manually via AlgorithmSpecification.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to algorithmSpecification(AlgorithmSpecification).

      Parameters:
      algorithmSpecification - a consumer that will call methods on AlgorithmSpecification.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • inputDataConfig

      CreateJobRequest.Builder inputDataConfig(Collection<InputFileConfig> inputDataConfig)

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

      Parameters:
      inputDataConfig - A list of parameters that specify the name and type of input data and where it is located.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputDataConfig

      CreateJobRequest.Builder inputDataConfig(InputFileConfig... inputDataConfig)

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

      Parameters:
      inputDataConfig - A list of parameters that specify the name and type of input data and where it is located.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputDataConfig

      CreateJobRequest.Builder inputDataConfig(Consumer<InputFileConfig.Builder>... inputDataConfig)

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

      This is a convenience method that creates an instance of the InputFileConfig.Builder avoiding the need to create one manually via InputFileConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inputDataConfig(List<InputFileConfig>).

      Parameters:
      inputDataConfig - a consumer that will call methods on InputFileConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • outputDataConfig

      CreateJobRequest.Builder outputDataConfig(JobOutputDataConfig outputDataConfig)

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

      Parameters:
      outputDataConfig - The path to the S3 location where you want to store hybrid job artifacts and the encryption key used to store them.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputDataConfig

      default CreateJobRequest.Builder outputDataConfig(Consumer<JobOutputDataConfig.Builder> outputDataConfig)

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

      This is a convenience method that creates an instance of the JobOutputDataConfig.Builder avoiding the need to create one manually via JobOutputDataConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputDataConfig(JobOutputDataConfig).

      Parameters:
      outputDataConfig - a consumer that will call methods on JobOutputDataConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • checkpointConfig

      CreateJobRequest.Builder checkpointConfig(JobCheckpointConfig checkpointConfig)

      Information about the output locations for hybrid job checkpoint data.

      Parameters:
      checkpointConfig - Information about the output locations for hybrid job checkpoint data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checkpointConfig

      default CreateJobRequest.Builder checkpointConfig(Consumer<JobCheckpointConfig.Builder> checkpointConfig)

      Information about the output locations for hybrid job checkpoint data.

      This is a convenience method that creates an instance of the JobCheckpointConfig.Builder avoiding the need to create one manually via JobCheckpointConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to checkpointConfig(JobCheckpointConfig).

      Parameters:
      checkpointConfig - a consumer that will call methods on JobCheckpointConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobName

      CreateJobRequest.Builder jobName(String jobName)

      The name of the Amazon Braket hybrid job.

      Parameters:
      jobName - The name of the Amazon Braket hybrid job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      CreateJobRequest.Builder roleArn(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 results and hybrid job details to the users' s3 buckets.

      Parameters:
      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 results and hybrid job details to the users' s3 buckets.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stoppingCondition

      CreateJobRequest.Builder stoppingCondition(JobStoppingCondition stoppingCondition)

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

      Parameters:
      stoppingCondition - The user-defined criteria that specifies when a hybrid job stops running.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stoppingCondition

      default CreateJobRequest.Builder stoppingCondition(Consumer<JobStoppingCondition.Builder> stoppingCondition)

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

      This is a convenience method that creates an instance of the JobStoppingCondition.Builder avoiding the need to create one manually via JobStoppingCondition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to stoppingCondition(JobStoppingCondition).

      Parameters:
      stoppingCondition - a consumer that will call methods on JobStoppingCondition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instanceConfig

      CreateJobRequest.Builder instanceConfig(InstanceConfig instanceConfig)

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

      Parameters:
      instanceConfig - Configuration of the resource instances to use while running the hybrid job on Amazon Braket.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceConfig

      default CreateJobRequest.Builder instanceConfig(Consumer<InstanceConfig.Builder> instanceConfig)

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

      This is a convenience method that creates an instance of the InstanceConfig.Builder avoiding the need to create one manually via InstanceConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to instanceConfig(InstanceConfig).

      Parameters:
      instanceConfig - a consumer that will call methods on InstanceConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • hyperParameters

      CreateJobRequest.Builder hyperParameters(Map<String,String> hyperParameters)

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

      Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request hyperparameter variable or plain text fields.

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

      Do not include any security-sensitive information including account access IDs, secrets, or tokens in any hyperparameter fields. As part of the shared responsibility model, you are responsible for any potential exposure, unauthorized access, or compromise of your sensitive data if caused by security-sensitive information included in the request hyperparameter variable or plain text fields.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deviceConfig

      CreateJobRequest.Builder deviceConfig(DeviceConfig deviceConfig)

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

      Parameters:
      deviceConfig - The quantum processing unit (QPU) or simulator used to create an Amazon Braket hybrid job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deviceConfig

      default CreateJobRequest.Builder deviceConfig(Consumer<DeviceConfig.Builder> deviceConfig)

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

      This is a convenience method that creates an instance of the DeviceConfig.Builder avoiding the need to create one manually via DeviceConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deviceConfig(DeviceConfig).

      Parameters:
      deviceConfig - a consumer that will call methods on DeviceConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateJobRequest.Builder tags(Map<String,String> tags)

      Tags to be added to the hybrid job you're creating.

      Parameters:
      tags - Tags to be added to the hybrid job you're creating.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • associations

      CreateJobRequest.Builder associations(Collection<Association> associations)

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

      Parameters:
      associations - The list of Amazon Braket resources associated with the hybrid job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • associations

      CreateJobRequest.Builder associations(Association... associations)

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

      Parameters:
      associations - The list of Amazon Braket resources associated with the hybrid job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • associations

      CreateJobRequest.Builder associations(Consumer<Association.Builder>... associations)

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

      This is a convenience method that creates an instance of the Association.Builder avoiding the need to create one manually via Association.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to associations(List<Association>).

      Parameters:
      associations - a consumer that will call methods on Association.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.