Class UpdateDecoderManifestRequest

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.UpdateDecoderManifestRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateDecoderManifestRequest.Builder,UpdateDecoderManifestRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateDecoderManifestRequest extends IoTFleetWiseRequest implements ToCopyableBuilder<UpdateDecoderManifestRequest.Builder,UpdateDecoderManifestRequest>

  • Method Details

    • name

      public final String name()

      The name of the decoder manifest to update.

      Returns:
      The name of the decoder manifest to update.

    • description

      public final String description()

      A brief description of the decoder manifest to update.

      Returns:
      A brief description of the decoder manifest to update.

    • hasSignalDecodersToAdd

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

    • signalDecodersToAdd

      public final List<SignalDecoder> signalDecodersToAdd()

      A list of information about decoding additional signals to add to the decoder manifest.

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

      Returns:
      A list of information about decoding additional signals to add to the decoder manifest.

    • hasSignalDecodersToUpdate

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

    • signalDecodersToUpdate

      public final List<SignalDecoder> signalDecodersToUpdate()

      A list of updated information about decoding signals to update in the decoder manifest.

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

      Returns:
      A list of updated information about decoding signals to update in the decoder manifest.

    • hasSignalDecodersToRemove

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

    • signalDecodersToRemove

      public final List<String> signalDecodersToRemove()

      A list of signal decoders to remove from the decoder manifest.

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

      Returns:
      A list of signal decoders to remove from the decoder manifest.

    • hasNetworkInterfacesToAdd

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

    • networkInterfacesToAdd

      public final List<NetworkInterface> networkInterfacesToAdd()

      A list of information about the network interfaces to add to the decoder manifest.

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

      Returns:
      A list of information about the network interfaces to add to the decoder manifest.

    • hasNetworkInterfacesToUpdate

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

    • networkInterfacesToUpdate

      public final List<NetworkInterface> networkInterfacesToUpdate()

      A list of information about the network interfaces to update in the decoder manifest.

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

      Returns:
      A list of information about the network interfaces to update in the decoder manifest.

    • hasNetworkInterfacesToRemove

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

    • networkInterfacesToRemove

      public final List<String> networkInterfacesToRemove()

      A list of network interfaces to remove from the decoder manifest.

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

      Returns:
      A list of network interfaces to remove from the decoder manifest.

    • status

      public final ManifestStatus status()

      The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is DRAFT, you can edit the decoder manifest.

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

      Returns:
      The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is DRAFT, you can edit the decoder manifest.
      See Also:

    • statusAsString

      public final String statusAsString()

      The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is DRAFT, you can edit the decoder manifest.

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

      Returns:
      The state of the decoder manifest. If the status is ACTIVE, the decoder manifest can't be edited. If the status is DRAFT, you can edit the decoder manifest.
      See Also:

    • defaultForUnmappedSignals

      public final DefaultForUnmappedSignalsType defaultForUnmappedSignals()

      Use default decoders for all unmapped signals in the model. You don't need to provide any detailed decoding information.

      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.

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

      Returns:
      Use default decoders for all unmapped signals in the model. You don't need to provide any detailed decoding information.

      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:

    • defaultForUnmappedSignalsAsString

      public final String defaultForUnmappedSignalsAsString()

      Use default decoders for all unmapped signals in the model. You don't need to provide any detailed decoding information.

      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.

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

      Returns:
      Use default decoders for all unmapped signals in the model. You don't need to provide any detailed decoding information.

      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:

    • toBuilder

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

    • builder

      public static UpdateDecoderManifestRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.