Class VehicleStatus
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<VehicleStatus.Builder,
VehicleStatus>
Information about the state of a vehicle and how it relates to the status of a campaign.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic VehicleStatus.Builder
builder()
final String
The name of a campaign.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends VehicleStatus.Builder> final VehicleState
status()
The state of a vehicle, which can be one of the following:final String
The state of a vehicle, which can be one of the following: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.final String
The unique ID of the vehicle.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
campaignName
The name of a campaign.
- Returns:
- The name of a campaign.
-
vehicleName
The unique ID of the vehicle.
- Returns:
- The unique ID of the vehicle.
-
status
The state of a vehicle, which can be one of the following:
-
CREATED
- Amazon Web Services IoT FleetWise sucessfully created the vehicle. -
READY
- The vehicle is ready to receive a campaign deployment. -
HEALTHY
- A campaign deployment was delivered to the vehicle. -
SUSPENDED
- A campaign associated with the vehicle was suspended and data collection was paused. -
DELETING
- Amazon Web Services IoT FleetWise is removing a campaign from the vehicle.
If the service returns an enum value that is not available in the current SDK version,
status
will returnVehicleState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The state of a vehicle, which can be one of the following:
-
CREATED
- Amazon Web Services IoT FleetWise sucessfully created the vehicle. -
READY
- The vehicle is ready to receive a campaign deployment. -
HEALTHY
- A campaign deployment was delivered to the vehicle. -
SUSPENDED
- A campaign associated with the vehicle was suspended and data collection was paused. -
DELETING
- Amazon Web Services IoT FleetWise is removing a campaign from the vehicle.
-
- See Also:
-
-
statusAsString
The state of a vehicle, which can be one of the following:
-
CREATED
- Amazon Web Services IoT FleetWise sucessfully created the vehicle. -
READY
- The vehicle is ready to receive a campaign deployment. -
HEALTHY
- A campaign deployment was delivered to the vehicle. -
SUSPENDED
- A campaign associated with the vehicle was suspended and data collection was paused. -
DELETING
- Amazon Web Services IoT FleetWise is removing a campaign from the vehicle.
If the service returns an enum value that is not available in the current SDK version,
status
will returnVehicleState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The state of a vehicle, which can be one of the following:
-
CREATED
- Amazon Web Services IoT FleetWise sucessfully created the vehicle. -
READY
- The vehicle is ready to receive a campaign deployment. -
HEALTHY
- A campaign deployment was delivered to the vehicle. -
SUSPENDED
- A campaign associated with the vehicle was suspended and data collection was paused. -
DELETING
- Amazon Web Services IoT FleetWise is removing a campaign from the vehicle.
-
- See Also:
-
-
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<VehicleStatus.Builder,
VehicleStatus> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-