com.amazonaws.services.iotthingsgraph.model

Class GetEntitiesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iotthingsgraph.model.GetEntitiesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetEntitiesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetEntitiesRequest()

Method Summary

Modifier and Type	Method and Description
GetEntitiesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getIds() An array of entity IDs.
Long	getNamespaceVersion() The version of the user's namespace.
int	hashCode()
void	setIds(Collection<String> ids) An array of entity IDs.
void	setNamespaceVersion(Long namespaceVersion) The version of the user's namespace.
String	toString() Returns a string representation of this object.
GetEntitiesRequest	withIds(Collection<String> ids) An array of entity IDs.
GetEntitiesRequest	withIds(String... ids) An array of entity IDs.
GetEntitiesRequest	withNamespaceVersion(Long namespaceVersion) The version of the user's namespace.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetEntitiesRequest

public GetEntitiesRequest()

Method Detail

getIds

public List<String> getIds()

An array of entity IDs.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

Returns:

An array of entity IDs.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

setIds

public void setIds(Collection<String> ids)

An array of entity IDs.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

Parameters:

ids - An array of entity IDs.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

withIds

public GetEntitiesRequest withIds(String... ids)

An array of entity IDs.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

NOTE: This method appends the values to the existing list (if any). Use setIds(java.util.Collection) or withIds(java.util.Collection) if you want to override the existing values.

Parameters:

ids - An array of entity IDs.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

Returns:

Returns a reference to this object so that method calls can be chained together.

withIds

public GetEntitiesRequest withIds(Collection<String> ids)

An array of entity IDs.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

Parameters:

ids - An array of entity IDs.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

Returns:

Returns a reference to this object so that method calls can be chained together.

setNamespaceVersion

public void setNamespaceVersion(Long namespaceVersion)

The version of the user's namespace. Defaults to the latest version of the user's namespace.

Parameters:

namespaceVersion - The version of the user's namespace. Defaults to the latest version of the user's namespace.

getNamespaceVersion

public Long getNamespaceVersion()

The version of the user's namespace. Defaults to the latest version of the user's namespace.

Returns:

The version of the user's namespace. Defaults to the latest version of the user's namespace.

withNamespaceVersion

public GetEntitiesRequest withNamespaceVersion(Long namespaceVersion)

The version of the user's namespace. Defaults to the latest version of the user's namespace.

Parameters:

namespaceVersion - The version of the user's namespace. Defaults to the latest version of the user's namespace.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetEntitiesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()