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

Class GetCampaignResponse

    • Method Detail

      • name

        public final String name()

        The name of the campaign.

        Returns:
        The name of the campaign.

      • arn

        public final String arn()

        The Amazon Resource Name (ARN) of the campaign.

        Returns:
        The Amazon Resource Name (ARN) of the campaign.

      • description

        public final String description()

        The description of the campaign.

        Returns:
        The description of the campaign.

      • signalCatalogArn

        public final String signalCatalogArn()

        The ARN of a signal catalog.

        Returns:
        The ARN of a signal catalog.

      • targetArn

        public final String targetArn()

        The ARN of the vehicle or the fleet targeted by the campaign.

        Returns:
        The ARN of the vehicle or the fleet targeted by the campaign.

      • status

        public final CampaignStatus status()

        The state of the campaign. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED.

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

        Returns:
        The state of the campaign. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED.
        See Also:
        CampaignStatus

      • statusAsString

        public final String statusAsString()

        The state of the campaign. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED.

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

        Returns:
        The state of the campaign. The status can be one of: CREATING, WAITING_FOR_APPROVAL, RUNNING, and SUSPENDED.
        See Also:
        CampaignStatus

      • startTime

        public final Instant startTime()

        The time, in milliseconds, to deliver a campaign after it was approved.

        Returns:
        The time, in milliseconds, to deliver a campaign after it was approved.

      • expiryTime

        public final Instant expiryTime()

        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.

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

      • postTriggerCollectionDuration

        public final Long postTriggerCollectionDuration()

        How long (in seconds) to collect raw data after a triggering event initiates the collection.

        Returns:
        How long (in seconds) to collect raw data after a triggering event initiates the collection.

      • diagnosticsModeAsString

        public final String diagnosticsModeAsString()

        Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.

        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.
        See Also:
        DiagnosticsMode

      • spoolingMode

        public final SpoolingMode spoolingMode()

        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 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:
        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.
        See Also:
        SpoolingMode

      • spoolingModeAsString

        public final String spoolingModeAsString()

        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 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:
        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.
        See Also:
        SpoolingMode

      • compression

        public final Compression compression()

        Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If OFF is specified, the signals aren't compressed. If it's not specified, SNAPPY is used.

        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:
        Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If OFF is specified, the signals aren't compressed. If it's not specified, SNAPPY is used.
        See Also:
        Compression

      • compressionAsString

        public final String compressionAsString()

        Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If OFF is specified, the signals aren't compressed. If it's not specified, SNAPPY is used.

        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:
        Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If OFF is specified, the signals aren't compressed. If it's not specified, SNAPPY is used.
        See Also:
        Compression

      • priority

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

        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.

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

        Information about a list of signals to collect data on.

        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:
        Information about a list of signals to collect data on.

      • collectionScheme

        public final CollectionScheme collectionScheme()

        Information about the data collection scheme associated with the campaign.

        Returns:
        Information about the data collection scheme associated with the campaign.

      • 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 associated with 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 hasDataExtraDimensions() method.

        Returns:
        A list of vehicle attributes associated with the campaign.

      • creationTime

        public final Instant creationTime()

        The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).

        Returns:
        The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).

      • lastModificationTime

        public final Instant lastModificationTime()

        The last time the campaign was modified.

        Returns:
        The last time the campaign was modified.

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

        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.

        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.

      • 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