com.amazonaws.services.braket.model.GetDeviceResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-braket Show documentation
/*
* Copyright 2019-2024 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;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetDeviceResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The ARN of the device.
*
*/
private String deviceArn;
/**
*
* Details about the capabilities of the device.
*
*/
private String deviceCapabilities;
/**
*
* The name of the device.
*
*/
private String deviceName;
/**
*
* List of information about tasks and jobs queued on a device.
*
*/
private java.util.List deviceQueueInfo;
/**
*
* The status of the device.
*
*/
private String deviceStatus;
/**
*
* The type of the device.
*
*/
private String deviceType;
/**
*
* The name of the partner company for the device.
*
*/
private String providerName;
/**
*
* The ARN of the device.
*
*
* @param deviceArn
* The ARN of the device.
*/
public void setDeviceArn(String deviceArn) {
this.deviceArn = deviceArn;
}
/**
*
* The ARN of the device.
*
*
* @return The ARN of the device.
*/
public String getDeviceArn() {
return this.deviceArn;
}
/**
*
* The ARN of the device.
*
*
* @param deviceArn
* The ARN of the device.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDeviceResult withDeviceArn(String deviceArn) {
setDeviceArn(deviceArn);
return this;
}
/**
*
* Details about the capabilities of the device.
*
*
* This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For
* example: '{"key": "value"}'.
*
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* @param deviceCapabilities
* Details about the capabilities of the device.
*/
public void setDeviceCapabilities(String deviceCapabilities) {
this.deviceCapabilities = deviceCapabilities;
}
/**
*
* Details about the capabilities of the device.
*
*
* This field's value will be valid JSON according to RFC 7159, including the opening and closing braces. For
* example: '{"key": "value"}'.
*
*
* @return Details about the capabilities of the device.
*/
public String getDeviceCapabilities() {
return this.deviceCapabilities;
}
/**
*
* Details about the capabilities of the device.
*
*
* This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For
* example: '{"key": "value"}'.
*
*
* The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service.
* Users of the SDK should not perform Base64 encoding on this field.
*
*
* @param deviceCapabilities
* Details about the capabilities of the device.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDeviceResult withDeviceCapabilities(String deviceCapabilities) {
setDeviceCapabilities(deviceCapabilities);
return this;
}
/**
*
* The name of the device.
*
*
* @param deviceName
* The name of the device.
*/
public void setDeviceName(String deviceName) {
this.deviceName = deviceName;
}
/**
*
* The name of the device.
*
*
* @return The name of the device.
*/
public String getDeviceName() {
return this.deviceName;
}
/**
*
* The name of the device.
*
*
* @param deviceName
* The name of the device.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDeviceResult withDeviceName(String deviceName) {
setDeviceName(deviceName);
return this;
}
/**
*
* List of information about tasks and jobs queued on a device.
*
*
* @return List of information about tasks and jobs queued on a device.
*/
public java.util.List getDeviceQueueInfo() {
return deviceQueueInfo;
}
/**
*
* List of information about tasks and jobs queued on a device.
*
*
* @param deviceQueueInfo
* List of information about tasks and jobs queued on a device.
*/
public void setDeviceQueueInfo(java.util.Collection deviceQueueInfo) {
if (deviceQueueInfo == null) {
this.deviceQueueInfo = null;
return;
}
this.deviceQueueInfo = new java.util.ArrayList(deviceQueueInfo);
}
/**
*
* List of information about tasks and jobs queued on a device.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setDeviceQueueInfo(java.util.Collection)} or {@link #withDeviceQueueInfo(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param deviceQueueInfo
* List of information about tasks and jobs queued on a device.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDeviceResult withDeviceQueueInfo(DeviceQueueInfo... deviceQueueInfo) {
if (this.deviceQueueInfo == null) {
setDeviceQueueInfo(new java.util.ArrayList(deviceQueueInfo.length));
}
for (DeviceQueueInfo ele : deviceQueueInfo) {
this.deviceQueueInfo.add(ele);
}
return this;
}
/**
*
* List of information about tasks and jobs queued on a device.
*
*
* @param deviceQueueInfo
* List of information about tasks and jobs queued on a device.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDeviceResult withDeviceQueueInfo(java.util.Collection deviceQueueInfo) {
setDeviceQueueInfo(deviceQueueInfo);
return this;
}
/**
*
* The status of the device.
*
*
* @param deviceStatus
* The status of the device.
* @see DeviceStatus
*/
public void setDeviceStatus(String deviceStatus) {
this.deviceStatus = deviceStatus;
}
/**
*
* The status of the device.
*
*
* @return The status of the device.
* @see DeviceStatus
*/
public String getDeviceStatus() {
return this.deviceStatus;
}
/**
*
* The status of the device.
*
*
* @param deviceStatus
* The status of the device.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DeviceStatus
*/
public GetDeviceResult withDeviceStatus(String deviceStatus) {
setDeviceStatus(deviceStatus);
return this;
}
/**
*
* The status of the device.
*
*
* @param deviceStatus
* The status of the device.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DeviceStatus
*/
public GetDeviceResult withDeviceStatus(DeviceStatus deviceStatus) {
this.deviceStatus = deviceStatus.toString();
return this;
}
/**
*
* The type of the device.
*
*
* @param deviceType
* The type of the device.
* @see DeviceType
*/
public void setDeviceType(String deviceType) {
this.deviceType = deviceType;
}
/**
*
* The type of the device.
*
*
* @return The type of the device.
* @see DeviceType
*/
public String getDeviceType() {
return this.deviceType;
}
/**
*
* The type of the device.
*
*
* @param deviceType
* The type of the device.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DeviceType
*/
public GetDeviceResult withDeviceType(String deviceType) {
setDeviceType(deviceType);
return this;
}
/**
*
* The type of the device.
*
*
* @param deviceType
* The type of the device.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DeviceType
*/
public GetDeviceResult withDeviceType(DeviceType deviceType) {
this.deviceType = deviceType.toString();
return this;
}
/**
*
* The name of the partner company for the device.
*
*
* @param providerName
* The name of the partner company for the device.
*/
public void setProviderName(String providerName) {
this.providerName = providerName;
}
/**
*
* The name of the partner company for the device.
*
*
* @return The name of the partner company for the device.
*/
public String getProviderName() {
return this.providerName;
}
/**
*
* The name of the partner company for the device.
*
*
* @param providerName
* The name of the partner company for the device.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetDeviceResult withProviderName(String providerName) {
setProviderName(providerName);
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 (getDeviceArn() != null)
sb.append("DeviceArn: ").append(getDeviceArn()).append(",");
if (getDeviceCapabilities() != null)
sb.append("DeviceCapabilities: ").append(getDeviceCapabilities()).append(",");
if (getDeviceName() != null)
sb.append("DeviceName: ").append(getDeviceName()).append(",");
if (getDeviceQueueInfo() != null)
sb.append("DeviceQueueInfo: ").append(getDeviceQueueInfo()).append(",");
if (getDeviceStatus() != null)
sb.append("DeviceStatus: ").append(getDeviceStatus()).append(",");
if (getDeviceType() != null)
sb.append("DeviceType: ").append(getDeviceType()).append(",");
if (getProviderName() != null)
sb.append("ProviderName: ").append(getProviderName());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetDeviceResult == false)
return false;
GetDeviceResult other = (GetDeviceResult) obj;
if (other.getDeviceArn() == null ^ this.getDeviceArn() == null)
return false;
if (other.getDeviceArn() != null && other.getDeviceArn().equals(this.getDeviceArn()) == false)
return false;
if (other.getDeviceCapabilities() == null ^ this.getDeviceCapabilities() == null)
return false;
if (other.getDeviceCapabilities() != null && other.getDeviceCapabilities().equals(this.getDeviceCapabilities()) == false)
return false;
if (other.getDeviceName() == null ^ this.getDeviceName() == null)
return false;
if (other.getDeviceName() != null && other.getDeviceName().equals(this.getDeviceName()) == false)
return false;
if (other.getDeviceQueueInfo() == null ^ this.getDeviceQueueInfo() == null)
return false;
if (other.getDeviceQueueInfo() != null && other.getDeviceQueueInfo().equals(this.getDeviceQueueInfo()) == false)
return false;
if (other.getDeviceStatus() == null ^ this.getDeviceStatus() == null)
return false;
if (other.getDeviceStatus() != null && other.getDeviceStatus().equals(this.getDeviceStatus()) == false)
return false;
if (other.getDeviceType() == null ^ this.getDeviceType() == null)
return false;
if (other.getDeviceType() != null && other.getDeviceType().equals(this.getDeviceType()) == false)
return false;
if (other.getProviderName() == null ^ this.getProviderName() == null)
return false;
if (other.getProviderName() != null && other.getProviderName().equals(this.getProviderName()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDeviceArn() == null) ? 0 : getDeviceArn().hashCode());
hashCode = prime * hashCode + ((getDeviceCapabilities() == null) ? 0 : getDeviceCapabilities().hashCode());
hashCode = prime * hashCode + ((getDeviceName() == null) ? 0 : getDeviceName().hashCode());
hashCode = prime * hashCode + ((getDeviceQueueInfo() == null) ? 0 : getDeviceQueueInfo().hashCode());
hashCode = prime * hashCode + ((getDeviceStatus() == null) ? 0 : getDeviceStatus().hashCode());
hashCode = prime * hashCode + ((getDeviceType() == null) ? 0 : getDeviceType().hashCode());
hashCode = prime * hashCode + ((getProviderName() == null) ? 0 : getProviderName().hashCode());
return hashCode;
}
@Override
public GetDeviceResult clone() {
try {
return (GetDeviceResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}