software.amazon.awssdk.services.iotfleetwise.model

Interface CreateCampaignRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateCampaignRequest.Builder,CreateCampaignRequest>, IoTFleetWiseRequest.Builder, SdkBuilder<CreateCampaignRequest.Builder,CreateCampaignRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateCampaignRequest

public static interface CreateCampaignRequest.Builder
extends IoTFleetWiseRequest.Builder, SdkPojo, CopyableBuilder<CreateCampaignRequest.Builder,CreateCampaignRequest>

Method Summary

Modifier and Type	Method and Description
CreateCampaignRequest.Builder	collectionScheme(CollectionScheme collectionScheme) The data collection scheme associated with the campaign.
default CreateCampaignRequest.Builder	collectionScheme(Consumer<CollectionScheme.Builder> collectionScheme) The data collection scheme associated with the campaign.
CreateCampaignRequest.Builder	compression(Compression compression) (Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise.
CreateCampaignRequest.Builder	compression(String compression) (Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise.
CreateCampaignRequest.Builder	dataExtraDimensions(Collection<String> dataExtraDimensions) (Optional) A list of vehicle attributes to associate with a campaign.
CreateCampaignRequest.Builder	dataExtraDimensions(String... dataExtraDimensions) (Optional) A list of vehicle attributes to associate with a campaign.
CreateCampaignRequest.Builder	description(String description) An optional description of the campaign to help identify its purpose.
CreateCampaignRequest.Builder	diagnosticsMode(DiagnosticsMode diagnosticsMode) (Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
CreateCampaignRequest.Builder	diagnosticsMode(String diagnosticsMode) (Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
CreateCampaignRequest.Builder	expiryTime(Instant expiryTime) (Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).
CreateCampaignRequest.Builder	name(String name) The name of the campaign to create.
CreateCampaignRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateCampaignRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateCampaignRequest.Builder	postTriggerCollectionDuration(Long postTriggerCollectionDuration) (Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection.
CreateCampaignRequest.Builder	priority(Integer priority) (Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.
CreateCampaignRequest.Builder	signalCatalogArn(String signalCatalogArn) (Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
CreateCampaignRequest.Builder	signalsToCollect(Collection<SignalInformation> signalsToCollect) (Optional) A list of information about signals to collect.
CreateCampaignRequest.Builder	signalsToCollect(Consumer<SignalInformation.Builder>... signalsToCollect) (Optional) A list of information about signals to collect.
CreateCampaignRequest.Builder	signalsToCollect(SignalInformation... signalsToCollect) (Optional) A list of information about signals to collect.
CreateCampaignRequest.Builder	spoolingMode(SpoolingMode spoolingMode) (Optional) Whether to store collected data after a vehicle lost a connection with the cloud.
CreateCampaignRequest.Builder	spoolingMode(String spoolingMode) (Optional) Whether to store collected data after a vehicle lost a connection with the cloud.
CreateCampaignRequest.Builder	startTime(Instant startTime) (Optional) The time, in milliseconds, to deliver a campaign after it was approved.
CreateCampaignRequest.Builder	tags(Collection<Tag> tags) Metadata that can be used to manage the campaign.
CreateCampaignRequest.Builder	tags(Consumer<Tag.Builder>... tags) Metadata that can be used to manage the campaign.
CreateCampaignRequest.Builder	tags(Tag... tags) Metadata that can be used to manage the campaign.
CreateCampaignRequest.Builder	targetArn(String targetArn) The ARN of the vehicle or fleet to deploy a campaign to.

Methods inherited from interface software.amazon.awssdk.services.iotfleetwise.model.IoTFleetWiseRequest.Builder

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

name

CreateCampaignRequest.Builder name(String name)

The name of the campaign to create.

Parameters:

name - The name of the campaign to create.

Returns:

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

description

CreateCampaignRequest.Builder description(String description)

An optional description of the campaign to help identify its purpose.

Parameters:

description - An optional description of the campaign to help identify its purpose.

Returns:

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

signalCatalogArn

CreateCampaignRequest.Builder signalCatalogArn(String signalCatalogArn)

(Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.

Parameters:

signalCatalogArn - (Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.

Returns:

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

targetArn

CreateCampaignRequest.Builder targetArn(String targetArn)

The ARN of the vehicle or fleet to deploy a campaign to.

Parameters:

targetArn - The ARN of the vehicle or fleet to deploy a campaign to.

Returns:

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

startTime

CreateCampaignRequest.Builder startTime(Instant startTime)

(Optional) The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, 0 is used.

Default: 0

Parameters:

startTime - (Optional) The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, 0 is used.

Default: 0

Returns:

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

expiryTime

CreateCampaignRequest.Builder expiryTime(Instant expiryTime)

(Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data won't be collected after the campaign expires.

Default: 253402243200 (December 31, 9999, 00:00:00 UTC)

Parameters:

expiryTime - (Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data won't be collected after the campaign expires.

Default: 253402243200 (December 31, 9999, 00:00:00 UTC)

Returns:

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

postTriggerCollectionDuration

CreateCampaignRequest.Builder postTriggerCollectionDuration(Long postTriggerCollectionDuration)

(Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it's not specified, 0 is used.

Default: 0

Parameters:

postTriggerCollectionDuration - (Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it's not specified, 0 is used.

Default: 0

Returns:

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

diagnosticsMode

CreateCampaignRequest.Builder diagnosticsMode(String diagnosticsMode)

(Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you want to send diagnostic trouble codes, use SEND_ACTIVE_DTCS. If it's not specified, OFF is used.

Default: OFF

Parameters:

diagnosticsMode - (Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you want to send diagnostic trouble codes, use SEND_ACTIVE_DTCS. If it's not specified, OFF is used.

Default: OFF

Returns:

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

See Also:

DiagnosticsMode, DiagnosticsMode

diagnosticsMode

CreateCampaignRequest.Builder diagnosticsMode(DiagnosticsMode diagnosticsMode)

(Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you want to send diagnostic trouble codes, use SEND_ACTIVE_DTCS. If it's not specified, OFF is used.

Default: OFF

Parameters:

diagnosticsMode - (Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you want to send diagnostic trouble codes, use SEND_ACTIVE_DTCS. If it's not specified, OFF is used.

Default: OFF

Returns:

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

See Also:

DiagnosticsMode, DiagnosticsMode

spoolingMode

CreateCampaignRequest.Builder spoolingMode(String spoolingMode)

(Optional) Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise. If you want to store collected data when a vehicle loses connection with the cloud, use TO_DISK. If it's not specified, OFF is used.

Default: OFF

Parameters:

spoolingMode - (Optional) Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise. If you want to store collected data when a vehicle loses connection with the cloud, use TO_DISK. If it's not specified, OFF is used.

Default: OFF

Returns:

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

See Also:

SpoolingMode, SpoolingMode

spoolingMode

CreateCampaignRequest.Builder spoolingMode(SpoolingMode spoolingMode)

(Optional) Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise. If you want to store collected data when a vehicle loses connection with the cloud, use TO_DISK. If it's not specified, OFF is used.

Default: OFF

Parameters:

spoolingMode - (Optional) Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise. If you want to store collected data when a vehicle loses connection with the cloud, use TO_DISK. If it's not specified, OFF is used.

Default: OFF

Returns:

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

See Also:

SpoolingMode, SpoolingMode

compression

CreateCampaignRequest.Builder compression(String compression)

(Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you don't want to compress the signals, use OFF. If it's not specified, SNAPPY is used.

Default: SNAPPY

Parameters:

compression - (Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you don't want to compress the signals, use OFF. If it's not specified, SNAPPY is used.

Default: SNAPPY

Returns:

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

See Also:

Compression, Compression

compression

CreateCampaignRequest.Builder compression(Compression compression)

(Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you don't want to compress the signals, use OFF. If it's not specified, SNAPPY is used.

Default: SNAPPY

Parameters:

compression - (Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you don't want to compress the signals, use OFF. If it's not specified, SNAPPY is used.

Default: SNAPPY

Returns:

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

See Also:

Compression, Compression

priority

CreateCampaignRequest.Builder priority(Integer priority)

(Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified, 0 is used.

Default: 0

Parameters:

priority - (Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified, 0 is used.

Default: 0

Returns:

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

signalsToCollect

CreateCampaignRequest.Builder signalsToCollect(Collection<SignalInformation> signalsToCollect)

(Optional) A list of information about signals to collect.

Parameters:

signalsToCollect - (Optional) A list of information about signals to collect.

Returns:

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

signalsToCollect

CreateCampaignRequest.Builder signalsToCollect(SignalInformation... signalsToCollect)

(Optional) A list of information about signals to collect.

Parameters:

signalsToCollect - (Optional) A list of information about signals to collect.

Returns:

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

signalsToCollect

CreateCampaignRequest.Builder signalsToCollect(Consumer<SignalInformation.Builder>... signalsToCollect)

(Optional) A list of information about signals to collect.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #signalsToCollect(List).

Parameters:

signalsToCollect - a consumer that will call methods on SignalInformation.Builder

Returns:

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

See Also:

#signalsToCollect(java.util.Collection)

collectionScheme

CreateCampaignRequest.Builder collectionScheme(CollectionScheme collectionScheme)

The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.

Parameters:

collectionScheme - The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.

Returns:

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

collectionScheme

default CreateCampaignRequest.Builder collectionScheme(Consumer<CollectionScheme.Builder> collectionScheme)

The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.

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

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

Parameters:

collectionScheme - a consumer that will call methods on CollectionScheme.Builder

Returns:

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

See Also:

collectionScheme(CollectionScheme)

dataExtraDimensions

CreateCampaignRequest.Builder dataExtraDimensions(Collection<String> dataExtraDimensions)

(Optional) A list of vehicle attributes to associate with a campaign.

Enrich the data with specified vehicle attributes. For example, add make and model to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against make and model .

Default: An empty array

Parameters:

dataExtraDimensions - (Optional) A list of vehicle attributes to associate with a campaign.

Enrich the data with specified vehicle attributes. For example, add make and model to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against make and model.

Default: An empty array

Returns:

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

dataExtraDimensions

CreateCampaignRequest.Builder dataExtraDimensions(String... dataExtraDimensions)

(Optional) A list of vehicle attributes to associate with a campaign.

Enrich the data with specified vehicle attributes. For example, add make and model to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against make and model .

Default: An empty array

Parameters:

dataExtraDimensions - (Optional) A list of vehicle attributes to associate with a campaign.

Enrich the data with specified vehicle attributes. For example, add make and model to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against make and model.

Default: An empty array

Returns:

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

tags

CreateCampaignRequest.Builder tags(Collection<Tag> tags)

Metadata that can be used to manage the campaign.

Parameters:

tags - Metadata that can be used to manage the campaign.

Returns:

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

tags

CreateCampaignRequest.Builder tags(Tag... tags)

Metadata that can be used to manage the campaign.

Parameters:

tags - Metadata that can be used to manage the campaign.

Returns:

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

tags

CreateCampaignRequest.Builder tags(Consumer<Tag.Builder>... tags)

Metadata that can be used to manage the campaign.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

#tags(java.util.Collection)

overrideConfiguration

CreateCampaignRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder