software.amazon.awssdk.services.iot.model

Class DescribeThingGroupResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.iot.model.IotResponse

software.amazon.awssdk.services.iot.model.DescribeThingGroupResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeThingGroupResponse.Builder,DescribeThingGroupResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeThingGroupResponse
extends IotResponse
implements ToCopyableBuilder<DescribeThingGroupResponse.Builder,DescribeThingGroupResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeThingGroupResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeThingGroupResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
String	indexName() The dynamic thing group index name.
String	queryString() The dynamic thing group search query string.
String	queryVersion() The dynamic thing group query version.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeThingGroupResponse.Builder>	serializableBuilderClass()
DynamicGroupStatus	status() The dynamic thing group status.
String	statusAsString() The dynamic thing group status.
String	thingGroupArn() The thing group ARN.
String	thingGroupId() The thing group ID.
ThingGroupMetadata	thingGroupMetadata() Thing group metadata.
String	thingGroupName() The name of the thing group.
ThingGroupProperties	thingGroupProperties() The thing group properties.
DescribeThingGroupResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
Long	version() The version of the thing group.

Methods inherited from class software.amazon.awssdk.services.iot.model.IotResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

thingGroupName

public final String thingGroupName()

The name of the thing group.

Returns:

The name of the thing group.

thingGroupId

public final String thingGroupId()

The thing group ID.

Returns:

The thing group ID.

thingGroupArn

public final String thingGroupArn()

The thing group ARN.

Returns:

The thing group ARN.

version

public final Long version()

The version of the thing group.

Returns:

The version of the thing group.

thingGroupProperties

public final ThingGroupProperties thingGroupProperties()

The thing group properties.

Returns:

The thing group properties.

thingGroupMetadata

public final ThingGroupMetadata thingGroupMetadata()

Thing group metadata.

Returns:

Thing group metadata.

indexName

public final String indexName()

The dynamic thing group index name.

Returns:

The dynamic thing group index name.

queryString

public final String queryString()

The dynamic thing group search query string.

Returns:

The dynamic thing group search query string.

queryVersion

public final String queryVersion()

The dynamic thing group query version.

Returns:

The dynamic thing group query version.

status

public final DynamicGroupStatus status()

The dynamic thing group status.

If the service returns an enum value that is not available in the current SDK version, status will return DynamicGroupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The dynamic thing group status.

See Also:

DynamicGroupStatus

statusAsString

public final String statusAsString()

The dynamic thing group status.

If the service returns an enum value that is not available in the current SDK version, status will return DynamicGroupStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The dynamic thing group status.

See Also:

DynamicGroupStatus

toBuilder

public DescribeThingGroupResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeThingGroupResponse.Builder,DescribeThingGroupResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DescribeThingGroupResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeThingGroupResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.