Interface DescribeGatewayResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeGatewayResponse.Builder,DescribeGatewayResponse>, IoTSiteWiseResponse.Builder, SdkBuilder<DescribeGatewayResponse.Builder,DescribeGatewayResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeGatewayResponse

@Mutable
@NotThreadSafe
public static interface DescribeGatewayResponse.Builder
extends IoTSiteWiseResponse.Builder, SdkPojo, CopyableBuilder<DescribeGatewayResponse.Builder,DescribeGatewayResponse>

Method Summary

Modifier and Type	Method	Description
DescribeGatewayResponse.Builder	creationDate(Instant creationDate)	The date the gateway was created, in Unix epoch time.
DescribeGatewayResponse.Builder	gatewayArn(String gatewayArn)	The ARN of the gateway, which has the following format.
DescribeGatewayResponse.Builder	gatewayCapabilitySummaries(Collection<GatewayCapabilitySummary> gatewayCapabilitySummaries)	A list of gateway capability summaries that each contain a namespace and status.
DescribeGatewayResponse.Builder	gatewayCapabilitySummaries(Consumer<GatewayCapabilitySummary.Builder>... gatewayCapabilitySummaries)	A list of gateway capability summaries that each contain a namespace and status.
DescribeGatewayResponse.Builder	gatewayCapabilitySummaries(GatewayCapabilitySummary... gatewayCapabilitySummaries)	A list of gateway capability summaries that each contain a namespace and status.
DescribeGatewayResponse.Builder	gatewayId(String gatewayId)	The ID of the gateway device.
DescribeGatewayResponse.Builder	gatewayName(String gatewayName)	The name of the gateway.
default DescribeGatewayResponse.Builder	gatewayPlatform(Consumer<GatewayPlatform.Builder> gatewayPlatform)	The gateway's platform.
DescribeGatewayResponse.Builder	gatewayPlatform(GatewayPlatform gatewayPlatform)	The gateway's platform.
DescribeGatewayResponse.Builder	gatewayVersion(String gatewayVersion)	The version of the gateway.
DescribeGatewayResponse.Builder	lastUpdateDate(Instant lastUpdateDate)	The date the gateway was last updated, in Unix epoch time.

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

copy

Methods inherited from interface software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse.Builder

build, responseMetadata, responseMetadata

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

gatewayId

DescribeGatewayResponse.Builder gatewayId(String gatewayId)

The ID of the gateway device.

Parameters:

gatewayId - The ID of the gateway device.

Returns:

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

gatewayName

DescribeGatewayResponse.Builder gatewayName(String gatewayName)

The name of the gateway.

Parameters:

gatewayName - The name of the gateway.

Returns:

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

gatewayArn

DescribeGatewayResponse.Builder gatewayArn(String gatewayArn)

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

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

Parameters:

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

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

Returns:

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

gatewayPlatform

DescribeGatewayResponse.Builder gatewayPlatform(GatewayPlatform gatewayPlatform)

The gateway's platform.

Parameters:

gatewayPlatform - The gateway's platform.

Returns:

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

gatewayPlatform

default DescribeGatewayResponse.Builder gatewayPlatform(Consumer<GatewayPlatform.Builder> gatewayPlatform)

The gateway's platform.

This is a convenience method that creates an instance of the GatewayPlatform.Builder avoiding the need to create one manually via GatewayPlatform.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to gatewayPlatform(GatewayPlatform).

Parameters:

gatewayPlatform - a consumer that will call methods on GatewayPlatform.Builder

Returns:

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

See Also:

• gatewayPlatform(GatewayPlatform)

gatewayVersion

DescribeGatewayResponse.Builder gatewayVersion(String gatewayVersion)

The version of the gateway. A value of 3 indicates an MQTT-enabled, V3 gateway, while 2 indicates a Classic streams, V2 gateway.

Parameters:

gatewayVersion - The version of the gateway. A value of 3 indicates an MQTT-enabled, V3 gateway, while 2 indicates a Classic streams, V2 gateway.

Returns:

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

gatewayCapabilitySummaries

DescribeGatewayResponse.Builder gatewayCapabilitySummaries(Collection<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.

Parameters:

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.

Returns:

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

gatewayCapabilitySummaries

DescribeGatewayResponse.Builder gatewayCapabilitySummaries(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.

Parameters:

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.

Returns:

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

gatewayCapabilitySummaries

DescribeGatewayResponse.Builder gatewayCapabilitySummaries(Consumer<GatewayCapabilitySummary.Builder>... 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.

This is a convenience method that creates an instance of the GatewayCapabilitySummary.Builder avoiding the need to create one manually via GatewayCapabilitySummary.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to gatewayCapabilitySummaries(List<GatewayCapabilitySummary>).

Parameters:

gatewayCapabilitySummaries - a consumer that will call methods on GatewayCapabilitySummary.Builder

Returns:

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

See Also:

• gatewayCapabilitySummaries(java.util.Collection<GatewayCapabilitySummary>)

creationDate

DescribeGatewayResponse.Builder creationDate(Instant creationDate)

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

Parameters:

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

Returns:

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

lastUpdateDate

DescribeGatewayResponse.Builder lastUpdateDate(Instant lastUpdateDate)

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

Parameters:

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

Returns:

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