Interface CreateCampaignRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateCampaignRequest.Builder,
,CreateCampaignRequest> IoTFleetWiseRequest.Builder
,SdkBuilder<CreateCampaignRequest.Builder,
,CreateCampaignRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateCampaignRequest
-
Method Summary
Modifier and TypeMethodDescriptiondefault CreateCampaignRequest.Builder
collectionScheme
(Consumer<CollectionScheme.Builder> collectionScheme) The data collection scheme associated with the campaign.collectionScheme
(CollectionScheme collectionScheme) The data collection scheme associated with the campaign.compression
(String compression) (Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise.compression
(Compression compression) (Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise.dataDestinationConfigs
(Collection<DataDestinationConfig> dataDestinationConfigs) The destination where the campaign sends data.dataDestinationConfigs
(Consumer<DataDestinationConfig.Builder>... dataDestinationConfigs) The destination where the campaign sends data.dataDestinationConfigs
(DataDestinationConfig... dataDestinationConfigs) The destination where the campaign sends data.dataExtraDimensions
(String... dataExtraDimensions) (Optional) A list of vehicle attributes to associate with a campaign.dataExtraDimensions
(Collection<String> dataExtraDimensions) (Optional) A list of vehicle attributes to associate with a campaign.description
(String description) An optional description of the campaign to help identify its purpose.diagnosticsMode
(String diagnosticsMode) (Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.diagnosticsMode
(DiagnosticsMode diagnosticsMode) (Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.expiryTime
(Instant expiryTime) (Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).The name of the campaign to create.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.postTriggerCollectionDuration
(Long postTriggerCollectionDuration) (Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection.(Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.signalCatalogArn
(String signalCatalogArn) (Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.signalsToCollect
(Collection<SignalInformation> signalsToCollect) (Optional) A list of information about signals to collect.signalsToCollect
(Consumer<SignalInformation.Builder>... signalsToCollect) (Optional) A list of information about signals to collect.signalsToCollect
(SignalInformation... signalsToCollect) (Optional) A list of information about signals to collect.spoolingMode
(String spoolingMode) (Optional) Whether to store collected data after a vehicle lost a connection with the cloud.spoolingMode
(SpoolingMode spoolingMode) (Optional) Whether to store collected data after a vehicle lost a connection with the cloud.(Optional) The time, in milliseconds, to deliver a campaign after it was approved.tags
(Collection<Tag> tags) Metadata that can be used to manage the campaign.tags
(Consumer<Tag.Builder>... tags) Metadata that can be used to manage the campaign.Metadata that can be used to manage the campaign.The ARN of the vehicle or fleet to deploy a campaign to.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.iotfleetwise.model.IoTFleetWiseRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
(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
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
(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
(Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data isn't collected after the campaign expires.
Default: 253402214400 (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 isn't collected after the campaign expires.Default: 253402214400 (December 31, 9999, 00:00:00 UTC)
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
(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, useSEND_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
(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, useSEND_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:
-
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, useTO_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
(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, useTO_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:
-
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, useOFF
. 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
(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, useOFF
. 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:
-
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
(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
(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 theSignalInformation.Builder
avoiding the need to create one manually viaSignalInformation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosignalsToCollect(List<SignalInformation>)
.- Parameters:
signalsToCollect
- a consumer that will call methods onSignalInformation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theCollectionScheme.Builder
avoiding the need to create one manually viaCollectionScheme.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocollectionScheme(CollectionScheme)
.- Parameters:
collectionScheme
- a consumer that will call methods onCollectionScheme.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
dataExtraDimensions
(Optional) A list of vehicle attributes to associate with a campaign.
Enrich the data with specified vehicle attributes. For example, add
make
andmodel
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 againstmake
andmodel
.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
andmodel
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 againstmake
andmodel
.Default: An empty array
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataExtraDimensions
(Optional) A list of vehicle attributes to associate with a campaign.
Enrich the data with specified vehicle attributes. For example, add
make
andmodel
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 againstmake
andmodel
.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
andmodel
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 againstmake
andmodel
.Default: An empty array
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
Metadata that can be used to manage the campaign.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
dataDestinationConfigs
CreateCampaignRequest.Builder dataDestinationConfigs(Collection<DataDestinationConfig> dataDestinationConfigs) The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.
Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. Amazon Web Services IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple Amazon Web Services IoT FleetWise servers for redundancy and high availability.
You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
- Parameters:
dataDestinationConfigs
- The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. Amazon Web Services IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple Amazon Web Services IoT FleetWise servers for redundancy and high availability.
You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataDestinationConfigs
CreateCampaignRequest.Builder dataDestinationConfigs(DataDestinationConfig... dataDestinationConfigs) The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.
Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. Amazon Web Services IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple Amazon Web Services IoT FleetWise servers for redundancy and high availability.
You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
- Parameters:
dataDestinationConfigs
- The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. Amazon Web Services IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple Amazon Web Services IoT FleetWise servers for redundancy and high availability.
You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataDestinationConfigs
CreateCampaignRequest.Builder dataDestinationConfigs(Consumer<DataDestinationConfig.Builder>... dataDestinationConfigs) The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.
Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. Amazon Web Services IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple Amazon Web Services IoT FleetWise servers for redundancy and high availability.
You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
This is a convenience method that creates an instance of theDataDestinationConfig.Builder
avoiding the need to create one manually viaDataDestinationConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todataDestinationConfigs(List<DataDestinationConfig>)
.- Parameters:
dataDestinationConfigs
- a consumer that will call methods onDataDestinationConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateCampaignRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateCampaignRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-