public class DescribeThingResult
extends java.lang.Object
implements java.io.Serializable
The output from the DescribeThing operation.
Constructor and Description |
---|
DescribeThingResult() |
Modifier and Type | Method and Description |
---|---|
DescribeThingResult |
addattributesEntry(java.lang.String key,
java.lang.String value)
The thing attributes.
|
DescribeThingResult |
clearattributesEntries()
Removes all the entries added into attributes.
|
boolean |
equals(java.lang.Object obj) |
java.util.Map<java.lang.String,java.lang.String> |
getAttributes()
The thing attributes.
|
java.lang.String |
getBillingGroupName()
The name of the billing group the thing belongs to.
|
java.lang.String |
getDefaultClientId()
The default MQTT client ID.
|
java.lang.String |
getThingArn()
The ARN of the thing to describe.
|
java.lang.String |
getThingId()
The ID of the thing to describe.
|
java.lang.String |
getThingName()
The name of the thing.
|
java.lang.String |
getThingTypeName()
The thing type name.
|
java.lang.Long |
getVersion()
The current version of the thing record in the registry.
|
int |
hashCode() |
void |
setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
The thing attributes.
|
void |
setBillingGroupName(java.lang.String billingGroupName)
The name of the billing group the thing belongs to.
|
void |
setDefaultClientId(java.lang.String defaultClientId)
The default MQTT client ID.
|
void |
setThingArn(java.lang.String thingArn)
The ARN of the thing to describe.
|
void |
setThingId(java.lang.String thingId)
The ID of the thing to describe.
|
void |
setThingName(java.lang.String thingName)
The name of the thing.
|
void |
setThingTypeName(java.lang.String thingTypeName)
The thing type name.
|
void |
setVersion(java.lang.Long version)
The current version of the thing record in the registry.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeThingResult |
withAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
The thing attributes.
|
DescribeThingResult |
withBillingGroupName(java.lang.String billingGroupName)
The name of the billing group the thing belongs to.
|
DescribeThingResult |
withDefaultClientId(java.lang.String defaultClientId)
The default MQTT client ID.
|
DescribeThingResult |
withThingArn(java.lang.String thingArn)
The ARN of the thing to describe.
|
DescribeThingResult |
withThingId(java.lang.String thingId)
The ID of the thing to describe.
|
DescribeThingResult |
withThingName(java.lang.String thingName)
The name of the thing.
|
DescribeThingResult |
withThingTypeName(java.lang.String thingTypeName)
The thing type name.
|
DescribeThingResult |
withVersion(java.lang.Long version)
The current version of the thing record in the registry.
|
public java.lang.String getDefaultClientId()
The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.
This lets you better organize your AWS IoT fleet without removing the flexibility of the underlying device certificate model or shadows.
The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.
This lets you better organize your AWS IoT fleet without removing the flexibility of the underlying device certificate model or shadows.
public void setDefaultClientId(java.lang.String defaultClientId)
The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.
This lets you better organize your AWS IoT fleet without removing the flexibility of the underlying device certificate model or shadows.
defaultClientId
- The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.
This lets you better organize your AWS IoT fleet without removing the flexibility of the underlying device certificate model or shadows.
public DescribeThingResult withDefaultClientId(java.lang.String defaultClientId)
The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.
This lets you better organize your AWS IoT fleet without removing the flexibility of the underlying device certificate model or shadows.
Returns a reference to this object so that method calls can be chained together.
defaultClientId
- The default MQTT client ID. For a typical device, the thing name is also used as the default MQTT client ID. Although we don’t require a mapping between a thing's registry name and its use of MQTT client IDs, certificates, or shadow state, we recommend that you choose a thing name and use it as the MQTT client ID for the registry and the Device Shadow service.
This lets you better organize your AWS IoT fleet without removing the flexibility of the underlying device certificate model or shadows.
public java.lang.String getThingName()
The name of the thing.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
The name of the thing.
public void setThingName(java.lang.String thingName)
The name of the thing.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
thingName
- The name of the thing.
public DescribeThingResult withThingName(java.lang.String thingName)
The name of the thing.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
thingName
- The name of the thing.
public java.lang.String getThingId()
The ID of the thing to describe.
The ID of the thing to describe.
public void setThingId(java.lang.String thingId)
The ID of the thing to describe.
thingId
- The ID of the thing to describe.
public DescribeThingResult withThingId(java.lang.String thingId)
The ID of the thing to describe.
Returns a reference to this object so that method calls can be chained together.
thingId
- The ID of the thing to describe.
public java.lang.String getThingArn()
The ARN of the thing to describe.
The ARN of the thing to describe.
public void setThingArn(java.lang.String thingArn)
The ARN of the thing to describe.
thingArn
- The ARN of the thing to describe.
public DescribeThingResult withThingArn(java.lang.String thingArn)
The ARN of the thing to describe.
Returns a reference to this object so that method calls can be chained together.
thingArn
- The ARN of the thing to describe.
public java.lang.String getThingTypeName()
The thing type name.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
The thing type name.
public void setThingTypeName(java.lang.String thingTypeName)
The thing type name.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
thingTypeName
- The thing type name.
public DescribeThingResult withThingTypeName(java.lang.String thingTypeName)
The thing type name.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
thingTypeName
- The thing type name.
public java.util.Map<java.lang.String,java.lang.String> getAttributes()
The thing attributes.
The thing attributes.
public void setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
The thing attributes.
attributes
- The thing attributes.
public DescribeThingResult withAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
The thing attributes.
Returns a reference to this object so that method calls can be chained together.
attributes
- The thing attributes.
public DescribeThingResult addattributesEntry(java.lang.String key, java.lang.String value)
The thing attributes.
The method adds a new key-value pair into attributes parameter, and returns a reference to this object so that method calls can be chained together.
key
- The key of the entry to be added into attributes.value
- The corresponding value of the entry to be added into
attributes.public DescribeThingResult clearattributesEntries()
Returns a reference to this object so that method calls can be chained together.
public java.lang.Long getVersion()
The current version of the thing record in the registry.
To avoid unintentional changes to the information in the registry, you
can pass the version information in the expectedVersion
parameter of the UpdateThing
and DeleteThing
calls.
The current version of the thing record in the registry.
To avoid unintentional changes to the information in the
registry, you can pass the version information in the
expectedVersion
parameter of the
UpdateThing
and DeleteThing
calls.
public void setVersion(java.lang.Long version)
The current version of the thing record in the registry.
To avoid unintentional changes to the information in the registry, you
can pass the version information in the expectedVersion
parameter of the UpdateThing
and DeleteThing
calls.
version
- The current version of the thing record in the registry.
To avoid unintentional changes to the information in the
registry, you can pass the version information in the
expectedVersion
parameter of the
UpdateThing
and DeleteThing
calls.
public DescribeThingResult withVersion(java.lang.Long version)
The current version of the thing record in the registry.
To avoid unintentional changes to the information in the registry, you
can pass the version information in the expectedVersion
parameter of the UpdateThing
and DeleteThing
calls.
Returns a reference to this object so that method calls can be chained together.
version
- The current version of the thing record in the registry.
To avoid unintentional changes to the information in the
registry, you can pass the version information in the
expectedVersion
parameter of the
UpdateThing
and DeleteThing
calls.
public java.lang.String getBillingGroupName()
The name of the billing group the thing belongs to.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
The name of the billing group the thing belongs to.
public void setBillingGroupName(java.lang.String billingGroupName)
The name of the billing group the thing belongs to.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
billingGroupName
- The name of the billing group the thing belongs to.
public DescribeThingResult withBillingGroupName(java.lang.String billingGroupName)
The name of the billing group the thing belongs to.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9:_-]+
billingGroupName
- The name of the billing group the thing belongs to.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.