GetCampaignResponse (AWS Java SDK :: Services :: Io T Fleet Wise 2.18.21 API)

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetCampaignResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetCampaignResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) of the campaign.
`static GetCampaignResponse.Builder`	`builder()`
`CollectionScheme`	`collectionScheme()` Information about the data collection scheme associated with the campaign.
`Compression`	`compression()` Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise.
`String`	`compressionAsString()` Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise.
`Instant`	`creationTime()` The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).
`List<String>`	`dataExtraDimensions()` A list of vehicle attributes associated with the campaign.
`String`	`description()` The description of the campaign.
`DiagnosticsMode`	`diagnosticsMode()` Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
`String`	`diagnosticsModeAsString()` 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()` 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.
`Instant`	`lastModificationTime()` The last time the campaign was modified.
`String`	`name()` The name of the campaign.
`Long`	`postTriggerCollectionDuration()` How long (in seconds) to collect raw data after a triggering event initiates the collection.
`Integer`	`priority()` A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetCampaignResponse.Builder>`	`serializableBuilderClass()`
`String`	`signalCatalogArn()` The ARN of a signal catalog.
`List<SignalInformation>`	`signalsToCollect()` Information about a list of signals to collect data on.
`SpoolingMode`	`spoolingMode()` Whether to store collected data after a vehicle lost a connection with the cloud.
`String`	`spoolingModeAsString()` Whether to store collected data after a vehicle lost a connection with the cloud.
`Instant`	`startTime()` The time, in milliseconds, to deliver a campaign after it was approved.
`CampaignStatus`	`status()` The state of the campaign.
`String`	`statusAsString()` The state of the campaign.
`String`	`targetArn()` The ARN of the vehicle or the fleet targeted by the campaign.
`GetCampaignResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.iotfleetwise.model.IoTFleetWiseResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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.
    
    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.
  - 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:
    
    DiagnosticsMode
  - 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.
  - toBuilder
```
public GetCampaignResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetCampaignResponse.Builder,GetCampaignResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - 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)
```
    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 SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GetCampaignResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.iotfleetwise.model.IoTFleetWiseResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

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

Method Detail

name

arn

description

signalCatalogArn

targetArn

status

statusAsString

startTime

expiryTime

postTriggerCollectionDuration

diagnosticsMode

diagnosticsModeAsString

spoolingMode

spoolingModeAsString

compression

compressionAsString

priority

hasSignalsToCollect

signalsToCollect

collectionScheme

hasDataExtraDimensions

dataExtraDimensions

creationTime

lastModificationTime

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields