Class GetCampaignResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetCampaignResponse.Builder,
GetCampaignResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the campaign.static GetCampaignResponse.Builder
builder()
final CollectionScheme
Information about the data collection scheme associated with the campaign.final Compression
Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise.final String
Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise.final Instant
The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).final List
<DataDestinationConfig> The destination where the campaign sends data.A list of vehicle attributes associated with the campaign.final String
The description of the campaign.final DiagnosticsMode
Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.final String
Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Instant
The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the DataDestinationConfigs property.final boolean
For responses, this returns true if the service returned a value for the DataExtraDimensions property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SignalsToCollect property.final Instant
The last time the campaign was modified.final String
name()
The name of the campaign.final Long
How long (in seconds) to collect raw data after a triggering event initiates the collection.final Integer
priority()
A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.static Class
<? extends GetCampaignResponse.Builder> final String
The ARN of a signal catalog.final List
<SignalInformation> Information about a list of signals to collect data on.final SpoolingMode
Whether to store collected data after a vehicle lost a connection with the cloud.final String
Whether to store collected data after a vehicle lost a connection with the cloud.final Instant
The time, in milliseconds, to deliver a campaign after it was approved.final CampaignStatus
status()
The state of the campaign.final String
The state of the campaign.final String
The ARN of the vehicle or the fleet targeted by the campaign.Take this object and create a builder that contains all of the current property values of this object.final 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the campaign.
- Returns:
- The name of the campaign.
-
arn
The Amazon Resource Name (ARN) of the campaign.
- Returns:
- The Amazon Resource Name (ARN) of the campaign.
-
description
The description of the campaign.
- Returns:
- The description of the campaign.
-
signalCatalogArn
The ARN of a signal catalog.
- Returns:
- The ARN of a signal catalog.
-
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
The state of the campaign. The status can be one of:
CREATING
,WAITING_FOR_APPROVAL
,RUNNING
, andSUSPENDED
.If the service returns an enum value that is not available in the current SDK version,
status
will returnCampaignStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The state of the campaign. The status can be one of:
CREATING
,WAITING_FOR_APPROVAL
,RUNNING
, andSUSPENDED
. - See Also:
-
statusAsString
The state of the campaign. The status can be one of:
CREATING
,WAITING_FOR_APPROVAL
,RUNNING
, andSUSPENDED
.If the service returns an enum value that is not available in the current SDK version,
status
will returnCampaignStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The state of the campaign. The status can be one of:
CREATING
,WAITING_FOR_APPROVAL
,RUNNING
, andSUSPENDED
. - See Also:
-
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
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
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
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 returnDiagnosticsMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdiagnosticsModeAsString()
.- Returns:
- Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
- See Also:
-
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 returnDiagnosticsMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdiagnosticsModeAsString()
.- Returns:
- Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise.
- See Also:
-
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 returnSpoolingMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromspoolingModeAsString()
.- 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
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 returnSpoolingMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromspoolingModeAsString()
.- 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
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 returnCompression.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcompressionAsString()
.- 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
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 returnCompression.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcompressionAsString()
.- 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
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 theisEmpty()
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
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
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 theisEmpty()
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
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
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
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 theisEmpty()
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
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.
-
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 interfaceToCopyableBuilder<GetCampaignResponse.Builder,
GetCampaignResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-