Class CreateCampaignRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateCampaignRequest.Builder,
CreateCampaignRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final CollectionScheme
The data collection scheme associated with the campaign.final Compression
(Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise.final String
(Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise.final List
<DataDestinationConfig> The destination where the campaign sends data.(Optional) A list of vehicle attributes to associate with a campaign.final String
An optional description of the campaign to help identify its purpose.final DiagnosticsMode
(Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.final String
(Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Instant
(Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the DataDestinationConfigs property.final boolean
For responses, this returns true if the service returned a value for the DataExtraDimensions property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SignalsToCollect property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
name()
The name of the campaign to create.final Long
(Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection.final Integer
priority()
(Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.static Class
<? extends CreateCampaignRequest.Builder> final String
(Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.final List
<SignalInformation> (Optional) A list of information about signals to collect.final SpoolingMode
(Optional) Whether to store collected data after a vehicle lost a connection with the cloud.final String
(Optional) Whether to store collected data after a vehicle lost a connection with the cloud.final Instant
(Optional) The time, in milliseconds, to deliver a campaign after it was approved.tags()
Metadata that can be used to manage the campaign.final String
The ARN of the vehicle or fleet to deploy a campaign to.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the campaign to create.
- Returns:
- The name of the campaign to create.
-
description
An optional description of the campaign to help identify its purpose.
- Returns:
- An optional description of the campaign to help identify its purpose.
-
signalCatalogArn
(Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
- Returns:
- (Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
-
targetArn
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.
-
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:
- (Optional) The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified,
0
is used.Default:
0
-
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:
- (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)
-
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:
- (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
-
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
If the service returns an enum value that is not available in the current SDK version,
diagnosticsMode
will returnDiagnosticsMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdiagnosticsModeAsString()
.- 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:
-
diagnosticsModeAsString
(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
If the service returns an enum value that is not available in the current SDK version,
diagnosticsMode
will returnDiagnosticsMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdiagnosticsModeAsString()
.- 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:
-
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
If the service returns an enum value that is not available in the current SDK version,
spoolingMode
will returnSpoolingMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromspoolingModeAsString()
.- 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:
-
spoolingModeAsString
(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
If the service returns an enum value that is not available in the current SDK version,
spoolingMode
will returnSpoolingMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromspoolingModeAsString()
.- 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:
-
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
If the service returns an enum value that is not available in the current SDK version,
compression
will returnCompression.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcompressionAsString()
.- 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:
-
compressionAsString
(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
If the service returns an enum value that is not available in the current SDK version,
compression
will returnCompression.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcompressionAsString()
.- 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:
-
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:
- (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
-
hasSignalsToCollect
public final boolean hasSignalsToCollect()For responses, this returns true if the service returned a value for the SignalsToCollect property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
signalsToCollect
(Optional) A list of information about signals to collect.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSignalsToCollect()
method.- Returns:
- (Optional) A list of information about signals to collect.
-
collectionScheme
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.
-
hasDataExtraDimensions
public final boolean hasDataExtraDimensions()For responses, this returns true if the service returned a value for the DataExtraDimensions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDataExtraDimensions()
method.- Returns:
- (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
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
Metadata that can be used to manage the campaign.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- Metadata that can be used to manage the campaign.
-
hasDataDestinationConfigs
public final boolean hasDataDestinationConfigs()For responses, this returns true if the service returned a value for the DataDestinationConfigs property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDataDestinationConfigs()
method.- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateCampaignRequest.Builder,
CreateCampaignRequest> - Specified by:
toBuilder
in classIoTFleetWiseRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-