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("software.amazon.awssdk:codegen") public final class CreateCampaignRequest extends IoTFleetWiseRequest implements ToCopyableBuilder<CreateCampaignRequest.Builder,CreateCampaignRequest>

  • Method Details

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

      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.

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

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

      Default: 0

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

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

      public final Long postTriggerCollectionDuration()

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

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

      public final String diagnosticsModeAsString()

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

      public final SpoolingMode spoolingMode()

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

      public final String spoolingModeAsString()

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

      public final Compression compression()

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

      public final String compressionAsString()

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

      @Deprecated public final Integer priority()
      Deprecated.
      priority is no longer used or needed as input

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

      A list of information about signals to collect.

      If you upload a signal as a condition in a data partition for a campaign, then those same signals must be included in signalsToCollect.

      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:
      A list of information about signals to collect.

      If you upload a signal as a condition in a data partition for a campaign, then those same signals must be included in signalsToCollect.

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

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

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

    • dataDestinationConfigs

      public final List<DataDestinationConfig> dataDestinationConfigs()

      The destination where the campaign sends data. You can send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream.

      MQTT is the publish/subscribe messaging protocol used by Amazon Web Services IoT to communicate with your devices.

      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 send data to an MQTT topic, or store it in Amazon S3 or Amazon Timestream.

      MQTT is the publish/subscribe messaging protocol used by Amazon Web Services IoT to communicate with your devices.

      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.

    • hasDataPartitions

      public final boolean hasDataPartitions()
      For responses, this returns true if the service returned a value for the DataPartitions 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.

    • dataPartitions

      public final List<DataPartition> dataPartitions()

      The data partitions associated with the signals collected from the vehicle.

      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 hasDataPartitions() method.

      Returns:
      The data partitions associated with the signals collected from the vehicle.

    • hasSignalsToFetch

      public final boolean hasSignalsToFetch()
      For responses, this returns true if the service returned a value for the SignalsToFetch 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.

    • signalsToFetch

      public final List<SignalFetchInformation> signalsToFetch()

      A list of information about signals to fetch.

      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 hasSignalsToFetch() method.

      Returns:
      A list of information about signals to fetch.

    • toBuilder

      public CreateCampaignRequest.Builder 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 interface ToCopyableBuilder<CreateCampaignRequest.Builder,CreateCampaignRequest>
      Specified by:
      toBuilder in class IoTFleetWiseRequest
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.