
com.amazonaws.services.iotsitewise.model.DescribeGatewayCapabilityConfigurationResult 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;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeGatewayCapabilityConfigurationResult extends com.amazonaws.AmazonWebServiceResult implements Serializable,
Cloneable {
/**
*
* The ID of the gateway that defines the capability configuration.
*
*/
private String gatewayId;
/**
*
* The namespace of the gateway capability.
*
*/
private String capabilityNamespace;
/**
*
* The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.
*
*/
private String capabilityConfiguration;
/**
*
* 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 ID of the gateway that defines the capability configuration.
*
*
* @param gatewayId
* The ID of the gateway that defines the capability configuration.
*/
public void setGatewayId(String gatewayId) {
this.gatewayId = gatewayId;
}
/**
*
* The ID of the gateway that defines the capability configuration.
*
*
* @return The ID of the gateway that defines the capability configuration.
*/
public String getGatewayId() {
return this.gatewayId;
}
/**
*
* The ID of the gateway that defines the capability configuration.
*
*
* @param gatewayId
* The ID of the gateway that defines the capability configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeGatewayCapabilityConfigurationResult withGatewayId(String gatewayId) {
setGatewayId(gatewayId);
return this;
}
/**
*
* The namespace of the gateway capability.
*
*
* @param capabilityNamespace
* The namespace of the gateway capability.
*/
public void setCapabilityNamespace(String capabilityNamespace) {
this.capabilityNamespace = capabilityNamespace;
}
/**
*
* The namespace of the gateway capability.
*
*
* @return The namespace of the gateway capability.
*/
public String getCapabilityNamespace() {
return this.capabilityNamespace;
}
/**
*
* The namespace of the gateway capability.
*
*
* @param capabilityNamespace
* The namespace of the gateway capability.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeGatewayCapabilityConfigurationResult withCapabilityNamespace(String capabilityNamespace) {
setCapabilityNamespace(capabilityNamespace);
return this;
}
/**
*
* The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.
*
*
* @param capabilityConfiguration
* The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.
*/
public void setCapabilityConfiguration(String capabilityConfiguration) {
this.capabilityConfiguration = capabilityConfiguration;
}
/**
*
* The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.
*
*
* @return The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.
*/
public String getCapabilityConfiguration() {
return this.capabilityConfiguration;
}
/**
*
* The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.
*
*
* @param capabilityConfiguration
* The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeGatewayCapabilityConfigurationResult withCapabilityConfiguration(String capabilityConfiguration) {
setCapabilityConfiguration(capabilityConfiguration);
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 DescribeGatewayCapabilityConfigurationResult 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 DescribeGatewayCapabilityConfigurationResult 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 (getGatewayId() != null)
sb.append("GatewayId: ").append(getGatewayId()).append(",");
if (getCapabilityNamespace() != null)
sb.append("CapabilityNamespace: ").append(getCapabilityNamespace()).append(",");
if (getCapabilityConfiguration() != null)
sb.append("CapabilityConfiguration: ").append(getCapabilityConfiguration()).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 DescribeGatewayCapabilityConfigurationResult == false)
return false;
DescribeGatewayCapabilityConfigurationResult other = (DescribeGatewayCapabilityConfigurationResult) obj;
if (other.getGatewayId() == null ^ this.getGatewayId() == null)
return false;
if (other.getGatewayId() != null && other.getGatewayId().equals(this.getGatewayId()) == false)
return false;
if (other.getCapabilityNamespace() == null ^ this.getCapabilityNamespace() == null)
return false;
if (other.getCapabilityNamespace() != null && other.getCapabilityNamespace().equals(this.getCapabilityNamespace()) == false)
return false;
if (other.getCapabilityConfiguration() == null ^ this.getCapabilityConfiguration() == null)
return false;
if (other.getCapabilityConfiguration() != null && other.getCapabilityConfiguration().equals(this.getCapabilityConfiguration()) == 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 + ((getGatewayId() == null) ? 0 : getGatewayId().hashCode());
hashCode = prime * hashCode + ((getCapabilityNamespace() == null) ? 0 : getCapabilityNamespace().hashCode());
hashCode = prime * hashCode + ((getCapabilityConfiguration() == null) ? 0 : getCapabilityConfiguration().hashCode());
hashCode = prime * hashCode + ((getCapabilitySyncStatus() == null) ? 0 : getCapabilitySyncStatus().hashCode());
return hashCode;
}
@Override
public DescribeGatewayCapabilityConfigurationResult clone() {
try {
return (DescribeGatewayCapabilityConfigurationResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}