Package software.amazon.awssdk.services.iotsitewise.model

Class DescribeGatewayResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse

software.amazon.awssdk.services.iotsitewise.model.DescribeGatewayResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeGatewayResponse.Builder,DescribeGatewayResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeGatewayResponse
extends IoTSiteWiseResponse
implements ToCopyableBuilder<DescribeGatewayResponse.Builder,DescribeGatewayResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeGatewayResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeGatewayResponse.Builder	builder()
Instant	creationDate()	The date the gateway was created, in Unix epoch time.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	gatewayArn()	The ARN of the gateway, which has the following format.
List<GatewayCapabilitySummary>	gatewayCapabilitySummaries()	A list of gateway capability summaries that each contain a namespace and status.
String	gatewayId()	The ID of the gateway device.
String	gatewayName()	The name of the gateway.
GatewayPlatform	gatewayPlatform()	The gateway's platform.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasGatewayCapabilitySummaries()	For responses, this returns true if the service returned a value for the GatewayCapabilitySummaries property.
int	hashCode()
Instant	lastUpdateDate()	The date the gateway was last updated, in Unix epoch time.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeGatewayResponse.Builder>	serializableBuilderClass()
DescribeGatewayResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse

responseMetadata

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

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

gatewayId

public final String gatewayId()

The ID of the gateway device.

Returns:

The ID of the gateway device.

gatewayName

public final String gatewayName()

The name of the gateway.

Returns:

The name of the gateway.

gatewayArn

public final String gatewayArn()

The ARN of the gateway, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}

Returns:

The ARN of the gateway, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}

gatewayPlatform

public final GatewayPlatform gatewayPlatform()

The gateway's platform.

Returns:

The gateway's platform.

hasGatewayCapabilitySummaries

public final boolean hasGatewayCapabilitySummaries()

For responses, this returns true if the service returned a value for the GatewayCapabilitySummaries property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

gatewayCapabilitySummaries

public final List<GatewayCapabilitySummary> gatewayCapabilitySummaries()

A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGatewayCapabilitySummaries() method.

Returns:

A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration.

creationDate

public final Instant creationDate()

The date the gateway was created, in Unix epoch time.

Returns:

The date the gateway was created, in Unix epoch time.

lastUpdateDate

public final Instant lastUpdateDate()

The date the gateway was last updated, in Unix epoch time.

Returns:

The date the gateway was last updated, in Unix epoch time.

toBuilder

public DescribeGatewayResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeGatewayResponse.Builder,DescribeGatewayResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeGatewayResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeGatewayResponse.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo