com.amazonaws.services.datasync.model.TaskReportConfig Maven / Gradle / Ivy
Show all versions of aws-java-sdk-datasync 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.datasync.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Specifies how you want to configure a task report, which provides detailed information about for your DataSync
* transfer.
*
*
* For more information, see Task
* reports.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class TaskReportConfig implements Serializable, Cloneable, StructuredPojo {
/**
*
* Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task
* reports.
*
*/
private ReportDestination destination;
/**
*
* Specifies the type of task report that you want:
*
*
* -
*
* SUMMARY_ONLY: Provides necessary details about your task, including the number of files, objects,
* and directories transferred and transfer duration.
*
*
* -
*
* STANDARD: Provides complete details about your task, including a full list of files, objects, and
* directories that were transferred, skipped, verified, and more.
*
*
*
*/
private String outputType;
/**
*
* Specifies whether you want your task report to include only what went wrong with your transfer or a list of what
* succeeded and didn't.
*
*
* -
*
* ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.
*
*
* -
*
* SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip, verify,
* and delete.
*
*
*
*/
private String reportLevel;
/**
*
* Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This
* only applies if you enable versioning on
* your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task
* execution.
*
*/
private String objectVersionIds;
/**
*
* Customizes the reporting level for aspects of your task report. For example, your report might generally only
* include errors, but you could specify that you want a list of successes and errors just for the files that
* DataSync attempted to delete in your destination location.
*
*/
private ReportOverrides overrides;
/**
*
* Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task
* reports.
*
*
* @param destination
* Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task
* reports.
*/
public void setDestination(ReportDestination destination) {
this.destination = destination;
}
/**
*
* Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task
* reports.
*
*
* @return Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task
* reports.
*/
public ReportDestination getDestination() {
return this.destination;
}
/**
*
* Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task
* reports.
*
*
* @param destination
* Specifies the Amazon S3 bucket where DataSync uploads your task report. For more information, see Task
* reports.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TaskReportConfig withDestination(ReportDestination destination) {
setDestination(destination);
return this;
}
/**
*
* Specifies the type of task report that you want:
*
*
* -
*
* SUMMARY_ONLY: Provides necessary details about your task, including the number of files, objects,
* and directories transferred and transfer duration.
*
*
* -
*
* STANDARD: Provides complete details about your task, including a full list of files, objects, and
* directories that were transferred, skipped, verified, and more.
*
*
*
*
* @param outputType
* Specifies the type of task report that you want:
*
* -
*
* SUMMARY_ONLY: Provides necessary details about your task, including the number of files,
* objects, and directories transferred and transfer duration.
*
*
* -
*
* STANDARD: Provides complete details about your task, including a full list of files, objects,
* and directories that were transferred, skipped, verified, and more.
*
*
* @see ReportOutputType
*/
public void setOutputType(String outputType) {
this.outputType = outputType;
}
/**
*
* Specifies the type of task report that you want:
*
*
* -
*
* SUMMARY_ONLY: Provides necessary details about your task, including the number of files, objects,
* and directories transferred and transfer duration.
*
*
* -
*
* STANDARD: Provides complete details about your task, including a full list of files, objects, and
* directories that were transferred, skipped, verified, and more.
*
*
*
*
* @return Specifies the type of task report that you want:
*
* -
*
* SUMMARY_ONLY: Provides necessary details about your task, including the number of files,
* objects, and directories transferred and transfer duration.
*
*
* -
*
* STANDARD: Provides complete details about your task, including a full list of files,
* objects, and directories that were transferred, skipped, verified, and more.
*
*
* @see ReportOutputType
*/
public String getOutputType() {
return this.outputType;
}
/**
*
* Specifies the type of task report that you want:
*
*
* -
*
* SUMMARY_ONLY: Provides necessary details about your task, including the number of files, objects,
* and directories transferred and transfer duration.
*
*
* -
*
* STANDARD: Provides complete details about your task, including a full list of files, objects, and
* directories that were transferred, skipped, verified, and more.
*
*
*
*
* @param outputType
* Specifies the type of task report that you want:
*
* -
*
* SUMMARY_ONLY: Provides necessary details about your task, including the number of files,
* objects, and directories transferred and transfer duration.
*
*
* -
*
* STANDARD: Provides complete details about your task, including a full list of files, objects,
* and directories that were transferred, skipped, verified, and more.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReportOutputType
*/
public TaskReportConfig withOutputType(String outputType) {
setOutputType(outputType);
return this;
}
/**
*
* Specifies the type of task report that you want:
*
*
* -
*
* SUMMARY_ONLY: Provides necessary details about your task, including the number of files, objects,
* and directories transferred and transfer duration.
*
*
* -
*
* STANDARD: Provides complete details about your task, including a full list of files, objects, and
* directories that were transferred, skipped, verified, and more.
*
*
*
*
* @param outputType
* Specifies the type of task report that you want:
*
* -
*
* SUMMARY_ONLY: Provides necessary details about your task, including the number of files,
* objects, and directories transferred and transfer duration.
*
*
* -
*
* STANDARD: Provides complete details about your task, including a full list of files, objects,
* and directories that were transferred, skipped, verified, and more.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReportOutputType
*/
public TaskReportConfig withOutputType(ReportOutputType outputType) {
this.outputType = outputType.toString();
return this;
}
/**
*
* Specifies whether you want your task report to include only what went wrong with your transfer or a list of what
* succeeded and didn't.
*
*
* -
*
* ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.
*
*
* -
*
* SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip, verify,
* and delete.
*
*
*
*
* @param reportLevel
* Specifies whether you want your task report to include only what went wrong with your transfer or a list
* of what succeeded and didn't.
*
* -
*
* ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.
*
*
* -
*
* SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip,
* verify, and delete.
*
*
* @see ReportLevel
*/
public void setReportLevel(String reportLevel) {
this.reportLevel = reportLevel;
}
/**
*
* Specifies whether you want your task report to include only what went wrong with your transfer or a list of what
* succeeded and didn't.
*
*
* -
*
* ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.
*
*
* -
*
* SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip, verify,
* and delete.
*
*
*
*
* @return Specifies whether you want your task report to include only what went wrong with your transfer or a list
* of what succeeded and didn't.
*
* -
*
* ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.
*
*
* -
*
* SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip,
* verify, and delete.
*
*
* @see ReportLevel
*/
public String getReportLevel() {
return this.reportLevel;
}
/**
*
* Specifies whether you want your task report to include only what went wrong with your transfer or a list of what
* succeeded and didn't.
*
*
* -
*
* ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.
*
*
* -
*
* SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip, verify,
* and delete.
*
*
*
*
* @param reportLevel
* Specifies whether you want your task report to include only what went wrong with your transfer or a list
* of what succeeded and didn't.
*
* -
*
* ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.
*
*
* -
*
* SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip,
* verify, and delete.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReportLevel
*/
public TaskReportConfig withReportLevel(String reportLevel) {
setReportLevel(reportLevel);
return this;
}
/**
*
* Specifies whether you want your task report to include only what went wrong with your transfer or a list of what
* succeeded and didn't.
*
*
* -
*
* ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.
*
*
* -
*
* SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip, verify,
* and delete.
*
*
*
*
* @param reportLevel
* Specifies whether you want your task report to include only what went wrong with your transfer or a list
* of what succeeded and didn't.
*
* -
*
* ERRORS_ONLY: A report shows what DataSync was unable to transfer, skip, verify, and delete.
*
*
* -
*
* SUCCESSES_AND_ERRORS: A report shows what DataSync was able and unable to transfer, skip,
* verify, and delete.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReportLevel
*/
public TaskReportConfig withReportLevel(ReportLevel reportLevel) {
this.reportLevel = reportLevel.toString();
return this;
}
/**
*
* Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This
* only applies if you enable versioning on
* your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task
* execution.
*
*
* @param objectVersionIds
* Specifies whether your task report includes the new version of each object transferred into an S3 bucket.
* This only applies if you enable
* versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the
* duration of your task execution.
* @see ObjectVersionIds
*/
public void setObjectVersionIds(String objectVersionIds) {
this.objectVersionIds = objectVersionIds;
}
/**
*
* Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This
* only applies if you enable versioning on
* your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task
* execution.
*
*
* @return Specifies whether your task report includes the new version of each object transferred into an S3 bucket.
* This only applies if you enable
* versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the
* duration of your task execution.
* @see ObjectVersionIds
*/
public String getObjectVersionIds() {
return this.objectVersionIds;
}
/**
*
* Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This
* only applies if you enable versioning on
* your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task
* execution.
*
*
* @param objectVersionIds
* Specifies whether your task report includes the new version of each object transferred into an S3 bucket.
* This only applies if you enable
* versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the
* duration of your task execution.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ObjectVersionIds
*/
public TaskReportConfig withObjectVersionIds(String objectVersionIds) {
setObjectVersionIds(objectVersionIds);
return this;
}
/**
*
* Specifies whether your task report includes the new version of each object transferred into an S3 bucket. This
* only applies if you enable versioning on
* your bucket. Keep in mind that setting this to INCLUDE can increase the duration of your task
* execution.
*
*
* @param objectVersionIds
* Specifies whether your task report includes the new version of each object transferred into an S3 bucket.
* This only applies if you enable
* versioning on your bucket. Keep in mind that setting this to INCLUDE can increase the
* duration of your task execution.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ObjectVersionIds
*/
public TaskReportConfig withObjectVersionIds(ObjectVersionIds objectVersionIds) {
this.objectVersionIds = objectVersionIds.toString();
return this;
}
/**
*
* Customizes the reporting level for aspects of your task report. For example, your report might generally only
* include errors, but you could specify that you want a list of successes and errors just for the files that
* DataSync attempted to delete in your destination location.
*
*
* @param overrides
* Customizes the reporting level for aspects of your task report. For example, your report might generally
* only include errors, but you could specify that you want a list of successes and errors just for the files
* that DataSync attempted to delete in your destination location.
*/
public void setOverrides(ReportOverrides overrides) {
this.overrides = overrides;
}
/**
*
* Customizes the reporting level for aspects of your task report. For example, your report might generally only
* include errors, but you could specify that you want a list of successes and errors just for the files that
* DataSync attempted to delete in your destination location.
*
*
* @return Customizes the reporting level for aspects of your task report. For example, your report might generally
* only include errors, but you could specify that you want a list of successes and errors just for the
* files that DataSync attempted to delete in your destination location.
*/
public ReportOverrides getOverrides() {
return this.overrides;
}
/**
*
* Customizes the reporting level for aspects of your task report. For example, your report might generally only
* include errors, but you could specify that you want a list of successes and errors just for the files that
* DataSync attempted to delete in your destination location.
*
*
* @param overrides
* Customizes the reporting level for aspects of your task report. For example, your report might generally
* only include errors, but you could specify that you want a list of successes and errors just for the files
* that DataSync attempted to delete in your destination location.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public TaskReportConfig withOverrides(ReportOverrides overrides) {
setOverrides(overrides);
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 (getDestination() != null)
sb.append("Destination: ").append(getDestination()).append(",");
if (getOutputType() != null)
sb.append("OutputType: ").append(getOutputType()).append(",");
if (getReportLevel() != null)
sb.append("ReportLevel: ").append(getReportLevel()).append(",");
if (getObjectVersionIds() != null)
sb.append("ObjectVersionIds: ").append(getObjectVersionIds()).append(",");
if (getOverrides() != null)
sb.append("Overrides: ").append(getOverrides());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof TaskReportConfig == false)
return false;
TaskReportConfig other = (TaskReportConfig) obj;
if (other.getDestination() == null ^ this.getDestination() == null)
return false;
if (other.getDestination() != null && other.getDestination().equals(this.getDestination()) == false)
return false;
if (other.getOutputType() == null ^ this.getOutputType() == null)
return false;
if (other.getOutputType() != null && other.getOutputType().equals(this.getOutputType()) == false)
return false;
if (other.getReportLevel() == null ^ this.getReportLevel() == null)
return false;
if (other.getReportLevel() != null && other.getReportLevel().equals(this.getReportLevel()) == false)
return false;
if (other.getObjectVersionIds() == null ^ this.getObjectVersionIds() == null)
return false;
if (other.getObjectVersionIds() != null && other.getObjectVersionIds().equals(this.getObjectVersionIds()) == false)
return false;
if (other.getOverrides() == null ^ this.getOverrides() == null)
return false;
if (other.getOverrides() != null && other.getOverrides().equals(this.getOverrides()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDestination() == null) ? 0 : getDestination().hashCode());
hashCode = prime * hashCode + ((getOutputType() == null) ? 0 : getOutputType().hashCode());
hashCode = prime * hashCode + ((getReportLevel() == null) ? 0 : getReportLevel().hashCode());
hashCode = prime * hashCode + ((getObjectVersionIds() == null) ? 0 : getObjectVersionIds().hashCode());
hashCode = prime * hashCode + ((getOverrides() == null) ? 0 : getOverrides().hashCode());
return hashCode;
}
@Override
public TaskReportConfig clone() {
try {
return (TaskReportConfig) 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.datasync.model.transform.TaskReportConfigMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}