Class CreateVehicleRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.iotfleetwise.model.IoTFleetWiseRequest
software.amazon.awssdk.services.iotfleetwise.model.CreateVehicleRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateVehicleRequest.Builder,CreateVehicleRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateVehicleRequest extends IoTFleetWiseRequest implements ToCopyableBuilder<CreateVehicleRequest.Builder,CreateVehicleRequest>

  • Method Details

    • vehicleName

      public final String vehicleName()

      The unique ID of the vehicle to create.

      Returns:
      The unique ID of the vehicle to create.

    • modelManifestArn

      public final String modelManifestArn()

      The Amazon Resource Name ARN of a vehicle model.

      Returns:
      The Amazon Resource Name ARN of a vehicle model.

    • decoderManifestArn

      public final String decoderManifestArn()

      The ARN of a decoder manifest.

      Returns:
      The ARN of a decoder manifest.

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

      A campaign must include the keys (attribute names) in dataExtraDimensions for them to display in Amazon Timestream.

      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"

      A campaign must include the keys (attribute names) in dataExtraDimensions for them to display in Amazon Timestream.

    • associationBehavior

      public final VehicleAssociationBehavior associationBehavior()

      An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing Amazon Web Services IoT thing as a vehicle.

      Default:

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

      Returns:
      An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing Amazon Web Services IoT thing as a vehicle.

      Default:

      See Also:

    • associationBehaviorAsString

      public final String associationBehaviorAsString()

      An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing Amazon Web Services IoT thing as a vehicle.

      Default:

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

      Returns:
      An option to create a new Amazon Web Services IoT thing when creating a vehicle, or to validate an existing Amazon Web Services IoT thing as a vehicle.

      Default:

      See Also:

    • hasTags

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

    • tags

      public final List<Tag> tags()

      Metadata that can be used to manage 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 hasTags() method.

      Returns:
      Metadata that can be used to manage the vehicle.

    • toBuilder

      public CreateVehicleRequest.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<CreateVehicleRequest.Builder,CreateVehicleRequest>
      Specified by:
      toBuilder in class IoTFleetWiseRequest
      Returns:
      a builder for type T

    • builder

      public static CreateVehicleRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      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.