@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class GetJobResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable, Cloneable
Constructor and Description |
---|
GetJobResult() |
Modifier and Type | Method and Description |
---|---|
GetJobResult |
addHyperParametersEntry(String key,
String value)
Add a single HyperParameters entry
|
GetJobResult |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
GetJobResult |
clearHyperParametersEntries()
Removes all the entries added into HyperParameters.
|
GetJobResult |
clearTagsEntries()
Removes all the entries added into Tags.
|
GetJobResult |
clone() |
boolean |
equals(Object obj) |
AlgorithmSpecification |
getAlgorithmSpecification()
Definition of the Amazon Braket job created.
|
List<Association> |
getAssociations()
The list of Amazon Braket resources associated with the hybrid job.
|
Integer |
getBillableDuration()
The billable time the Amazon Braket job used to complete.
|
JobCheckpointConfig |
getCheckpointConfig()
Information about the output locations for job checkpoint data.
|
Date |
getCreatedAt()
The date and time that the Amazon Braket job was created.
|
DeviceConfig |
getDeviceConfig()
The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.
|
Date |
getEndedAt()
The date and time that the Amazon Braket job ended.
|
List<JobEventDetails> |
getEvents()
Details about the type and time events occurred related to the Amazon Braket job.
|
String |
getFailureReason()
A description of the reason why an Amazon Braket job failed, if it failed.
|
Map<String,String> |
getHyperParameters()
Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the traiing job.
|
List<InputFileConfig> |
getInputDataConfig()
A list of parameters that specify the name and type of input data and where it is located.
|
InstanceConfig |
getInstanceConfig()
The resource instances to use while running the hybrid job on Amazon Braket.
|
String |
getJobArn()
The ARN of the Amazon Braket job.
|
String |
getJobName()
The name of the Amazon Braket job.
|
JobOutputDataConfig |
getOutputDataConfig()
The path to the S3 location where job artifacts are stored and the encryption key used to store them there.
|
HybridJobQueueInfo |
getQueueInfo()
Queue information for the requested job.
|
String |
getRoleArn()
The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user.
|
Date |
getStartedAt()
The date and time that the Amazon Braket job was started.
|
String |
getStatus()
The status of the Amazon Braket job.
|
JobStoppingCondition |
getStoppingCondition()
The user-defined criteria that specifies when to stop a job running.
|
Map<String,String> |
getTags()
A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
|
int |
hashCode() |
void |
setAlgorithmSpecification(AlgorithmSpecification algorithmSpecification)
Definition of the Amazon Braket job created.
|
void |
setAssociations(Collection<Association> associations)
The list of Amazon Braket resources associated with the hybrid job.
|
void |
setBillableDuration(Integer billableDuration)
The billable time the Amazon Braket job used to complete.
|
void |
setCheckpointConfig(JobCheckpointConfig checkpointConfig)
Information about the output locations for job checkpoint data.
|
void |
setCreatedAt(Date createdAt)
The date and time that the Amazon Braket job was created.
|
void |
setDeviceConfig(DeviceConfig deviceConfig)
The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.
|
void |
setEndedAt(Date endedAt)
The date and time that the Amazon Braket job ended.
|
void |
setEvents(Collection<JobEventDetails> events)
Details about the type and time events occurred related to the Amazon Braket job.
|
void |
setFailureReason(String failureReason)
A description of the reason why an Amazon Braket job failed, if it failed.
|
void |
setHyperParameters(Map<String,String> hyperParameters)
Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the traiing job.
|
void |
setInputDataConfig(Collection<InputFileConfig> inputDataConfig)
A list of parameters that specify the name and type of input data and where it is located.
|
void |
setInstanceConfig(InstanceConfig instanceConfig)
The resource instances to use while running the hybrid job on Amazon Braket.
|
void |
setJobArn(String jobArn)
The ARN of the Amazon Braket job.
|
void |
setJobName(String jobName)
The name of the Amazon Braket job.
|
void |
setOutputDataConfig(JobOutputDataConfig outputDataConfig)
The path to the S3 location where job artifacts are stored and the encryption key used to store them there.
|
void |
setQueueInfo(HybridJobQueueInfo queueInfo)
Queue information for the requested job.
|
void |
setRoleArn(String roleArn)
The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user.
|
void |
setStartedAt(Date startedAt)
The date and time that the Amazon Braket job was started.
|
void |
setStatus(String status)
The status of the Amazon Braket job.
|
void |
setStoppingCondition(JobStoppingCondition stoppingCondition)
The user-defined criteria that specifies when to stop a job running.
|
void |
setTags(Map<String,String> tags)
A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
|
String |
toString()
Returns a string representation of this object.
|
GetJobResult |
withAlgorithmSpecification(AlgorithmSpecification algorithmSpecification)
Definition of the Amazon Braket job created.
|
GetJobResult |
withAssociations(Association... associations)
The list of Amazon Braket resources associated with the hybrid job.
|
GetJobResult |
withAssociations(Collection<Association> associations)
The list of Amazon Braket resources associated with the hybrid job.
|
GetJobResult |
withBillableDuration(Integer billableDuration)
The billable time the Amazon Braket job used to complete.
|
GetJobResult |
withCheckpointConfig(JobCheckpointConfig checkpointConfig)
Information about the output locations for job checkpoint data.
|
GetJobResult |
withCreatedAt(Date createdAt)
The date and time that the Amazon Braket job was created.
|
GetJobResult |
withDeviceConfig(DeviceConfig deviceConfig)
The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.
|
GetJobResult |
withEndedAt(Date endedAt)
The date and time that the Amazon Braket job ended.
|
GetJobResult |
withEvents(Collection<JobEventDetails> events)
Details about the type and time events occurred related to the Amazon Braket job.
|
GetJobResult |
withEvents(JobEventDetails... events)
Details about the type and time events occurred related to the Amazon Braket job.
|
GetJobResult |
withFailureReason(String failureReason)
A description of the reason why an Amazon Braket job failed, if it failed.
|
GetJobResult |
withHyperParameters(Map<String,String> hyperParameters)
Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the traiing job.
|
GetJobResult |
withInputDataConfig(Collection<InputFileConfig> inputDataConfig)
A list of parameters that specify the name and type of input data and where it is located.
|
GetJobResult |
withInputDataConfig(InputFileConfig... inputDataConfig)
A list of parameters that specify the name and type of input data and where it is located.
|
GetJobResult |
withInstanceConfig(InstanceConfig instanceConfig)
The resource instances to use while running the hybrid job on Amazon Braket.
|
GetJobResult |
withJobArn(String jobArn)
The ARN of the Amazon Braket job.
|
GetJobResult |
withJobName(String jobName)
The name of the Amazon Braket job.
|
GetJobResult |
withOutputDataConfig(JobOutputDataConfig outputDataConfig)
The path to the S3 location where job artifacts are stored and the encryption key used to store them there.
|
GetJobResult |
withQueueInfo(HybridJobQueueInfo queueInfo)
Queue information for the requested job.
|
GetJobResult |
withRoleArn(String roleArn)
The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user.
|
GetJobResult |
withStartedAt(Date startedAt)
The date and time that the Amazon Braket job was started.
|
GetJobResult |
withStatus(JobPrimaryStatus status)
The status of the Amazon Braket job.
|
GetJobResult |
withStatus(String status)
The status of the Amazon Braket job.
|
GetJobResult |
withStoppingCondition(JobStoppingCondition stoppingCondition)
The user-defined criteria that specifies when to stop a job running.
|
GetJobResult |
withTags(Map<String,String> tags)
A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
|
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata
public void setAlgorithmSpecification(AlgorithmSpecification algorithmSpecification)
Definition of the Amazon Braket job created. Specifies the container image the job uses, information about the Python scripts used for entry and training, and the user-defined metrics used to evaluation the job.
algorithmSpecification
- Definition of the Amazon Braket job created. Specifies the container image the job uses, information about
the Python scripts used for entry and training, and the user-defined metrics used to evaluation the job.public AlgorithmSpecification getAlgorithmSpecification()
Definition of the Amazon Braket job created. Specifies the container image the job uses, information about the Python scripts used for entry and training, and the user-defined metrics used to evaluation the job.
public GetJobResult withAlgorithmSpecification(AlgorithmSpecification algorithmSpecification)
Definition of the Amazon Braket job created. Specifies the container image the job uses, information about the Python scripts used for entry and training, and the user-defined metrics used to evaluation the job.
algorithmSpecification
- Definition of the Amazon Braket job created. Specifies the container image the job uses, information about
the Python scripts used for entry and training, and the user-defined metrics used to evaluation the job.public List<Association> getAssociations()
The list of Amazon Braket resources associated with the hybrid job.
public void setAssociations(Collection<Association> associations)
The list of Amazon Braket resources associated with the hybrid job.
associations
- The list of Amazon Braket resources associated with the hybrid job.public GetJobResult withAssociations(Association... associations)
The list of Amazon Braket resources associated with the hybrid job.
NOTE: This method appends the values to the existing list (if any). Use
setAssociations(java.util.Collection)
or withAssociations(java.util.Collection)
if you want to
override the existing values.
associations
- The list of Amazon Braket resources associated with the hybrid job.public GetJobResult withAssociations(Collection<Association> associations)
The list of Amazon Braket resources associated with the hybrid job.
associations
- The list of Amazon Braket resources associated with the hybrid job.public void setBillableDuration(Integer billableDuration)
The billable time the Amazon Braket job used to complete.
billableDuration
- The billable time the Amazon Braket job used to complete.public Integer getBillableDuration()
The billable time the Amazon Braket job used to complete.
public GetJobResult withBillableDuration(Integer billableDuration)
The billable time the Amazon Braket job used to complete.
billableDuration
- The billable time the Amazon Braket job used to complete.public void setCheckpointConfig(JobCheckpointConfig checkpointConfig)
Information about the output locations for job checkpoint data.
checkpointConfig
- Information about the output locations for job checkpoint data.public JobCheckpointConfig getCheckpointConfig()
Information about the output locations for job checkpoint data.
public GetJobResult withCheckpointConfig(JobCheckpointConfig checkpointConfig)
Information about the output locations for job checkpoint data.
checkpointConfig
- Information about the output locations for job checkpoint data.public void setCreatedAt(Date createdAt)
The date and time that the Amazon Braket job was created.
createdAt
- The date and time that the Amazon Braket job was created.public Date getCreatedAt()
The date and time that the Amazon Braket job was created.
public GetJobResult withCreatedAt(Date createdAt)
The date and time that the Amazon Braket job was created.
createdAt
- The date and time that the Amazon Braket job was created.public void setDeviceConfig(DeviceConfig deviceConfig)
The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.
deviceConfig
- The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.public DeviceConfig getDeviceConfig()
The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.
public GetJobResult withDeviceConfig(DeviceConfig deviceConfig)
The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.
deviceConfig
- The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.public void setEndedAt(Date endedAt)
The date and time that the Amazon Braket job ended.
endedAt
- The date and time that the Amazon Braket job ended.public Date getEndedAt()
The date and time that the Amazon Braket job ended.
public GetJobResult withEndedAt(Date endedAt)
The date and time that the Amazon Braket job ended.
endedAt
- The date and time that the Amazon Braket job ended.public List<JobEventDetails> getEvents()
Details about the type and time events occurred related to the Amazon Braket job.
public void setEvents(Collection<JobEventDetails> events)
Details about the type and time events occurred related to the Amazon Braket job.
events
- Details about the type and time events occurred related to the Amazon Braket job.public GetJobResult withEvents(JobEventDetails... events)
Details about the type and time events occurred related to the Amazon Braket job.
NOTE: This method appends the values to the existing list (if any). Use
setEvents(java.util.Collection)
or withEvents(java.util.Collection)
if you want to override the
existing values.
events
- Details about the type and time events occurred related to the Amazon Braket job.public GetJobResult withEvents(Collection<JobEventDetails> events)
Details about the type and time events occurred related to the Amazon Braket job.
events
- Details about the type and time events occurred related to the Amazon Braket job.public void setFailureReason(String failureReason)
A description of the reason why an Amazon Braket job failed, if it failed.
failureReason
- A description of the reason why an Amazon Braket job failed, if it failed.public String getFailureReason()
A description of the reason why an Amazon Braket job failed, if it failed.
public GetJobResult withFailureReason(String failureReason)
A description of the reason why an Amazon Braket job failed, if it failed.
failureReason
- A description of the reason why an Amazon Braket job failed, if it failed.public Map<String,String> getHyperParameters()
Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the traiing 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.
public void setHyperParameters(Map<String,String> hyperParameters)
Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the traiing 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.
hyperParameters
- Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the traiing 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.public GetJobResult withHyperParameters(Map<String,String> hyperParameters)
Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the traiing 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.
hyperParameters
- Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the traiing 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.public GetJobResult addHyperParametersEntry(String key, String value)
public GetJobResult clearHyperParametersEntries()
public List<InputFileConfig> getInputDataConfig()
A list of parameters that specify the name and type of input data and where it is located.
public void setInputDataConfig(Collection<InputFileConfig> inputDataConfig)
A list of parameters that specify the name and type of input data and where it is located.
inputDataConfig
- A list of parameters that specify the name and type of input data and where it is located.public GetJobResult withInputDataConfig(InputFileConfig... inputDataConfig)
A list of parameters that specify the name and type of input data and where it is located.
NOTE: This method appends the values to the existing list (if any). Use
setInputDataConfig(java.util.Collection)
or withInputDataConfig(java.util.Collection)
if you
want to override the existing values.
inputDataConfig
- A list of parameters that specify the name and type of input data and where it is located.public GetJobResult withInputDataConfig(Collection<InputFileConfig> inputDataConfig)
A list of parameters that specify the name and type of input data and where it is located.
inputDataConfig
- A list of parameters that specify the name and type of input data and where it is located.public void setInstanceConfig(InstanceConfig instanceConfig)
The resource instances to use while running the hybrid job on Amazon Braket.
instanceConfig
- The resource instances to use while running the hybrid job on Amazon Braket.public InstanceConfig getInstanceConfig()
The resource instances to use while running the hybrid job on Amazon Braket.
public GetJobResult withInstanceConfig(InstanceConfig instanceConfig)
The resource instances to use while running the hybrid job on Amazon Braket.
instanceConfig
- The resource instances to use while running the hybrid job on Amazon Braket.public void setJobArn(String jobArn)
The ARN of the Amazon Braket job.
jobArn
- The ARN of the Amazon Braket job.public String getJobArn()
The ARN of the Amazon Braket job.
public GetJobResult withJobArn(String jobArn)
The ARN of the Amazon Braket job.
jobArn
- The ARN of the Amazon Braket job.public void setJobName(String jobName)
The name of the Amazon Braket job.
jobName
- The name of the Amazon Braket job.public String getJobName()
The name of the Amazon Braket job.
public GetJobResult withJobName(String jobName)
The name of the Amazon Braket job.
jobName
- The name of the Amazon Braket job.public void setOutputDataConfig(JobOutputDataConfig outputDataConfig)
The path to the S3 location where job artifacts are stored and the encryption key used to store them there.
outputDataConfig
- The path to the S3 location where job artifacts are stored and the encryption key used to store them
there.public JobOutputDataConfig getOutputDataConfig()
The path to the S3 location where job artifacts are stored and the encryption key used to store them there.
public GetJobResult withOutputDataConfig(JobOutputDataConfig outputDataConfig)
The path to the S3 location where job artifacts are stored and the encryption key used to store them there.
outputDataConfig
- The path to the S3 location where job artifacts are stored and the encryption key used to store them
there.public void setQueueInfo(HybridJobQueueInfo queueInfo)
Queue information for the requested job. Only returned if QueueInfo
is specified in the
additionalAttributeNames"
field in the GetJob
API request.
queueInfo
- Queue information for the requested job. Only returned if QueueInfo
is specified in the
additionalAttributeNames"
field in the GetJob
API request.public HybridJobQueueInfo getQueueInfo()
Queue information for the requested job. Only returned if QueueInfo
is specified in the
additionalAttributeNames"
field in the GetJob
API request.
QueueInfo
is specified in the
additionalAttributeNames"
field in the GetJob
API request.public GetJobResult withQueueInfo(HybridJobQueueInfo queueInfo)
Queue information for the requested job. Only returned if QueueInfo
is specified in the
additionalAttributeNames"
field in the GetJob
API request.
queueInfo
- Queue information for the requested job. Only returned if QueueInfo
is specified in the
additionalAttributeNames"
field in the GetJob
API request.public void setRoleArn(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 s3 buckets of a user.
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 s3 buckets of a user.public String getRoleArn()
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 s3 buckets of a user.
public GetJobResult withRoleArn(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 s3 buckets of a user.
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 s3 buckets of a user.public void setStartedAt(Date startedAt)
The date and time that the Amazon Braket job was started.
startedAt
- The date and time that the Amazon Braket job was started.public Date getStartedAt()
The date and time that the Amazon Braket job was started.
public GetJobResult withStartedAt(Date startedAt)
The date and time that the Amazon Braket job was started.
startedAt
- The date and time that the Amazon Braket job was started.public void setStatus(String status)
The status of the Amazon Braket job.
status
- The status of the Amazon Braket job.JobPrimaryStatus
public String getStatus()
The status of the Amazon Braket job.
JobPrimaryStatus
public GetJobResult withStatus(String status)
The status of the Amazon Braket job.
status
- The status of the Amazon Braket job.JobPrimaryStatus
public GetJobResult withStatus(JobPrimaryStatus status)
The status of the Amazon Braket job.
status
- The status of the Amazon Braket job.JobPrimaryStatus
public void setStoppingCondition(JobStoppingCondition stoppingCondition)
The user-defined criteria that specifies when to stop a job running.
stoppingCondition
- The user-defined criteria that specifies when to stop a job running.public JobStoppingCondition getStoppingCondition()
The user-defined criteria that specifies when to stop a job running.
public GetJobResult withStoppingCondition(JobStoppingCondition stoppingCondition)
The user-defined criteria that specifies when to stop a job running.
stoppingCondition
- The user-defined criteria that specifies when to stop a job running.public Map<String,String> getTags()
A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
public void setTags(Map<String,String> tags)
A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
tags
- A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket
resources.public GetJobResult withTags(Map<String,String> tags)
A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
tags
- A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket
resources.public GetJobResult addTagsEntry(String key, String value)
public GetJobResult clearTagsEntries()
public String toString()
toString
in class Object
Object.toString()
public GetJobResult clone()