com.amazonaws.services.backup.model.CopyJobSummary Maven / Gradle / Ivy
Show all versions of aws-java-sdk-backup 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.backup.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* This is a summary of copy jobs created or running within the most recent 30 days.
*
*
* The returned summary may contain the following: Region, Account, State, RestourceType, MessageCategory, StartTime,
* EndTime, and Count of included jobs.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CopyJobSummary implements Serializable, Cloneable, StructuredPojo {
/**
*
* This is the Amazon Web Services Regions within the job summary.
*
*/
private String region;
/**
*
* The account ID that owns the jobs within the summary.
*
*/
private String accountId;
/**
*
* This value is job count for jobs with the specified state.
*
*/
private String state;
/**
*
* This value is the job count for the specified resource type. The request GetSupportedResourceTypes
* returns strings for supported resource types
*
*/
private String resourceType;
/**
*
* This parameter is the job count for the specified message category.
*
*
* Example strings include AccessDenied, Success, and InvalidParameters. See
* Monitoring for a list of
* MessageCategory strings.
*
*
* The the value ANY returns count of all message categories.
*
*
* AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
*
*/
private String messageCategory;
/**
*
* The value as a number of jobs in a job summary.
*
*/
private Integer count;
/**
*
* The value of time in number format of a job start time.
*
*
* This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*
*/
private java.util.Date startTime;
/**
*
* The value of time in number format of a job end time.
*
*
* This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*
*/
private java.util.Date endTime;
/**
*
* This is the Amazon Web Services Regions within the job summary.
*
*
* @param region
* This is the Amazon Web Services Regions within the job summary.
*/
public void setRegion(String region) {
this.region = region;
}
/**
*
* This is the Amazon Web Services Regions within the job summary.
*
*
* @return This is the Amazon Web Services Regions within the job summary.
*/
public String getRegion() {
return this.region;
}
/**
*
* This is the Amazon Web Services Regions within the job summary.
*
*
* @param region
* This is the Amazon Web Services Regions within the job summary.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyJobSummary withRegion(String region) {
setRegion(region);
return this;
}
/**
*
* The account ID that owns the jobs within the summary.
*
*
* @param accountId
* The account ID that owns the jobs within the summary.
*/
public void setAccountId(String accountId) {
this.accountId = accountId;
}
/**
*
* The account ID that owns the jobs within the summary.
*
*
* @return The account ID that owns the jobs within the summary.
*/
public String getAccountId() {
return this.accountId;
}
/**
*
* The account ID that owns the jobs within the summary.
*
*
* @param accountId
* The account ID that owns the jobs within the summary.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyJobSummary withAccountId(String accountId) {
setAccountId(accountId);
return this;
}
/**
*
* This value is job count for jobs with the specified state.
*
*
* @param state
* This value is job count for jobs with the specified state.
* @see CopyJobStatus
*/
public void setState(String state) {
this.state = state;
}
/**
*
* This value is job count for jobs with the specified state.
*
*
* @return This value is job count for jobs with the specified state.
* @see CopyJobStatus
*/
public String getState() {
return this.state;
}
/**
*
* This value is job count for jobs with the specified state.
*
*
* @param state
* This value is job count for jobs with the specified state.
* @return Returns a reference to this object so that method calls can be chained together.
* @see CopyJobStatus
*/
public CopyJobSummary withState(String state) {
setState(state);
return this;
}
/**
*
* This value is job count for jobs with the specified state.
*
*
* @param state
* This value is job count for jobs with the specified state.
* @return Returns a reference to this object so that method calls can be chained together.
* @see CopyJobStatus
*/
public CopyJobSummary withState(CopyJobStatus state) {
this.state = state.toString();
return this;
}
/**
*
* This value is the job count for the specified resource type. The request GetSupportedResourceTypes
* returns strings for supported resource types
*
*
* @param resourceType
* This value is the job count for the specified resource type. The request
* GetSupportedResourceTypes returns strings for supported resource types
*/
public void setResourceType(String resourceType) {
this.resourceType = resourceType;
}
/**
*
* This value is the job count for the specified resource type. The request GetSupportedResourceTypes
* returns strings for supported resource types
*
*
* @return This value is the job count for the specified resource type. The request
* GetSupportedResourceTypes returns strings for supported resource types
*/
public String getResourceType() {
return this.resourceType;
}
/**
*
* This value is the job count for the specified resource type. The request GetSupportedResourceTypes
* returns strings for supported resource types
*
*
* @param resourceType
* This value is the job count for the specified resource type. The request
* GetSupportedResourceTypes returns strings for supported resource types
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyJobSummary withResourceType(String resourceType) {
setResourceType(resourceType);
return this;
}
/**
*
* This parameter is the job count for the specified message category.
*
*
* Example strings include AccessDenied, Success, and InvalidParameters. See
* Monitoring for a list of
* MessageCategory strings.
*
*
* The the value ANY returns count of all message categories.
*
*
* AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
*
*
* @param messageCategory
* This parameter is the job count for the specified message category.
*
* Example strings include AccessDenied, Success, and
* InvalidParameters. See Monitoring for a list of
* MessageCategory strings.
*
*
* The the value ANY returns count of all message categories.
*
*
* AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
*/
public void setMessageCategory(String messageCategory) {
this.messageCategory = messageCategory;
}
/**
*
* This parameter is the job count for the specified message category.
*
*
* Example strings include AccessDenied, Success, and InvalidParameters. See
* Monitoring for a list of
* MessageCategory strings.
*
*
* The the value ANY returns count of all message categories.
*
*
* AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
*
*
* @return This parameter is the job count for the specified message category.
*
* Example strings include AccessDenied, Success, and
* InvalidParameters. See Monitoring for a list
* of MessageCategory strings.
*
*
* The the value ANY returns count of all message categories.
*
*
* AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
*/
public String getMessageCategory() {
return this.messageCategory;
}
/**
*
* This parameter is the job count for the specified message category.
*
*
* Example strings include AccessDenied, Success, and InvalidParameters. See
* Monitoring for a list of
* MessageCategory strings.
*
*
* The the value ANY returns count of all message categories.
*
*
* AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
*
*
* @param messageCategory
* This parameter is the job count for the specified message category.
*
* Example strings include AccessDenied, Success, and
* InvalidParameters. See Monitoring for a list of
* MessageCategory strings.
*
*
* The the value ANY returns count of all message categories.
*
*
* AGGREGATE_ALL aggregates job counts for all message categories and returns the sum.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyJobSummary withMessageCategory(String messageCategory) {
setMessageCategory(messageCategory);
return this;
}
/**
*
* The value as a number of jobs in a job summary.
*
*
* @param count
* The value as a number of jobs in a job summary.
*/
public void setCount(Integer count) {
this.count = count;
}
/**
*
* The value as a number of jobs in a job summary.
*
*
* @return The value as a number of jobs in a job summary.
*/
public Integer getCount() {
return this.count;
}
/**
*
* The value as a number of jobs in a job summary.
*
*
* @param count
* The value as a number of jobs in a job summary.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyJobSummary withCount(Integer count) {
setCount(count);
return this;
}
/**
*
* The value of time in number format of a job start time.
*
*
* This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*
*
* @param startTime
* The value of time in number format of a job start time.
*
* This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
public void setStartTime(java.util.Date startTime) {
this.startTime = startTime;
}
/**
*
* The value of time in number format of a job start time.
*
*
* This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*
*
* @return The value of time in number format of a job start time.
*
* This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds.
* For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
public java.util.Date getStartTime() {
return this.startTime;
}
/**
*
* The value of time in number format of a job start time.
*
*
* This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*
*
* @param startTime
* The value of time in number format of a job start time.
*
* This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyJobSummary withStartTime(java.util.Date startTime) {
setStartTime(startTime);
return this;
}
/**
*
* The value of time in number format of a job end time.
*
*
* This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*
*
* @param endTime
* The value of time in number format of a job end time.
*
* This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
public void setEndTime(java.util.Date endTime) {
this.endTime = endTime;
}
/**
*
* The value of time in number format of a job end time.
*
*
* This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*
*
* @return The value of time in number format of a job end time.
*
* This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds.
* For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
public java.util.Date getEndTime() {
return this.endTime;
}
/**
*
* The value of time in number format of a job end time.
*
*
* This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*
*
* @param endTime
* The value of time in number format of a job end time.
*
* This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CopyJobSummary withEndTime(java.util.Date endTime) {
setEndTime(endTime);
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 (getRegion() != null)
sb.append("Region: ").append(getRegion()).append(",");
if (getAccountId() != null)
sb.append("AccountId: ").append(getAccountId()).append(",");
if (getState() != null)
sb.append("State: ").append(getState()).append(",");
if (getResourceType() != null)
sb.append("ResourceType: ").append(getResourceType()).append(",");
if (getMessageCategory() != null)
sb.append("MessageCategory: ").append(getMessageCategory()).append(",");
if (getCount() != null)
sb.append("Count: ").append(getCount()).append(",");
if (getStartTime() != null)
sb.append("StartTime: ").append(getStartTime()).append(",");
if (getEndTime() != null)
sb.append("EndTime: ").append(getEndTime());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CopyJobSummary == false)
return false;
CopyJobSummary other = (CopyJobSummary) obj;
if (other.getRegion() == null ^ this.getRegion() == null)
return false;
if (other.getRegion() != null && other.getRegion().equals(this.getRegion()) == false)
return false;
if (other.getAccountId() == null ^ this.getAccountId() == null)
return false;
if (other.getAccountId() != null && other.getAccountId().equals(this.getAccountId()) == false)
return false;
if (other.getState() == null ^ this.getState() == null)
return false;
if (other.getState() != null && other.getState().equals(this.getState()) == false)
return false;
if (other.getResourceType() == null ^ this.getResourceType() == null)
return false;
if (other.getResourceType() != null && other.getResourceType().equals(this.getResourceType()) == false)
return false;
if (other.getMessageCategory() == null ^ this.getMessageCategory() == null)
return false;
if (other.getMessageCategory() != null && other.getMessageCategory().equals(this.getMessageCategory()) == false)
return false;
if (other.getCount() == null ^ this.getCount() == null)
return false;
if (other.getCount() != null && other.getCount().equals(this.getCount()) == false)
return false;
if (other.getStartTime() == null ^ this.getStartTime() == null)
return false;
if (other.getStartTime() != null && other.getStartTime().equals(this.getStartTime()) == false)
return false;
if (other.getEndTime() == null ^ this.getEndTime() == null)
return false;
if (other.getEndTime() != null && other.getEndTime().equals(this.getEndTime()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getRegion() == null) ? 0 : getRegion().hashCode());
hashCode = prime * hashCode + ((getAccountId() == null) ? 0 : getAccountId().hashCode());
hashCode = prime * hashCode + ((getState() == null) ? 0 : getState().hashCode());
hashCode = prime * hashCode + ((getResourceType() == null) ? 0 : getResourceType().hashCode());
hashCode = prime * hashCode + ((getMessageCategory() == null) ? 0 : getMessageCategory().hashCode());
hashCode = prime * hashCode + ((getCount() == null) ? 0 : getCount().hashCode());
hashCode = prime * hashCode + ((getStartTime() == null) ? 0 : getStartTime().hashCode());
hashCode = prime * hashCode + ((getEndTime() == null) ? 0 : getEndTime().hashCode());
return hashCode;
}
@Override
public CopyJobSummary clone() {
try {
return (CopyJobSummary) 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.backup.model.transform.CopyJobSummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}