Class UpdateVehicleRequestItem

java.lang.Object
software.amazon.awssdk.services.iotfleetwise.model.UpdateVehicleRequestItem
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<UpdateVehicleRequestItem.Builder,UpdateVehicleRequestItem>
@Generated("software.amazon.awssdk:codegen") public final class UpdateVehicleRequestItem extends Object implements SdkPojo, Serializable, ToCopyableBuilder<UpdateVehicleRequestItem.Builder,UpdateVehicleRequestItem>

Information about the vehicle to update.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

See Also:

  • Method Details

    • vehicleName

      public final String vehicleName()

      The unique ID of the vehicle to update.

      Returns:
      The unique ID of the vehicle to update.

    • modelManifestArn

      public final String modelManifestArn()

      The ARN of the vehicle model (model manifest) associated with the vehicle to update.

      Returns:
      The ARN of the vehicle model (model manifest) associated with the vehicle to update.

    • decoderManifestArn

      public final String decoderManifestArn()

      The ARN of the signal decoder manifest associated with the vehicle to update.

      Returns:
      The ARN of the signal decoder manifest associated with the vehicle to update.

    • hasAttributes

      public final boolean hasAttributes()
      For responses, this returns true if the service returned a value for the Attributes 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.

    • attributes

      public final Map<String,String> attributes()

      Static information about a vehicle in a key-value pair. For example:

      "engineType" : "1.3 L R2"

      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 hasAttributes() method.

      Returns:
      Static information about a vehicle in a key-value pair. For example:

      "engineType" : "1.3 L R2"

    • attributeUpdateMode

      public final UpdateMode attributeUpdateMode()

      The method the specified attributes will update the existing attributes on the vehicle. UseOverwite to replace the vehicle attributes with the specified attributes. Or use Merge to combine all attributes.

      This is required if attributes are present in the input.

      If the service returns an enum value that is not available in the current SDK version, attributeUpdateMode will return UpdateMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attributeUpdateModeAsString().

      Returns:
      The method the specified attributes will update the existing attributes on the vehicle. Use Overwite to replace the vehicle attributes with the specified attributes. Or use Merge to combine all attributes.

      This is required if attributes are present in the input.

      See Also:

    • attributeUpdateModeAsString

      public final String attributeUpdateModeAsString()

      The method the specified attributes will update the existing attributes on the vehicle. UseOverwite to replace the vehicle attributes with the specified attributes. Or use Merge to combine all attributes.

      This is required if attributes are present in the input.

      If the service returns an enum value that is not available in the current SDK version, attributeUpdateMode will return UpdateMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attributeUpdateModeAsString().

      Returns:
      The method the specified attributes will update the existing attributes on the vehicle. Use Overwite to replace the vehicle attributes with the specified attributes. Or use Merge to combine all attributes.

      This is required if attributes are present in the input.

      See Also:

    • hasStateTemplatesToAdd

      public final boolean hasStateTemplatesToAdd()
      For responses, this returns true if the service returned a value for the StateTemplatesToAdd 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.

    • stateTemplatesToAdd

      public final List<StateTemplateAssociation> stateTemplatesToAdd()

      Associate additional state templates to track the state of the vehicle. State templates determine which signal updates the vehicle sends to the cloud.

      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 hasStateTemplatesToAdd() method.

      Returns:
      Associate additional state templates to track the state of the vehicle. State templates determine which signal updates the vehicle sends to the cloud.

    • hasStateTemplatesToRemove

      public final boolean hasStateTemplatesToRemove()
      For responses, this returns true if the service returned a value for the StateTemplatesToRemove 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.

    • stateTemplatesToRemove

      public final List<String> stateTemplatesToRemove()

      Remove existing state template associations 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 hasStateTemplatesToRemove() method.

      Returns:
      Remove existing state template associations from the vehicle.

    • hasStateTemplatesToUpdate

      public final boolean hasStateTemplatesToUpdate()
      For responses, this returns true if the service returned a value for the StateTemplatesToUpdate 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.

    • stateTemplatesToUpdate

      public final List<StateTemplateAssociation> stateTemplatesToUpdate()

      Change the stateTemplateUpdateStrategy of state templates already associated with 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 hasStateTemplatesToUpdate() method.

      Returns:
      Change the stateTemplateUpdateStrategy of state templates already associated with the vehicle.

    • toBuilder

      public UpdateVehicleRequestItem.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<UpdateVehicleRequestItem.Builder,UpdateVehicleRequestItem>
      Returns:
      a builder for type T

    • builder

      public static UpdateVehicleRequestItem.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateVehicleRequestItem.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)
      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)

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