Interface CreateGatewayRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateGatewayRequest.Builder,CreateGatewayRequest>, IoTSiteWiseRequest.Builder, SdkBuilder<CreateGatewayRequest.Builder,CreateGatewayRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateGatewayRequest

@Mutable
@NotThreadSafe
public static interface CreateGatewayRequest.Builder
extends IoTSiteWiseRequest.Builder, SdkPojo, CopyableBuilder<CreateGatewayRequest.Builder,CreateGatewayRequest>

Method Summary

Modifier and Type	Method	Description
CreateGatewayRequest.Builder	gatewayName(String gatewayName)	A unique name for the gateway.
default CreateGatewayRequest.Builder	gatewayPlatform(Consumer<GatewayPlatform.Builder> gatewayPlatform)	The gateway's platform.
CreateGatewayRequest.Builder	gatewayPlatform(GatewayPlatform gatewayPlatform)	The gateway's platform.
CreateGatewayRequest.Builder	gatewayVersion(String gatewayVersion)	The version of the gateway to create.
CreateGatewayRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateGatewayRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateGatewayRequest.Builder	tags(Map<String,String> tags)	A list of key-value pairs that contain metadata for the gateway.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

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

build

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

gatewayName

CreateGatewayRequest.Builder gatewayName(String gatewayName)

A unique name for the gateway.

Parameters:

gatewayName - A unique name for the gateway.

Returns:

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

gatewayPlatform

CreateGatewayRequest.Builder gatewayPlatform(GatewayPlatform gatewayPlatform)

The gateway's platform. You can only specify one platform in a gateway.

Parameters:

gatewayPlatform - The gateway's platform. You can only specify one platform in a gateway.

Returns:

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

gatewayPlatform

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

The gateway's platform. You can only specify one platform in a gateway.

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

CreateGatewayRequest.Builder gatewayVersion(String gatewayVersion)

The version of the gateway to create. Specify 3 to create an MQTT-enabled, V3 gateway and 2 to create a Classic streams, V2 gateway. If not specified, the default is 2 (Classic streams, V2 gateway).

When creating a V3 gateway (gatewayVersion=3) with the GreengrassV2 platform, you must also specify the coreDeviceOperatingSystem parameter.

We recommend creating an MQTT-enabled gateway for self-hosted gateways and Siemens Industrial Edge gateways. For more information on gateway versions, see Use Amazon Web Services IoT SiteWise Edge Edge gateways.

Parameters:

gatewayVersion - The version of the gateway to create. Specify 3 to create an MQTT-enabled, V3 gateway and 2 to create a Classic streams, V2 gateway. If not specified, the default is 2 (Classic streams, V2 gateway).

When creating a V3 gateway (gatewayVersion=3) with the GreengrassV2 platform, you must also specify the coreDeviceOperatingSystem parameter.

We recommend creating an MQTT-enabled gateway for self-hosted gateways and Siemens Industrial Edge gateways. For more information on gateway versions, see Use Amazon Web Services IoT SiteWise Edge Edge gateways.

Returns:

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

tags

CreateGatewayRequest.Builder tags(Map<String,String> tags)

A list of key-value pairs that contain metadata for the gateway. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

Parameters:

tags - A list of key-value pairs that contain metadata for the gateway. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

Returns:

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

overrideConfiguration

CreateGatewayRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateGatewayRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.