com.amazonaws.services.iotfleetwise.model

Class CreateCampaignRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iotfleetwise.model.CreateCampaignRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateCampaignRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateCampaignRequest()

Method Summary

Modifier and Type	Method and Description
CreateCampaignRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
CollectionScheme	getCollectionScheme() The data collection scheme associated with the campaign.
String	getCompression() (Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise.
List<DataDestinationConfig>	getDataDestinationConfigs() The destination where the campaign sends data.
List<String>	getDataExtraDimensions() (Optional) A list of vehicle attributes to associate with a campaign.
String	getDescription() An optional description of the campaign to help identify its purpose.
String	getDiagnosticsMode() (Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
Date	getExpiryTime() (Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).
String	getName() The name of the campaign to create.
Long	getPostTriggerCollectionDuration() (Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection.
Integer	getPriority() (Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.
String	getSignalCatalogArn() The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
List<SignalInformation>	getSignalsToCollect() (Optional) A list of information about signals to collect.
String	getSpoolingMode() (Optional) Whether to store collected data after a vehicle lost a connection with the cloud.
Date	getStartTime() (Optional) The time, in milliseconds, to deliver a campaign after it was approved.
List<Tag>	getTags() Metadata that can be used to manage the campaign.
String	getTargetArn() The ARN of the vehicle or fleet to deploy a campaign to.
int	hashCode()
void	setCollectionScheme(CollectionScheme collectionScheme) The data collection scheme associated with the campaign.
void	setCompression(String compression) (Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise.
void	setDataDestinationConfigs(Collection<DataDestinationConfig> dataDestinationConfigs) The destination where the campaign sends data.
void	setDataExtraDimensions(Collection<String> dataExtraDimensions) (Optional) A list of vehicle attributes to associate with a campaign.
void	setDescription(String description) An optional description of the campaign to help identify its purpose.
void	setDiagnosticsMode(String diagnosticsMode) (Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
void	setExpiryTime(Date expiryTime) (Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).
void	setName(String name) The name of the campaign to create.
void	setPostTriggerCollectionDuration(Long postTriggerCollectionDuration) (Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection.
void	setPriority(Integer priority) (Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.
void	setSignalCatalogArn(String signalCatalogArn) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
void	setSignalsToCollect(Collection<SignalInformation> signalsToCollect) (Optional) A list of information about signals to collect.
void	setSpoolingMode(String spoolingMode) (Optional) Whether to store collected data after a vehicle lost a connection with the cloud.
void	setStartTime(Date startTime) (Optional) The time, in milliseconds, to deliver a campaign after it was approved.
void	setTags(Collection<Tag> tags) Metadata that can be used to manage the campaign.
void	setTargetArn(String targetArn) The ARN of the vehicle or fleet to deploy a campaign to.
String	toString() Returns a string representation of this object.
CreateCampaignRequest	withCollectionScheme(CollectionScheme collectionScheme) The data collection scheme associated with the campaign.
CreateCampaignRequest	withCompression(Compression compression) (Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise.
CreateCampaignRequest	withCompression(String compression) (Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise.
CreateCampaignRequest	withDataDestinationConfigs(Collection<DataDestinationConfig> dataDestinationConfigs) The destination where the campaign sends data.
CreateCampaignRequest	withDataDestinationConfigs(DataDestinationConfig... dataDestinationConfigs) The destination where the campaign sends data.
CreateCampaignRequest	withDataExtraDimensions(Collection<String> dataExtraDimensions) (Optional) A list of vehicle attributes to associate with a campaign.
CreateCampaignRequest	withDataExtraDimensions(String... dataExtraDimensions) (Optional) A list of vehicle attributes to associate with a campaign.
CreateCampaignRequest	withDescription(String description) An optional description of the campaign to help identify its purpose.
CreateCampaignRequest	withDiagnosticsMode(DiagnosticsMode diagnosticsMode) (Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
CreateCampaignRequest	withDiagnosticsMode(String diagnosticsMode) (Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
CreateCampaignRequest	withExpiryTime(Date expiryTime) (Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).
CreateCampaignRequest	withName(String name) The name of the campaign to create.
CreateCampaignRequest	withPostTriggerCollectionDuration(Long postTriggerCollectionDuration) (Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection.
CreateCampaignRequest	withPriority(Integer priority) (Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.
CreateCampaignRequest	withSignalCatalogArn(String signalCatalogArn) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
CreateCampaignRequest	withSignalsToCollect(Collection<SignalInformation> signalsToCollect) (Optional) A list of information about signals to collect.
CreateCampaignRequest	withSignalsToCollect(SignalInformation... signalsToCollect) (Optional) A list of information about signals to collect.
CreateCampaignRequest	withSpoolingMode(SpoolingMode spoolingMode) (Optional) Whether to store collected data after a vehicle lost a connection with the cloud.
CreateCampaignRequest	withSpoolingMode(String spoolingMode) (Optional) Whether to store collected data after a vehicle lost a connection with the cloud.
CreateCampaignRequest	withStartTime(Date startTime) (Optional) The time, in milliseconds, to deliver a campaign after it was approved.
CreateCampaignRequest	withTags(Collection<Tag> tags) Metadata that can be used to manage the campaign.
CreateCampaignRequest	withTags(Tag... tags) Metadata that can be used to manage the campaign.
CreateCampaignRequest	withTargetArn(String targetArn) The ARN of the vehicle or fleet to deploy a campaign to.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateCampaignRequest

public CreateCampaignRequest()

Method Detail

setName

public void setName(String name)

The name of the campaign to create.

Parameters:

name - The name of the campaign to create.

getName

public String getName()

The name of the campaign to create.

Returns:

The name of the campaign to create.

withName

public CreateCampaignRequest withName(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.

setDescription

public void setDescription(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.

getDescription

public String getDescription()

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

Returns:

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

withDescription

public CreateCampaignRequest withDescription(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.

setSignalCatalogArn

public void setSignalCatalogArn(String signalCatalogArn)

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

Parameters:

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

getSignalCatalogArn

public String getSignalCatalogArn()

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

Returns:

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

withSignalCatalogArn

public CreateCampaignRequest withSignalCatalogArn(String signalCatalogArn)

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

Parameters:

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

setTargetArn

public void setTargetArn(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.

getTargetArn

public String getTargetArn()

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

Returns:

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

withTargetArn

public CreateCampaignRequest withTargetArn(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.

setStartTime

public void setStartTime(Date 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

getStartTime

public Date getStartTime()

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

Default: 0

Returns:

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

Default: 0

withStartTime

public CreateCampaignRequest withStartTime(Date 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.

setExpiryTime

public void setExpiryTime(Date 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)

getExpiryTime

public Date getExpiryTime()

(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:

(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)

withExpiryTime

public CreateCampaignRequest withExpiryTime(Date 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.

setPostTriggerCollectionDuration

public void setPostTriggerCollectionDuration(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

getPostTriggerCollectionDuration

public Long getPostTriggerCollectionDuration()

(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:

(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

withPostTriggerCollectionDuration

public CreateCampaignRequest withPostTriggerCollectionDuration(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.

setDiagnosticsMode

public void setDiagnosticsMode(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

See Also:

DiagnosticsMode

getDiagnosticsMode

public String getDiagnosticsMode()

(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:

(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

See Also:

DiagnosticsMode

withDiagnosticsMode

public CreateCampaignRequest withDiagnosticsMode(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

withDiagnosticsMode

public CreateCampaignRequest withDiagnosticsMode(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

setSpoolingMode

public void setSpoolingMode(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

See Also:

SpoolingMode

getSpoolingMode

public String getSpoolingMode()

(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:

(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

See Also:

SpoolingMode

withSpoolingMode

public CreateCampaignRequest withSpoolingMode(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

withSpoolingMode

public CreateCampaignRequest withSpoolingMode(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

setCompression

public void setCompression(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

See Also:

Compression

getCompression

public String getCompression()

(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:

(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

See Also:

Compression

withCompression

public CreateCampaignRequest withCompression(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

withCompression

public CreateCampaignRequest withCompression(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

setPriority

public void setPriority(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

getPriority

public Integer getPriority()

(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:

(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

withPriority

public CreateCampaignRequest withPriority(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.

getSignalsToCollect

public List<SignalInformation> getSignalsToCollect()

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

Returns:

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

setSignalsToCollect

public void setSignalsToCollect(Collection<SignalInformation> signalsToCollect)

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

Parameters:

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

withSignalsToCollect

public CreateCampaignRequest withSignalsToCollect(SignalInformation... signalsToCollect)

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

NOTE: This method appends the values to the existing list (if any). Use setSignalsToCollect(java.util.Collection) or withSignalsToCollect(java.util.Collection) if you want to override the existing values.

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.

withSignalsToCollect

public CreateCampaignRequest withSignalsToCollect(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.

setCollectionScheme

public void setCollectionScheme(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.

getCollectionScheme

public CollectionScheme getCollectionScheme()

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

Returns:

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

withCollectionScheme

public CreateCampaignRequest withCollectionScheme(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.

getDataExtraDimensions

public List<String> getDataExtraDimensions()

(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:

(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

setDataExtraDimensions

public void setDataExtraDimensions(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

withDataExtraDimensions

public CreateCampaignRequest withDataExtraDimensions(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

NOTE: This method appends the values to the existing list (if any). Use setDataExtraDimensions(java.util.Collection) or withDataExtraDimensions(java.util.Collection) if you want to override the existing values.

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.

withDataExtraDimensions

public CreateCampaignRequest withDataExtraDimensions(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.

getTags

public List<Tag> getTags()

Metadata that can be used to manage the campaign.

Returns:

Metadata that can be used to manage the campaign.

setTags

public void setTags(Collection<Tag> tags)

Metadata that can be used to manage the campaign.

Parameters:

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

withTags

public CreateCampaignRequest withTags(Tag... tags)

Metadata that can be used to manage the campaign.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

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.

withTags

public CreateCampaignRequest withTags(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.

getDataDestinationConfigs

public List<DataDestinationConfig> getDataDestinationConfigs()

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:

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.

setDataDestinationConfigs

public void setDataDestinationConfigs(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.

withDataDestinationConfigs

public CreateCampaignRequest withDataDestinationConfigs(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.

NOTE: This method appends the values to the existing list (if any). Use setDataDestinationConfigs(java.util.Collection) or withDataDestinationConfigs(java.util.Collection) if you want to override the existing values.

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.

withDataDestinationConfigs

public CreateCampaignRequest withDataDestinationConfigs(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.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateCampaignRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()