Package software.amazon.awssdk.services.iotfleetwise.model

Interface CreateCampaignRequest.Builder

    • Method Detail

      • name

        CreateCampaignRequest.Builder name​(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.

      • description

        CreateCampaignRequest.Builder description​(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.

      • signalCatalogArn

        CreateCampaignRequest.Builder signalCatalogArn​(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.

      • targetArn

        CreateCampaignRequest.Builder targetArn​(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.

      • startTime

        CreateCampaignRequest.Builder startTime​(Instant startTime)

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

        Default: 0

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

        Default: 0

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • expiryTime

        CreateCampaignRequest.Builder expiryTime​(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)

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • postTriggerCollectionDuration

        CreateCampaignRequest.Builder postTriggerCollectionDuration​(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

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • diagnosticsMode

        CreateCampaignRequest.Builder diagnosticsMode​(String 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

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DiagnosticsMode, DiagnosticsMode

      • diagnosticsMode

        CreateCampaignRequest.Builder diagnosticsMode​(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

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DiagnosticsMode, DiagnosticsMode

      • spoolingMode

        CreateCampaignRequest.Builder spoolingMode​(String 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

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SpoolingMode, SpoolingMode

      • spoolingMode

        CreateCampaignRequest.Builder spoolingMode​(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

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SpoolingMode, SpoolingMode

      • compression

        CreateCampaignRequest.Builder compression​(String 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

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Compression, Compression

      • compression

        CreateCampaignRequest.Builder compression​(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

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Compression, Compression

      • priority

        @Deprecated
CreateCampaignRequest.Builder priority​(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

        Parameters:
        priority - A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified, 0 is used.

        Default: 0

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • signalsToCollect

        CreateCampaignRequest.Builder signalsToCollect​(Collection<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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • signalsToCollect

        CreateCampaignRequest.Builder signalsToCollect​(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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • signalsToCollect

        CreateCampaignRequest.Builder signalsToCollect​(Consumer<SignalInformation.Builder>... 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.

        This is a convenience method that creates an instance of the SignalInformation.Builder avoiding the need to create one manually via SignalInformation.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #signalsToCollect(List).

        Parameters:
        signalsToCollect - a consumer that will call methods on SignalInformation.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #signalsToCollect(java.util.Collection)

      • collectionScheme

        CreateCampaignRequest.Builder collectionScheme​(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.

      • dataExtraDimensions

        CreateCampaignRequest.Builder dataExtraDimensions​(Collection<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

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataExtraDimensions

        CreateCampaignRequest.Builder dataExtraDimensions​(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

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateCampaignRequest.Builder tags​(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.

      • tags

        CreateCampaignRequest.Builder tags​(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.

      • tags

        CreateCampaignRequest.Builder tags​(Consumer<Tag.Builder>... tags)

        Metadata that can be used to manage the campaign.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • dataDestinationConfigs

        CreateCampaignRequest.Builder dataDestinationConfigs​(Collection<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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataDestinationConfigs

        CreateCampaignRequest.Builder dataDestinationConfigs​(DataDestinationConfig... dataDestinationConfigs)

        The destination where the campaign sends data. You can 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.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataDestinationConfigs

        CreateCampaignRequest.Builder dataDestinationConfigs​(Consumer<DataDestinationConfig.Builder>... dataDestinationConfigs)

        The destination where the campaign sends data. You can 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.

        This is a convenience method that creates an instance of the DataDestinationConfig.Builder avoiding the need to create one manually via DataDestinationConfig.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #dataDestinationConfigs(List).

        Parameters:
        dataDestinationConfigs - a consumer that will call methods on DataDestinationConfig.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #dataDestinationConfigs(java.util.Collection)

      • dataPartitions

        CreateCampaignRequest.Builder dataPartitions​(Collection<DataPartition> dataPartitions)

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

        Parameters:
        dataPartitions - The data partitions associated with the signals collected from the vehicle.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataPartitions

        CreateCampaignRequest.Builder dataPartitions​(DataPartition... dataPartitions)

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

        Parameters:
        dataPartitions - The data partitions associated with the signals collected from the vehicle.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • signalsToFetch

        CreateCampaignRequest.Builder signalsToFetch​(Collection<SignalFetchInformation> signalsToFetch)

        A list of information about signals to fetch.

        Parameters:
        signalsToFetch - A list of information about signals to fetch.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • signalsToFetch

        CreateCampaignRequest.Builder signalsToFetch​(SignalFetchInformation... signalsToFetch)

        A list of information about signals to fetch.

        Parameters:
        signalsToFetch - A list of information about signals to fetch.
        Returns:
        Returns a reference to this object so that method calls can be chained together.