software.amazon.awssdk.services.iotfleetwise.model

Class CreateCampaignRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iotfleetwise.model.IoTFleetWiseRequest

software.amazon.awssdk.services.iotfleetwise.model.CreateCampaignRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateCampaignRequest.Builder,CreateCampaignRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateCampaignRequest
extends IoTFleetWiseRequest
implements ToCopyableBuilder<CreateCampaignRequest.Builder,CreateCampaignRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateCampaignRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateCampaignRequest.Builder	builder()
CollectionScheme	collectionScheme() The data collection scheme associated with the campaign.
Compression	compression() (Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise.
String	compressionAsString() (Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise.
List<String>	dataExtraDimensions() (Optional) A list of vehicle attributes to associate with a campaign.
String	description() An optional description of the campaign to help identify its purpose.
DiagnosticsMode	diagnosticsMode() (Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
String	diagnosticsModeAsString() (Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Instant	expiryTime() (Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDataExtraDimensions() For responses, this returns true if the service returned a value for the DataExtraDimensions property.
int	hashCode()
boolean	hasSignalsToCollect() For responses, this returns true if the service returned a value for the SignalsToCollect property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	name() The name of the campaign to create.
Long	postTriggerCollectionDuration() (Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection.
Integer	priority() (Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateCampaignRequest.Builder>	serializableBuilderClass()
String	signalCatalogArn() (Optional) The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
List<SignalInformation>	signalsToCollect() (Optional) A list of information about signals to collect.
SpoolingMode	spoolingMode() (Optional) Whether to store collected data after a vehicle lost a connection with the cloud.
String	spoolingModeAsString() (Optional) Whether to store collected data after a vehicle lost a connection with the cloud.
Instant	startTime() (Optional) The time, in milliseconds, to deliver a campaign after it was approved.
List<Tag>	tags() Metadata that can be used to manage the campaign.
String	targetArn() The ARN of the vehicle or fleet to deploy a campaign to.
CreateCampaignRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

name

public final String name()

The name of the campaign to create.

Returns:

The name of the campaign to create.

description

public final String 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

public final String 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

public final String 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

public final 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

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

public final 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)

Returns:

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

postTriggerCollectionDuration

public final 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

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

public final 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

If the service returns an enum value that is not available in the current SDK version, diagnosticsMode will return DiagnosticsMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from diagnosticsModeAsString().

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

diagnosticsModeAsString

public final String 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 return DiagnosticsMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from diagnosticsModeAsString().

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

spoolingMode

public final 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

If the service returns an enum value that is not available in the current SDK version, spoolingMode will return SpoolingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from spoolingModeAsString().

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

spoolingModeAsString

public final String 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 return SpoolingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from spoolingModeAsString().

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

compression

public final 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

If the service returns an enum value that is not available in the current SDK version, compression will return Compression.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from compressionAsString().

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

compressionAsString

public final String 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 return Compression.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from compressionAsString().

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

priority

public final 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

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

public final List<SignalInformation> 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

public final CollectionScheme 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 the isEmpty() 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

public final List<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

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

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

public final List<Tag> 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.

toBuilder

public CreateCampaignRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateCampaignRequest.Builder,CreateCampaignRequest>

Specified by:

toBuilder in class IoTFleetWiseRequest

builder

public static CreateCampaignRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateCampaignRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo