com.amazonaws.services.braket.model.QuantumTaskSummary Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-braket Show documentation
Show all versions of aws-java-sdk-braket Show documentation
The AWS Java SDK for Braket module holds the client classes that are used for communicating with Braket Service
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.braket.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Includes information about a quantum task.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class QuantumTaskSummary implements Serializable, Cloneable, StructuredPojo {
/**
*
* The time at which the task was created.
*
*/
private java.util.Date createdAt;
/**
*
* The ARN of the device the task ran on.
*
*/
private String deviceArn;
/**
*
* The time at which the task finished.
*
*/
private java.util.Date endedAt;
/**
*
* The S3 bucket where the task result file is stored..
*
*/
private String outputS3Bucket;
/**
*
* The folder in the S3 bucket where the task result file is stored.
*
*/
private String outputS3Directory;
/**
*
* The ARN of the task.
*
*/
private String quantumTaskArn;
/**
*
* The shots used for the task.
*
*/
private Long shots;
/**
*
* The status of the task.
*
*/
private String status;
/**
*
* Displays the key, value pairs of tags associated with this quantum task.
*
*/
private java.util.Map tags;
/**
*
* The time at which the task was created.
*
*
* @param createdAt
* The time at which the task was created.
*/
public void setCreatedAt(java.util.Date createdAt) {
this.createdAt = createdAt;
}
/**
*
* The time at which the task was created.
*
*
* @return The time at which the task was created.
*/
public java.util.Date getCreatedAt() {
return this.createdAt;
}
/**
*
* The time at which the task was created.
*
*
* @param createdAt
* The time at which the task was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QuantumTaskSummary withCreatedAt(java.util.Date createdAt) {
setCreatedAt(createdAt);
return this;
}
/**
*
* The ARN of the device the task ran on.
*
*
* @param deviceArn
* The ARN of the device the task ran on.
*/
public void setDeviceArn(String deviceArn) {
this.deviceArn = deviceArn;
}
/**
*
* The ARN of the device the task ran on.
*
*
* @return The ARN of the device the task ran on.
*/
public String getDeviceArn() {
return this.deviceArn;
}
/**
*
* The ARN of the device the task ran on.
*
*
* @param deviceArn
* The ARN of the device the task ran on.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QuantumTaskSummary withDeviceArn(String deviceArn) {
setDeviceArn(deviceArn);
return this;
}
/**
*
* The time at which the task finished.
*
*
* @param endedAt
* The time at which the task finished.
*/
public void setEndedAt(java.util.Date endedAt) {
this.endedAt = endedAt;
}
/**
*
* The time at which the task finished.
*
*
* @return The time at which the task finished.
*/
public java.util.Date getEndedAt() {
return this.endedAt;
}
/**
*
* The time at which the task finished.
*
*
* @param endedAt
* The time at which the task finished.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QuantumTaskSummary withEndedAt(java.util.Date endedAt) {
setEndedAt(endedAt);
return this;
}
/**
*
* The S3 bucket where the task result file is stored..
*
*
* @param outputS3Bucket
* The S3 bucket where the task result file is stored..
*/
public void setOutputS3Bucket(String outputS3Bucket) {
this.outputS3Bucket = outputS3Bucket;
}
/**
*
* The S3 bucket where the task result file is stored..
*
*
* @return The S3 bucket where the task result file is stored..
*/
public String getOutputS3Bucket() {
return this.outputS3Bucket;
}
/**
*
* The S3 bucket where the task result file is stored..
*
*
* @param outputS3Bucket
* The S3 bucket where the task result file is stored..
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QuantumTaskSummary withOutputS3Bucket(String outputS3Bucket) {
setOutputS3Bucket(outputS3Bucket);
return this;
}
/**
*
* The folder in the S3 bucket where the task result file is stored.
*
*
* @param outputS3Directory
* The folder in the S3 bucket where the task result file is stored.
*/
public void setOutputS3Directory(String outputS3Directory) {
this.outputS3Directory = outputS3Directory;
}
/**
*
* The folder in the S3 bucket where the task result file is stored.
*
*
* @return The folder in the S3 bucket where the task result file is stored.
*/
public String getOutputS3Directory() {
return this.outputS3Directory;
}
/**
*
* The folder in the S3 bucket where the task result file is stored.
*
*
* @param outputS3Directory
* The folder in the S3 bucket where the task result file is stored.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QuantumTaskSummary withOutputS3Directory(String outputS3Directory) {
setOutputS3Directory(outputS3Directory);
return this;
}
/**
*
* The ARN of the task.
*
*
* @param quantumTaskArn
* The ARN of the task.
*/
public void setQuantumTaskArn(String quantumTaskArn) {
this.quantumTaskArn = quantumTaskArn;
}
/**
*
* The ARN of the task.
*
*
* @return The ARN of the task.
*/
public String getQuantumTaskArn() {
return this.quantumTaskArn;
}
/**
*
* The ARN of the task.
*
*
* @param quantumTaskArn
* The ARN of the task.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QuantumTaskSummary withQuantumTaskArn(String quantumTaskArn) {
setQuantumTaskArn(quantumTaskArn);
return this;
}
/**
*
* The shots used for the task.
*
*
* @param shots
* The shots used for the task.
*/
public void setShots(Long shots) {
this.shots = shots;
}
/**
*
* The shots used for the task.
*
*
* @return The shots used for the task.
*/
public Long getShots() {
return this.shots;
}
/**
*
* The shots used for the task.
*
*
* @param shots
* The shots used for the task.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QuantumTaskSummary withShots(Long shots) {
setShots(shots);
return this;
}
/**
*
* The status of the task.
*
*
* @param status
* The status of the task.
* @see QuantumTaskStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The status of the task.
*
*
* @return The status of the task.
* @see QuantumTaskStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* The status of the task.
*
*
* @param status
* The status of the task.
* @return Returns a reference to this object so that method calls can be chained together.
* @see QuantumTaskStatus
*/
public QuantumTaskSummary withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The status of the task.
*
*
* @param status
* The status of the task.
* @return Returns a reference to this object so that method calls can be chained together.
* @see QuantumTaskStatus
*/
public QuantumTaskSummary withStatus(QuantumTaskStatus status) {
this.status = status.toString();
return this;
}
/**
*
* Displays the key, value pairs of tags associated with this quantum task.
*
*
* @return Displays the key, value pairs of tags associated with this quantum task.
*/
public java.util.Map getTags() {
return tags;
}
/**
*
* Displays the key, value pairs of tags associated with this quantum task.
*
*
* @param tags
* Displays the key, value pairs of tags associated with this quantum task.
*/
public void setTags(java.util.Map tags) {
this.tags = tags;
}
/**
*
* Displays the key, value pairs of tags associated with this quantum task.
*
*
* @param tags
* Displays the key, value pairs of tags associated with this quantum task.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QuantumTaskSummary withTags(java.util.Map tags) {
setTags(tags);
return this;
}
/**
* Add a single Tags entry
*
* @see QuantumTaskSummary#withTags
* @returns a reference to this object so that method calls can be chained together.
*/
public QuantumTaskSummary addTagsEntry(String key, String value) {
if (null == this.tags) {
this.tags = new java.util.HashMap();
}
if (this.tags.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.tags.put(key, value);
return this;
}
/**
* Removes all the entries added into Tags.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public QuantumTaskSummary clearTagsEntries() {
this.tags = null;
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getCreatedAt() != null)
sb.append("CreatedAt: ").append(getCreatedAt()).append(",");
if (getDeviceArn() != null)
sb.append("DeviceArn: ").append(getDeviceArn()).append(",");
if (getEndedAt() != null)
sb.append("EndedAt: ").append(getEndedAt()).append(",");
if (getOutputS3Bucket() != null)
sb.append("OutputS3Bucket: ").append(getOutputS3Bucket()).append(",");
if (getOutputS3Directory() != null)
sb.append("OutputS3Directory: ").append(getOutputS3Directory()).append(",");
if (getQuantumTaskArn() != null)
sb.append("QuantumTaskArn: ").append(getQuantumTaskArn()).append(",");
if (getShots() != null)
sb.append("Shots: ").append(getShots()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof QuantumTaskSummary == false)
return false;
QuantumTaskSummary other = (QuantumTaskSummary) obj;
if (other.getCreatedAt() == null ^ this.getCreatedAt() == null)
return false;
if (other.getCreatedAt() != null && other.getCreatedAt().equals(this.getCreatedAt()) == false)
return false;
if (other.getDeviceArn() == null ^ this.getDeviceArn() == null)
return false;
if (other.getDeviceArn() != null && other.getDeviceArn().equals(this.getDeviceArn()) == false)
return false;
if (other.getEndedAt() == null ^ this.getEndedAt() == null)
return false;
if (other.getEndedAt() != null && other.getEndedAt().equals(this.getEndedAt()) == false)
return false;
if (other.getOutputS3Bucket() == null ^ this.getOutputS3Bucket() == null)
return false;
if (other.getOutputS3Bucket() != null && other.getOutputS3Bucket().equals(this.getOutputS3Bucket()) == false)
return false;
if (other.getOutputS3Directory() == null ^ this.getOutputS3Directory() == null)
return false;
if (other.getOutputS3Directory() != null && other.getOutputS3Directory().equals(this.getOutputS3Directory()) == false)
return false;
if (other.getQuantumTaskArn() == null ^ this.getQuantumTaskArn() == null)
return false;
if (other.getQuantumTaskArn() != null && other.getQuantumTaskArn().equals(this.getQuantumTaskArn()) == false)
return false;
if (other.getShots() == null ^ this.getShots() == null)
return false;
if (other.getShots() != null && other.getShots().equals(this.getShots()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCreatedAt() == null) ? 0 : getCreatedAt().hashCode());
hashCode = prime * hashCode + ((getDeviceArn() == null) ? 0 : getDeviceArn().hashCode());
hashCode = prime * hashCode + ((getEndedAt() == null) ? 0 : getEndedAt().hashCode());
hashCode = prime * hashCode + ((getOutputS3Bucket() == null) ? 0 : getOutputS3Bucket().hashCode());
hashCode = prime * hashCode + ((getOutputS3Directory() == null) ? 0 : getOutputS3Directory().hashCode());
hashCode = prime * hashCode + ((getQuantumTaskArn() == null) ? 0 : getQuantumTaskArn().hashCode());
hashCode = prime * hashCode + ((getShots() == null) ? 0 : getShots().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public QuantumTaskSummary clone() {
try {
return (QuantumTaskSummary) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.braket.model.transform.QuantumTaskSummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}