Class GetCampaignResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.iotfleetwise.model.IoTFleetWiseResponse
software.amazon.awssdk.services.iotfleetwise.model.GetCampaignResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetCampaignResponse.Builder,GetCampaignResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetCampaignResponse extends IoTFleetWiseResponse implements ToCopyableBuilder<GetCampaignResponse.Builder,GetCampaignResponse>

  • Method Details

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

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

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

    • diagnosticsMode

      public final DiagnosticsMode diagnosticsMode()

      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:

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

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

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

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

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

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

      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.

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

      Information about a list of signals to fetch data from.

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

    • toBuilder

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

    • builder

      public static GetCampaignResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

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