com.amazonaws.services.controltower.model.ControlOperation Maven / Gradle / Ivy
Show all versions of aws-java-sdk-controltower 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.controltower.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* An operation performed by the control.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ControlOperation implements Serializable, Cloneable, StructuredPojo {
/**
*
* The controlIdentifier
of the control for the operation.
*
*/
private String controlIdentifier;
/**
*
* The controlIdentifier
of the enabled control.
*
*/
private String enabledControlIdentifier;
/**
*
* The time that the operation finished.
*
*/
private java.util.Date endTime;
/**
*
* The identifier of the specified operation.
*
*/
private String operationIdentifier;
/**
*
* One of ENABLE_CONTROL
or DISABLE_CONTROL
.
*
*/
private String operationType;
/**
*
* The time that the operation began.
*
*/
private java.util.Date startTime;
/**
*
* One of IN_PROGRESS
, SUCEEDED
, or FAILED
.
*
*/
private String status;
/**
*
* If the operation result is FAILED
, this string contains a message explaining why the operation
* failed.
*
*/
private String statusMessage;
/**
*
* The target upon which the control operation is working.
*
*/
private String targetIdentifier;
/**
*
* The controlIdentifier
of the control for the operation.
*
*
* @param controlIdentifier
* The controlIdentifier
of the control for the operation.
*/
public void setControlIdentifier(String controlIdentifier) {
this.controlIdentifier = controlIdentifier;
}
/**
*
* The controlIdentifier
of the control for the operation.
*
*
* @return The controlIdentifier
of the control for the operation.
*/
public String getControlIdentifier() {
return this.controlIdentifier;
}
/**
*
* The controlIdentifier
of the control for the operation.
*
*
* @param controlIdentifier
* The controlIdentifier
of the control for the operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ControlOperation withControlIdentifier(String controlIdentifier) {
setControlIdentifier(controlIdentifier);
return this;
}
/**
*
* The controlIdentifier
of the enabled control.
*
*
* @param enabledControlIdentifier
* The controlIdentifier
of the enabled control.
*/
public void setEnabledControlIdentifier(String enabledControlIdentifier) {
this.enabledControlIdentifier = enabledControlIdentifier;
}
/**
*
* The controlIdentifier
of the enabled control.
*
*
* @return The controlIdentifier
of the enabled control.
*/
public String getEnabledControlIdentifier() {
return this.enabledControlIdentifier;
}
/**
*
* The controlIdentifier
of the enabled control.
*
*
* @param enabledControlIdentifier
* The controlIdentifier
of the enabled control.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ControlOperation withEnabledControlIdentifier(String enabledControlIdentifier) {
setEnabledControlIdentifier(enabledControlIdentifier);
return this;
}
/**
*
* The time that the operation finished.
*
*
* @param endTime
* The time that the operation finished.
*/
public void setEndTime(java.util.Date endTime) {
this.endTime = endTime;
}
/**
*
* The time that the operation finished.
*
*
* @return The time that the operation finished.
*/
public java.util.Date getEndTime() {
return this.endTime;
}
/**
*
* The time that the operation finished.
*
*
* @param endTime
* The time that the operation finished.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ControlOperation withEndTime(java.util.Date endTime) {
setEndTime(endTime);
return this;
}
/**
*
* The identifier of the specified operation.
*
*
* @param operationIdentifier
* The identifier of the specified operation.
*/
public void setOperationIdentifier(String operationIdentifier) {
this.operationIdentifier = operationIdentifier;
}
/**
*
* The identifier of the specified operation.
*
*
* @return The identifier of the specified operation.
*/
public String getOperationIdentifier() {
return this.operationIdentifier;
}
/**
*
* The identifier of the specified operation.
*
*
* @param operationIdentifier
* The identifier of the specified operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ControlOperation withOperationIdentifier(String operationIdentifier) {
setOperationIdentifier(operationIdentifier);
return this;
}
/**
*
* One of ENABLE_CONTROL
or DISABLE_CONTROL
.
*
*
* @param operationType
* One of ENABLE_CONTROL
or DISABLE_CONTROL
.
* @see ControlOperationType
*/
public void setOperationType(String operationType) {
this.operationType = operationType;
}
/**
*
* One of ENABLE_CONTROL
or DISABLE_CONTROL
.
*
*
* @return One of ENABLE_CONTROL
or DISABLE_CONTROL
.
* @see ControlOperationType
*/
public String getOperationType() {
return this.operationType;
}
/**
*
* One of ENABLE_CONTROL
or DISABLE_CONTROL
.
*
*
* @param operationType
* One of ENABLE_CONTROL
or DISABLE_CONTROL
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ControlOperationType
*/
public ControlOperation withOperationType(String operationType) {
setOperationType(operationType);
return this;
}
/**
*
* One of ENABLE_CONTROL
or DISABLE_CONTROL
.
*
*
* @param operationType
* One of ENABLE_CONTROL
or DISABLE_CONTROL
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ControlOperationType
*/
public ControlOperation withOperationType(ControlOperationType operationType) {
this.operationType = operationType.toString();
return this;
}
/**
*
* The time that the operation began.
*
*
* @param startTime
* The time that the operation began.
*/
public void setStartTime(java.util.Date startTime) {
this.startTime = startTime;
}
/**
*
* The time that the operation began.
*
*
* @return The time that the operation began.
*/
public java.util.Date getStartTime() {
return this.startTime;
}
/**
*
* The time that the operation began.
*
*
* @param startTime
* The time that the operation began.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ControlOperation withStartTime(java.util.Date startTime) {
setStartTime(startTime);
return this;
}
/**
*
* One of IN_PROGRESS
, SUCEEDED
, or FAILED
.
*
*
* @param status
* One of IN_PROGRESS
, SUCEEDED
, or FAILED
.
* @see ControlOperationStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* One of IN_PROGRESS
, SUCEEDED
, or FAILED
.
*
*
* @return One of IN_PROGRESS
, SUCEEDED
, or FAILED
.
* @see ControlOperationStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* One of IN_PROGRESS
, SUCEEDED
, or FAILED
.
*
*
* @param status
* One of IN_PROGRESS
, SUCEEDED
, or FAILED
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ControlOperationStatus
*/
public ControlOperation withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* One of IN_PROGRESS
, SUCEEDED
, or FAILED
.
*
*
* @param status
* One of IN_PROGRESS
, SUCEEDED
, or FAILED
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ControlOperationStatus
*/
public ControlOperation withStatus(ControlOperationStatus status) {
this.status = status.toString();
return this;
}
/**
*
* If the operation result is FAILED
, this string contains a message explaining why the operation
* failed.
*
*
* @param statusMessage
* If the operation result is FAILED
, this string contains a message explaining why the
* operation failed.
*/
public void setStatusMessage(String statusMessage) {
this.statusMessage = statusMessage;
}
/**
*
* If the operation result is FAILED
, this string contains a message explaining why the operation
* failed.
*
*
* @return If the operation result is FAILED
, this string contains a message explaining why the
* operation failed.
*/
public String getStatusMessage() {
return this.statusMessage;
}
/**
*
* If the operation result is FAILED
, this string contains a message explaining why the operation
* failed.
*
*
* @param statusMessage
* If the operation result is FAILED
, this string contains a message explaining why the
* operation failed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ControlOperation withStatusMessage(String statusMessage) {
setStatusMessage(statusMessage);
return this;
}
/**
*
* The target upon which the control operation is working.
*
*
* @param targetIdentifier
* The target upon which the control operation is working.
*/
public void setTargetIdentifier(String targetIdentifier) {
this.targetIdentifier = targetIdentifier;
}
/**
*
* The target upon which the control operation is working.
*
*
* @return The target upon which the control operation is working.
*/
public String getTargetIdentifier() {
return this.targetIdentifier;
}
/**
*
* The target upon which the control operation is working.
*
*
* @param targetIdentifier
* The target upon which the control operation is working.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ControlOperation withTargetIdentifier(String targetIdentifier) {
setTargetIdentifier(targetIdentifier);
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 (getControlIdentifier() != null)
sb.append("ControlIdentifier: ").append(getControlIdentifier()).append(",");
if (getEnabledControlIdentifier() != null)
sb.append("EnabledControlIdentifier: ").append(getEnabledControlIdentifier()).append(",");
if (getEndTime() != null)
sb.append("EndTime: ").append(getEndTime()).append(",");
if (getOperationIdentifier() != null)
sb.append("OperationIdentifier: ").append(getOperationIdentifier()).append(",");
if (getOperationType() != null)
sb.append("OperationType: ").append(getOperationType()).append(",");
if (getStartTime() != null)
sb.append("StartTime: ").append(getStartTime()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getStatusMessage() != null)
sb.append("StatusMessage: ").append(getStatusMessage()).append(",");
if (getTargetIdentifier() != null)
sb.append("TargetIdentifier: ").append(getTargetIdentifier());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ControlOperation == false)
return false;
ControlOperation other = (ControlOperation) obj;
if (other.getControlIdentifier() == null ^ this.getControlIdentifier() == null)
return false;
if (other.getControlIdentifier() != null && other.getControlIdentifier().equals(this.getControlIdentifier()) == false)
return false;
if (other.getEnabledControlIdentifier() == null ^ this.getEnabledControlIdentifier() == null)
return false;
if (other.getEnabledControlIdentifier() != null && other.getEnabledControlIdentifier().equals(this.getEnabledControlIdentifier()) == false)
return false;
if (other.getEndTime() == null ^ this.getEndTime() == null)
return false;
if (other.getEndTime() != null && other.getEndTime().equals(this.getEndTime()) == false)
return false;
if (other.getOperationIdentifier() == null ^ this.getOperationIdentifier() == null)
return false;
if (other.getOperationIdentifier() != null && other.getOperationIdentifier().equals(this.getOperationIdentifier()) == false)
return false;
if (other.getOperationType() == null ^ this.getOperationType() == null)
return false;
if (other.getOperationType() != null && other.getOperationType().equals(this.getOperationType()) == 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.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getStatusMessage() == null ^ this.getStatusMessage() == null)
return false;
if (other.getStatusMessage() != null && other.getStatusMessage().equals(this.getStatusMessage()) == false)
return false;
if (other.getTargetIdentifier() == null ^ this.getTargetIdentifier() == null)
return false;
if (other.getTargetIdentifier() != null && other.getTargetIdentifier().equals(this.getTargetIdentifier()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getControlIdentifier() == null) ? 0 : getControlIdentifier().hashCode());
hashCode = prime * hashCode + ((getEnabledControlIdentifier() == null) ? 0 : getEnabledControlIdentifier().hashCode());
hashCode = prime * hashCode + ((getEndTime() == null) ? 0 : getEndTime().hashCode());
hashCode = prime * hashCode + ((getOperationIdentifier() == null) ? 0 : getOperationIdentifier().hashCode());
hashCode = prime * hashCode + ((getOperationType() == null) ? 0 : getOperationType().hashCode());
hashCode = prime * hashCode + ((getStartTime() == null) ? 0 : getStartTime().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getStatusMessage() == null) ? 0 : getStatusMessage().hashCode());
hashCode = prime * hashCode + ((getTargetIdentifier() == null) ? 0 : getTargetIdentifier().hashCode());
return hashCode;
}
@Override
public ControlOperation clone() {
try {
return (ControlOperation) 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.controltower.model.transform.ControlOperationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}