com.amazonaws.services.iotsitewise.model.GatewayCapabilitySummary Maven / Gradle / Ivy
/*
* Copyright 2016-2021 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.iotsitewise.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Contains a summary of a gateway capability configuration.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GatewayCapabilitySummary implements Serializable, Cloneable, StructuredPojo {
/**
*
* The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise
* console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version,
* where version is a number such as 1.
*
*/
private String capabilityNamespace;
/**
*
* The synchronization status of the capability configuration. The sync status can be one of the following:
*
*
* -
*
* IN_SYNC – The gateway is running the capability configuration.
*
*
* -
*
* OUT_OF_SYNC – The gateway hasn't received the capability configuration.
*
*
* -
*
* SYNC_FAILED – The gateway rejected the capability configuration.
*
*
*
*/
private String capabilitySyncStatus;
/**
*
* The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise
* console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version,
* where version is a number such as 1.
*
*
* @param capabilityNamespace
* The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT
* SiteWise console, your OPC-UA capability configuration has the namespace
* iotsitewise:opcuacollector:version, where version is a number such as
* 1.
*/
public void setCapabilityNamespace(String capabilityNamespace) {
this.capabilityNamespace = capabilityNamespace;
}
/**
*
* The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise
* console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version,
* where version is a number such as 1.
*
*
* @return The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT
* SiteWise console, your OPC-UA capability configuration has the namespace
* iotsitewise:opcuacollector:version, where version is a number such as
* 1.
*/
public String getCapabilityNamespace() {
return this.capabilityNamespace;
}
/**
*
* The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise
* console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version,
* where version is a number such as 1.
*
*
* @param capabilityNamespace
* The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT
* SiteWise console, your OPC-UA capability configuration has the namespace
* iotsitewise:opcuacollector:version, where version is a number such as
* 1.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GatewayCapabilitySummary withCapabilityNamespace(String capabilityNamespace) {
setCapabilityNamespace(capabilityNamespace);
return this;
}
/**
*
* The synchronization status of the capability configuration. The sync status can be one of the following:
*
*
* -
*
* IN_SYNC – The gateway is running the capability configuration.
*
*
* -
*
* OUT_OF_SYNC – The gateway hasn't received the capability configuration.
*
*
* -
*
* SYNC_FAILED – The gateway rejected the capability configuration.
*
*
*
*
* @param capabilitySyncStatus
* The synchronization status of the capability configuration. The sync status can be one of the
* following:
*
* -
*
* IN_SYNC – The gateway is running the capability configuration.
*
*
* -
*
* OUT_OF_SYNC – The gateway hasn't received the capability configuration.
*
*
* -
*
* SYNC_FAILED – The gateway rejected the capability configuration.
*
*
* @see CapabilitySyncStatus
*/
public void setCapabilitySyncStatus(String capabilitySyncStatus) {
this.capabilitySyncStatus = capabilitySyncStatus;
}
/**
*
* The synchronization status of the capability configuration. The sync status can be one of the following:
*
*
* -
*
* IN_SYNC – The gateway is running the capability configuration.
*
*
* -
*
* OUT_OF_SYNC – The gateway hasn't received the capability configuration.
*
*
* -
*
* SYNC_FAILED – The gateway rejected the capability configuration.
*
*
*
*
* @return The synchronization status of the capability configuration. The sync status can be one of the
* following:
*
* -
*
* IN_SYNC – The gateway is running the capability configuration.
*
*
* -
*
* OUT_OF_SYNC – The gateway hasn't received the capability configuration.
*
*
* -
*
* SYNC_FAILED – The gateway rejected the capability configuration.
*
*
* @see CapabilitySyncStatus
*/
public String getCapabilitySyncStatus() {
return this.capabilitySyncStatus;
}
/**
*
* The synchronization status of the capability configuration. The sync status can be one of the following:
*
*
* -
*
* IN_SYNC – The gateway is running the capability configuration.
*
*
* -
*
* OUT_OF_SYNC – The gateway hasn't received the capability configuration.
*
*
* -
*
* SYNC_FAILED – The gateway rejected the capability configuration.
*
*
*
*
* @param capabilitySyncStatus
* The synchronization status of the capability configuration. The sync status can be one of the
* following:
*
* -
*
* IN_SYNC – The gateway is running the capability configuration.
*
*
* -
*
* OUT_OF_SYNC – The gateway hasn't received the capability configuration.
*
*
* -
*
* SYNC_FAILED – The gateway rejected the capability configuration.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see CapabilitySyncStatus
*/
public GatewayCapabilitySummary withCapabilitySyncStatus(String capabilitySyncStatus) {
setCapabilitySyncStatus(capabilitySyncStatus);
return this;
}
/**
*
* The synchronization status of the capability configuration. The sync status can be one of the following:
*
*
* -
*
* IN_SYNC – The gateway is running the capability configuration.
*
*
* -
*
* OUT_OF_SYNC – The gateway hasn't received the capability configuration.
*
*
* -
*
* SYNC_FAILED – The gateway rejected the capability configuration.
*
*
*
*
* @param capabilitySyncStatus
* The synchronization status of the capability configuration. The sync status can be one of the
* following:
*
* -
*
* IN_SYNC – The gateway is running the capability configuration.
*
*
* -
*
* OUT_OF_SYNC – The gateway hasn't received the capability configuration.
*
*
* -
*
* SYNC_FAILED – The gateway rejected the capability configuration.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see CapabilitySyncStatus
*/
public GatewayCapabilitySummary withCapabilitySyncStatus(CapabilitySyncStatus capabilitySyncStatus) {
this.capabilitySyncStatus = capabilitySyncStatus.toString();
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 (getCapabilityNamespace() != null)
sb.append("CapabilityNamespace: ").append(getCapabilityNamespace()).append(",");
if (getCapabilitySyncStatus() != null)
sb.append("CapabilitySyncStatus: ").append(getCapabilitySyncStatus());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GatewayCapabilitySummary == false)
return false;
GatewayCapabilitySummary other = (GatewayCapabilitySummary) obj;
if (other.getCapabilityNamespace() == null ^ this.getCapabilityNamespace() == null)
return false;
if (other.getCapabilityNamespace() != null && other.getCapabilityNamespace().equals(this.getCapabilityNamespace()) == false)
return false;
if (other.getCapabilitySyncStatus() == null ^ this.getCapabilitySyncStatus() == null)
return false;
if (other.getCapabilitySyncStatus() != null && other.getCapabilitySyncStatus().equals(this.getCapabilitySyncStatus()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCapabilityNamespace() == null) ? 0 : getCapabilityNamespace().hashCode());
hashCode = prime * hashCode + ((getCapabilitySyncStatus() == null) ? 0 : getCapabilitySyncStatus().hashCode());
return hashCode;
}
@Override
public GatewayCapabilitySummary clone() {
try {
return (GatewayCapabilitySummary) 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.iotsitewise.model.transform.GatewayCapabilitySummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}