com.amazonaws.services.iottwinmaker.model.GetEntityResult Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-iottwinmaker Show documentation
Show all versions of aws-java-sdk-iottwinmaker Show documentation
The AWS Java SDK for AWS IoT TwinMaker module holds the client classes that are used for communicating with AWS IoT TwinMaker Service
/*
* 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.iottwinmaker.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetEntityResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The ID of the entity.
*
*/
private String entityId;
/**
*
* The name of the entity.
*
*/
private String entityName;
/**
*
* The ARN of the entity.
*
*/
private String arn;
/**
*
* The current status of the entity.
*
*/
private Status status;
/**
*
* The ID of the workspace.
*
*/
private String workspaceId;
/**
*
* The description of the entity.
*
*/
private String description;
/**
*
* An object that maps strings to the components in the entity. Each string in the mapping must be unique to this
* object.
*
*/
private java.util.Map components;
/**
*
* The ID of the parent entity for this entity.
*
*/
private String parentEntityId;
/**
*
* A Boolean value that specifies whether the entity has associated child entities.
*
*/
private Boolean hasChildEntities;
/**
*
* The date and time when the entity was created.
*
*/
private java.util.Date creationDateTime;
/**
*
* The date and time when the entity was last updated.
*
*/
private java.util.Date updateDateTime;
/**
*
* The syncSource of the sync job, if this entity was created by a sync job.
*
*/
private String syncSource;
/**
*
* This flag notes whether all components are returned in the API response. The maximum number of components
* returned is 30.
*
*/
private Boolean areAllComponentsReturned;
/**
*
* The ID of the entity.
*
*
* @param entityId
* The ID of the entity.
*/
public void setEntityId(String entityId) {
this.entityId = entityId;
}
/**
*
* The ID of the entity.
*
*
* @return The ID of the entity.
*/
public String getEntityId() {
return this.entityId;
}
/**
*
* The ID of the entity.
*
*
* @param entityId
* The ID of the entity.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetEntityResult withEntityId(String entityId) {
setEntityId(entityId);
return this;
}
/**
*
* The name of the entity.
*
*
* @param entityName
* The name of the entity.
*/
public void setEntityName(String entityName) {
this.entityName = entityName;
}
/**
*
* The name of the entity.
*
*
* @return The name of the entity.
*/
public String getEntityName() {
return this.entityName;
}
/**
*
* The name of the entity.
*
*
* @param entityName
* The name of the entity.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetEntityResult withEntityName(String entityName) {
setEntityName(entityName);
return this;
}
/**
*
* The ARN of the entity.
*
*
* @param arn
* The ARN of the entity.
*/
public void setArn(String arn) {
this.arn = arn;
}
/**
*
* The ARN of the entity.
*
*
* @return The ARN of the entity.
*/
public String getArn() {
return this.arn;
}
/**
*
* The ARN of the entity.
*
*
* @param arn
* The ARN of the entity.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetEntityResult withArn(String arn) {
setArn(arn);
return this;
}
/**
*
* The current status of the entity.
*
*
* @param status
* The current status of the entity.
*/
public void setStatus(Status status) {
this.status = status;
}
/**
*
* The current status of the entity.
*
*
* @return The current status of the entity.
*/
public Status getStatus() {
return this.status;
}
/**
*
* The current status of the entity.
*
*
* @param status
* The current status of the entity.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetEntityResult withStatus(Status status) {
setStatus(status);
return this;
}
/**
*
* The ID of the workspace.
*
*
* @param workspaceId
* The ID of the workspace.
*/
public void setWorkspaceId(String workspaceId) {
this.workspaceId = workspaceId;
}
/**
*
* The ID of the workspace.
*
*
* @return The ID of the workspace.
*/
public String getWorkspaceId() {
return this.workspaceId;
}
/**
*
* The ID of the workspace.
*
*
* @param workspaceId
* The ID of the workspace.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetEntityResult withWorkspaceId(String workspaceId) {
setWorkspaceId(workspaceId);
return this;
}
/**
*
* The description of the entity.
*
*
* @param description
* The description of the entity.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The description of the entity.
*
*
* @return The description of the entity.
*/
public String getDescription() {
return this.description;
}
/**
*
* The description of the entity.
*
*
* @param description
* The description of the entity.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetEntityResult withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* An object that maps strings to the components in the entity. Each string in the mapping must be unique to this
* object.
*
*
* @return An object that maps strings to the components in the entity. Each string in the mapping must be unique to
* this object.
*/
public java.util.Map getComponents() {
return components;
}
/**
*
* An object that maps strings to the components in the entity. Each string in the mapping must be unique to this
* object.
*
*
* @param components
* An object that maps strings to the components in the entity. Each string in the mapping must be unique to
* this object.
*/
public void setComponents(java.util.Map components) {
this.components = components;
}
/**
*
* An object that maps strings to the components in the entity. Each string in the mapping must be unique to this
* object.
*
*
* @param components
* An object that maps strings to the components in the entity. Each string in the mapping must be unique to
* this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetEntityResult withComponents(java.util.Map components) {
setComponents(components);
return this;
}
/**
* Add a single Components entry
*
* @see GetEntityResult#withComponents
* @returns a reference to this object so that method calls can be chained together.
*/
public GetEntityResult addComponentsEntry(String key, ComponentResponse value) {
if (null == this.components) {
this.components = new java.util.HashMap();
}
if (this.components.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.components.put(key, value);
return this;
}
/**
* Removes all the entries added into Components.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetEntityResult clearComponentsEntries() {
this.components = null;
return this;
}
/**
*
* The ID of the parent entity for this entity.
*
*
* @param parentEntityId
* The ID of the parent entity for this entity.
*/
public void setParentEntityId(String parentEntityId) {
this.parentEntityId = parentEntityId;
}
/**
*
* The ID of the parent entity for this entity.
*
*
* @return The ID of the parent entity for this entity.
*/
public String getParentEntityId() {
return this.parentEntityId;
}
/**
*
* The ID of the parent entity for this entity.
*
*
* @param parentEntityId
* The ID of the parent entity for this entity.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetEntityResult withParentEntityId(String parentEntityId) {
setParentEntityId(parentEntityId);
return this;
}
/**
*
* A Boolean value that specifies whether the entity has associated child entities.
*
*
* @param hasChildEntities
* A Boolean value that specifies whether the entity has associated child entities.
*/
public void setHasChildEntities(Boolean hasChildEntities) {
this.hasChildEntities = hasChildEntities;
}
/**
*
* A Boolean value that specifies whether the entity has associated child entities.
*
*
* @return A Boolean value that specifies whether the entity has associated child entities.
*/
public Boolean getHasChildEntities() {
return this.hasChildEntities;
}
/**
*
* A Boolean value that specifies whether the entity has associated child entities.
*
*
* @param hasChildEntities
* A Boolean value that specifies whether the entity has associated child entities.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetEntityResult withHasChildEntities(Boolean hasChildEntities) {
setHasChildEntities(hasChildEntities);
return this;
}
/**
*
* A Boolean value that specifies whether the entity has associated child entities.
*
*
* @return A Boolean value that specifies whether the entity has associated child entities.
*/
public Boolean isHasChildEntities() {
return this.hasChildEntities;
}
/**
*
* The date and time when the entity was created.
*
*
* @param creationDateTime
* The date and time when the entity was created.
*/
public void setCreationDateTime(java.util.Date creationDateTime) {
this.creationDateTime = creationDateTime;
}
/**
*
* The date and time when the entity was created.
*
*
* @return The date and time when the entity was created.
*/
public java.util.Date getCreationDateTime() {
return this.creationDateTime;
}
/**
*
* The date and time when the entity was created.
*
*
* @param creationDateTime
* The date and time when the entity was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetEntityResult withCreationDateTime(java.util.Date creationDateTime) {
setCreationDateTime(creationDateTime);
return this;
}
/**
*
* The date and time when the entity was last updated.
*
*
* @param updateDateTime
* The date and time when the entity was last updated.
*/
public void setUpdateDateTime(java.util.Date updateDateTime) {
this.updateDateTime = updateDateTime;
}
/**
*
* The date and time when the entity was last updated.
*
*
* @return The date and time when the entity was last updated.
*/
public java.util.Date getUpdateDateTime() {
return this.updateDateTime;
}
/**
*
* The date and time when the entity was last updated.
*
*
* @param updateDateTime
* The date and time when the entity was last updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetEntityResult withUpdateDateTime(java.util.Date updateDateTime) {
setUpdateDateTime(updateDateTime);
return this;
}
/**
*
* The syncSource of the sync job, if this entity was created by a sync job.
*
*
* @param syncSource
* The syncSource of the sync job, if this entity was created by a sync job.
*/
public void setSyncSource(String syncSource) {
this.syncSource = syncSource;
}
/**
*
* The syncSource of the sync job, if this entity was created by a sync job.
*
*
* @return The syncSource of the sync job, if this entity was created by a sync job.
*/
public String getSyncSource() {
return this.syncSource;
}
/**
*
* The syncSource of the sync job, if this entity was created by a sync job.
*
*
* @param syncSource
* The syncSource of the sync job, if this entity was created by a sync job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetEntityResult withSyncSource(String syncSource) {
setSyncSource(syncSource);
return this;
}
/**
*
* This flag notes whether all components are returned in the API response. The maximum number of components
* returned is 30.
*
*
* @param areAllComponentsReturned
* This flag notes whether all components are returned in the API response. The maximum number of components
* returned is 30.
*/
public void setAreAllComponentsReturned(Boolean areAllComponentsReturned) {
this.areAllComponentsReturned = areAllComponentsReturned;
}
/**
*
* This flag notes whether all components are returned in the API response. The maximum number of components
* returned is 30.
*
*
* @return This flag notes whether all components are returned in the API response. The maximum number of components
* returned is 30.
*/
public Boolean getAreAllComponentsReturned() {
return this.areAllComponentsReturned;
}
/**
*
* This flag notes whether all components are returned in the API response. The maximum number of components
* returned is 30.
*
*
* @param areAllComponentsReturned
* This flag notes whether all components are returned in the API response. The maximum number of components
* returned is 30.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetEntityResult withAreAllComponentsReturned(Boolean areAllComponentsReturned) {
setAreAllComponentsReturned(areAllComponentsReturned);
return this;
}
/**
*
* This flag notes whether all components are returned in the API response. The maximum number of components
* returned is 30.
*
*
* @return This flag notes whether all components are returned in the API response. The maximum number of components
* returned is 30.
*/
public Boolean isAreAllComponentsReturned() {
return this.areAllComponentsReturned;
}
/**
* 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 (getEntityId() != null)
sb.append("EntityId: ").append(getEntityId()).append(",");
if (getEntityName() != null)
sb.append("EntityName: ").append(getEntityName()).append(",");
if (getArn() != null)
sb.append("Arn: ").append(getArn()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getWorkspaceId() != null)
sb.append("WorkspaceId: ").append(getWorkspaceId()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getComponents() != null)
sb.append("Components: ").append(getComponents()).append(",");
if (getParentEntityId() != null)
sb.append("ParentEntityId: ").append(getParentEntityId()).append(",");
if (getHasChildEntities() != null)
sb.append("HasChildEntities: ").append(getHasChildEntities()).append(",");
if (getCreationDateTime() != null)
sb.append("CreationDateTime: ").append(getCreationDateTime()).append(",");
if (getUpdateDateTime() != null)
sb.append("UpdateDateTime: ").append(getUpdateDateTime()).append(",");
if (getSyncSource() != null)
sb.append("SyncSource: ").append(getSyncSource()).append(",");
if (getAreAllComponentsReturned() != null)
sb.append("AreAllComponentsReturned: ").append(getAreAllComponentsReturned());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetEntityResult == false)
return false;
GetEntityResult other = (GetEntityResult) obj;
if (other.getEntityId() == null ^ this.getEntityId() == null)
return false;
if (other.getEntityId() != null && other.getEntityId().equals(this.getEntityId()) == false)
return false;
if (other.getEntityName() == null ^ this.getEntityName() == null)
return false;
if (other.getEntityName() != null && other.getEntityName().equals(this.getEntityName()) == false)
return false;
if (other.getArn() == null ^ this.getArn() == null)
return false;
if (other.getArn() != null && other.getArn().equals(this.getArn()) == 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.getWorkspaceId() == null ^ this.getWorkspaceId() == null)
return false;
if (other.getWorkspaceId() != null && other.getWorkspaceId().equals(this.getWorkspaceId()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getComponents() == null ^ this.getComponents() == null)
return false;
if (other.getComponents() != null && other.getComponents().equals(this.getComponents()) == false)
return false;
if (other.getParentEntityId() == null ^ this.getParentEntityId() == null)
return false;
if (other.getParentEntityId() != null && other.getParentEntityId().equals(this.getParentEntityId()) == false)
return false;
if (other.getHasChildEntities() == null ^ this.getHasChildEntities() == null)
return false;
if (other.getHasChildEntities() != null && other.getHasChildEntities().equals(this.getHasChildEntities()) == false)
return false;
if (other.getCreationDateTime() == null ^ this.getCreationDateTime() == null)
return false;
if (other.getCreationDateTime() != null && other.getCreationDateTime().equals(this.getCreationDateTime()) == false)
return false;
if (other.getUpdateDateTime() == null ^ this.getUpdateDateTime() == null)
return false;
if (other.getUpdateDateTime() != null && other.getUpdateDateTime().equals(this.getUpdateDateTime()) == false)
return false;
if (other.getSyncSource() == null ^ this.getSyncSource() == null)
return false;
if (other.getSyncSource() != null && other.getSyncSource().equals(this.getSyncSource()) == false)
return false;
if (other.getAreAllComponentsReturned() == null ^ this.getAreAllComponentsReturned() == null)
return false;
if (other.getAreAllComponentsReturned() != null && other.getAreAllComponentsReturned().equals(this.getAreAllComponentsReturned()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEntityId() == null) ? 0 : getEntityId().hashCode());
hashCode = prime * hashCode + ((getEntityName() == null) ? 0 : getEntityName().hashCode());
hashCode = prime * hashCode + ((getArn() == null) ? 0 : getArn().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getWorkspaceId() == null) ? 0 : getWorkspaceId().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getComponents() == null) ? 0 : getComponents().hashCode());
hashCode = prime * hashCode + ((getParentEntityId() == null) ? 0 : getParentEntityId().hashCode());
hashCode = prime * hashCode + ((getHasChildEntities() == null) ? 0 : getHasChildEntities().hashCode());
hashCode = prime * hashCode + ((getCreationDateTime() == null) ? 0 : getCreationDateTime().hashCode());
hashCode = prime * hashCode + ((getUpdateDateTime() == null) ? 0 : getUpdateDateTime().hashCode());
hashCode = prime * hashCode + ((getSyncSource() == null) ? 0 : getSyncSource().hashCode());
hashCode = prime * hashCode + ((getAreAllComponentsReturned() == null) ? 0 : getAreAllComponentsReturned().hashCode());
return hashCode;
}
@Override
public GetEntityResult clone() {
try {
return (GetEntityResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy