Interface GatewaySummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<GatewaySummary.Builder,GatewaySummary>, SdkBuilder<GatewaySummary.Builder,GatewaySummary>, SdkPojo
Enclosing class:
GatewaySummary
@Mutable @NotThreadSafe public static interface GatewaySummary.Builder extends SdkPojo, CopyableBuilder<GatewaySummary.Builder,GatewaySummary>

  • Method Details

    • gatewayId

      GatewaySummary.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

      GatewaySummary.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.

    • gatewayPlatform

      GatewaySummary.Builder gatewayPlatform(GatewayPlatform gatewayPlatform)
      Sets the value of the GatewayPlatform property for this object.
      Parameters:
      gatewayPlatform - The new value for the GatewayPlatform property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gatewayPlatform

      default GatewaySummary.Builder gatewayPlatform(Consumer<GatewayPlatform.Builder> gatewayPlatform)
      Sets the value of the GatewayPlatform property for this object. 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:

    • gatewayVersion

      GatewaySummary.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

      GatewaySummary.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

      GatewaySummary.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

      GatewaySummary.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:

    • creationDate

      GatewaySummary.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

      GatewaySummary.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.