software.amazon.awssdk.services.iotfleetwise.model

Class VehicleStatus

java.lang.Object

software.amazon.awssdk.services.iotfleetwise.model.VehicleStatus

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<VehicleStatus.Builder,VehicleStatus>

@Generated(value="software.amazon.awssdk:codegen")
public final class VehicleStatus
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<VehicleStatus.Builder,VehicleStatus>

Information about the state of a vehicle and how it relates to the status of a campaign.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VehicleStatus.Builder

Method Summary

Modifier and Type	Method and Description
static VehicleStatus.Builder	builder()
String	campaignName() The name of a campaign.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends VehicleStatus.Builder>	serializableBuilderClass()
VehicleState	status() The state of a vehicle, which can be one of the following:
String	statusAsString() The state of a vehicle, which can be one of the following:
VehicleStatus.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	vehicleName() The unique ID of the vehicle.

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

campaignName

public final String campaignName()

The name of a campaign.

Returns:

The name of a campaign.

vehicleName

public final String vehicleName()

The unique ID of the vehicle.

Returns:

The unique ID of the vehicle.

status

public final VehicleState 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 return VehicleState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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:

VehicleState

statusAsString

public final String 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 return VehicleState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

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:

VehicleState

toBuilder

public VehicleStatus.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VehicleStatus.Builder,VehicleStatus>

builder

public static VehicleStatus.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo