com.amazonaws.services.snowball.model.DataTransfer Maven / Gradle / Ivy
Show all versions of aws-java-sdk-snowball 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.snowball.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Defines the real-time status of a Snow device's data transfer while the device is at Amazon Web Services. This data
* is only available while a job has a JobState value of InProgress, for both import and
* export jobs.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DataTransfer implements Serializable, Cloneable, StructuredPojo {
/**
*
* The number of bytes transferred between a Snow device and Amazon S3.
*
*/
private Long bytesTransferred;
/**
*
* The number of objects transferred between a Snow device and Amazon S3.
*
*/
private Long objectsTransferred;
/**
*
* The total bytes of data for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero) until
* all the keys that will be transferred have been listed.
*
*/
private Long totalBytes;
/**
*
* The total number of objects for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero)
* until all the keys that will be transferred have been listed.
*
*/
private Long totalObjects;
/**
*
* The number of bytes transferred between a Snow device and Amazon S3.
*
*
* @param bytesTransferred
* The number of bytes transferred between a Snow device and Amazon S3.
*/
public void setBytesTransferred(Long bytesTransferred) {
this.bytesTransferred = bytesTransferred;
}
/**
*
* The number of bytes transferred between a Snow device and Amazon S3.
*
*
* @return The number of bytes transferred between a Snow device and Amazon S3.
*/
public Long getBytesTransferred() {
return this.bytesTransferred;
}
/**
*
* The number of bytes transferred between a Snow device and Amazon S3.
*
*
* @param bytesTransferred
* The number of bytes transferred between a Snow device and Amazon S3.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DataTransfer withBytesTransferred(Long bytesTransferred) {
setBytesTransferred(bytesTransferred);
return this;
}
/**
*
* The number of objects transferred between a Snow device and Amazon S3.
*
*
* @param objectsTransferred
* The number of objects transferred between a Snow device and Amazon S3.
*/
public void setObjectsTransferred(Long objectsTransferred) {
this.objectsTransferred = objectsTransferred;
}
/**
*
* The number of objects transferred between a Snow device and Amazon S3.
*
*
* @return The number of objects transferred between a Snow device and Amazon S3.
*/
public Long getObjectsTransferred() {
return this.objectsTransferred;
}
/**
*
* The number of objects transferred between a Snow device and Amazon S3.
*
*
* @param objectsTransferred
* The number of objects transferred between a Snow device and Amazon S3.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DataTransfer withObjectsTransferred(Long objectsTransferred) {
setObjectsTransferred(objectsTransferred);
return this;
}
/**
*
* The total bytes of data for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero) until
* all the keys that will be transferred have been listed.
*
*
* @param totalBytes
* The total bytes of data for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero)
* until all the keys that will be transferred have been listed.
*/
public void setTotalBytes(Long totalBytes) {
this.totalBytes = totalBytes;
}
/**
*
* The total bytes of data for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero) until
* all the keys that will be transferred have been listed.
*
*
* @return The total bytes of data for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero)
* until all the keys that will be transferred have been listed.
*/
public Long getTotalBytes() {
return this.totalBytes;
}
/**
*
* The total bytes of data for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero) until
* all the keys that will be transferred have been listed.
*
*
* @param totalBytes
* The total bytes of data for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero)
* until all the keys that will be transferred have been listed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DataTransfer withTotalBytes(Long totalBytes) {
setTotalBytes(totalBytes);
return this;
}
/**
*
* The total number of objects for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero)
* until all the keys that will be transferred have been listed.
*
*
* @param totalObjects
* The total number of objects for a transfer between a Snow device and Amazon S3. This value is set to 0
* (zero) until all the keys that will be transferred have been listed.
*/
public void setTotalObjects(Long totalObjects) {
this.totalObjects = totalObjects;
}
/**
*
* The total number of objects for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero)
* until all the keys that will be transferred have been listed.
*
*
* @return The total number of objects for a transfer between a Snow device and Amazon S3. This value is set to 0
* (zero) until all the keys that will be transferred have been listed.
*/
public Long getTotalObjects() {
return this.totalObjects;
}
/**
*
* The total number of objects for a transfer between a Snow device and Amazon S3. This value is set to 0 (zero)
* until all the keys that will be transferred have been listed.
*
*
* @param totalObjects
* The total number of objects for a transfer between a Snow device and Amazon S3. This value is set to 0
* (zero) until all the keys that will be transferred have been listed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DataTransfer withTotalObjects(Long totalObjects) {
setTotalObjects(totalObjects);
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 (getBytesTransferred() != null)
sb.append("BytesTransferred: ").append(getBytesTransferred()).append(",");
if (getObjectsTransferred() != null)
sb.append("ObjectsTransferred: ").append(getObjectsTransferred()).append(",");
if (getTotalBytes() != null)
sb.append("TotalBytes: ").append(getTotalBytes()).append(",");
if (getTotalObjects() != null)
sb.append("TotalObjects: ").append(getTotalObjects());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DataTransfer == false)
return false;
DataTransfer other = (DataTransfer) obj;
if (other.getBytesTransferred() == null ^ this.getBytesTransferred() == null)
return false;
if (other.getBytesTransferred() != null && other.getBytesTransferred().equals(this.getBytesTransferred()) == false)
return false;
if (other.getObjectsTransferred() == null ^ this.getObjectsTransferred() == null)
return false;
if (other.getObjectsTransferred() != null && other.getObjectsTransferred().equals(this.getObjectsTransferred()) == false)
return false;
if (other.getTotalBytes() == null ^ this.getTotalBytes() == null)
return false;
if (other.getTotalBytes() != null && other.getTotalBytes().equals(this.getTotalBytes()) == false)
return false;
if (other.getTotalObjects() == null ^ this.getTotalObjects() == null)
return false;
if (other.getTotalObjects() != null && other.getTotalObjects().equals(this.getTotalObjects()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getBytesTransferred() == null) ? 0 : getBytesTransferred().hashCode());
hashCode = prime * hashCode + ((getObjectsTransferred() == null) ? 0 : getObjectsTransferred().hashCode());
hashCode = prime * hashCode + ((getTotalBytes() == null) ? 0 : getTotalBytes().hashCode());
hashCode = prime * hashCode + ((getTotalObjects() == null) ? 0 : getTotalObjects().hashCode());
return hashCode;
}
@Override
public DataTransfer clone() {
try {
return (DataTransfer) 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.snowball.model.transform.DataTransferMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}