Interface GetJobResponse.Builder

All Superinterfaces:
AwsResponse.Builder, BraketResponse.Builder, Buildable, CopyableBuilder<GetJobResponse.Builder,GetJobResponse>, SdkBuilder<GetJobResponse.Builder,GetJobResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetJobResponse
@Mutable @NotThreadSafe public static interface GetJobResponse.Builder extends BraketResponse.Builder, SdkPojo, CopyableBuilder<GetJobResponse.Builder,GetJobResponse>

  • Method Details

    • status

      GetJobResponse.Builder status(String status)

      The status of the Amazon Braket hybrid job.

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

    • status

      GetJobResponse.Builder status(JobPrimaryStatus status)

      The status of the Amazon Braket hybrid job.

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

    • jobArn

      GetJobResponse.Builder jobArn(String jobArn)

      The ARN of the Amazon Braket hybrid job.

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

    • roleArn

      GetJobResponse.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 other hybrid job details to the s3 buckets of a user.

      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 other hybrid job details to the s3 buckets of a user.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failureReason

      GetJobResponse.Builder failureReason(String failureReason)

      A description of the reason why an Amazon Braket hybrid job failed, if it failed.

      Parameters:
      failureReason - A description of the reason why an Amazon Braket hybrid job failed, if it failed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobName

      GetJobResponse.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.

    • hyperParameters

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

      Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the traiing 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 th hyperparameter.

      Parameters:
      hyperParameters - Algorithm-specific parameters used by an Amazon Braket hybrid job that influence the quality of the traiing 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 th hyperparameter.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputDataConfig

      GetJobResponse.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

      GetJobResponse.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

      GetJobResponse.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

      GetJobResponse.Builder outputDataConfig(JobOutputDataConfig outputDataConfig)

      The path to the S3 location where hybrid job artifacts are stored and the encryption key used to store them there.

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

    • outputDataConfig

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

      The path to the S3 location where hybrid job artifacts are stored and the encryption key used to store them there.

      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:

    • stoppingCondition

      GetJobResponse.Builder stoppingCondition(JobStoppingCondition stoppingCondition)

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

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

    • stoppingCondition

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

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

      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:

    • checkpointConfig

      GetJobResponse.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 GetJobResponse.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:

    • algorithmSpecification

      GetJobResponse.Builder algorithmSpecification(AlgorithmSpecification algorithmSpecification)

      Definition of the Amazon Braket hybrid job created. Provides information about the container image used, and the Python scripts used for training.

      Parameters:
      algorithmSpecification - Definition of the Amazon Braket hybrid job created. Provides information about the container image used, and the Python scripts used for training.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • algorithmSpecification

      default GetJobResponse.Builder algorithmSpecification(Consumer<AlgorithmSpecification.Builder> algorithmSpecification)

      Definition of the Amazon Braket hybrid job created. Provides information about the container image used, and the Python scripts used for 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:

    • instanceConfig

      GetJobResponse.Builder instanceConfig(InstanceConfig instanceConfig)

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

      Parameters:
      instanceConfig - 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 GetJobResponse.Builder instanceConfig(Consumer<InstanceConfig.Builder> instanceConfig)

      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:

    • createdAt

      GetJobResponse.Builder createdAt(Instant createdAt)

      The time at which the Amazon Braket hybrid job was created.

      Parameters:
      createdAt - The time at which the Amazon Braket hybrid job was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startedAt

      GetJobResponse.Builder startedAt(Instant startedAt)

      The time at which the Amazon Braket hybrid job was started.

      Parameters:
      startedAt - The time at which the Amazon Braket hybrid job was started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endedAt

      GetJobResponse.Builder endedAt(Instant endedAt)

      The time at which the Amazon Braket hybrid job ended.

      Parameters:
      endedAt - The time at which the Amazon Braket hybrid job ended.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • billableDuration

      GetJobResponse.Builder billableDuration(Integer billableDuration)

      The billable time for which the Amazon Braket hybrid job used to complete.

      Parameters:
      billableDuration - The billable time for which the Amazon Braket hybrid job used to complete.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deviceConfig

      GetJobResponse.Builder deviceConfig(DeviceConfig deviceConfig)

      The primary device used by the Amazon Braket hybrid job.

      Parameters:
      deviceConfig - The primary device used by the Amazon Braket hybrid job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deviceConfig

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

      The primary device used by the 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:

    • events

      GetJobResponse.Builder events(Collection<JobEventDetails> events)

      Details about the time and type of events occurred related to the Amazon Braket hybrid job.

      Parameters:
      events - Details about the time and type of events occurred related to the Amazon Braket hybrid job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • events

      GetJobResponse.Builder events(JobEventDetails... events)

      Details about the time and type of events occurred related to the Amazon Braket hybrid job.

      Parameters:
      events - Details about the time and type of events occurred related to the Amazon Braket hybrid job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • events

      GetJobResponse.Builder events(Consumer<JobEventDetails.Builder>... events)

      Details about the time and type of events occurred related to the Amazon Braket hybrid job.

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

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

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

    • tags

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

      The tags associated with this hybrid job.

      Parameters:
      tags - The tags associated with this hybrid job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queueInfo

      GetJobResponse.Builder queueInfo(HybridJobQueueInfo queueInfo)

      Queue information for the requested hybrid job. Only returned if QueueInfo is specified in the additionalAttributeNames" field in the GetJob API request.

      Parameters:
      queueInfo - Queue information for the requested hybrid job. Only returned if QueueInfo is specified in the additionalAttributeNames" field in the GetJob API request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queueInfo

      default GetJobResponse.Builder queueInfo(Consumer<HybridJobQueueInfo.Builder> queueInfo)

      Queue information for the requested hybrid job. Only returned if QueueInfo is specified in the additionalAttributeNames" field in the GetJob API request.

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

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

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

    • associations

      GetJobResponse.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

      GetJobResponse.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

      GetJobResponse.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: