Package software.amazon.awssdk.services.ssm.model

Class CancelCommandRequest

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

  • Method Details

    • commandId

      public final String commandId()

      The ID of the command you want to cancel.

      Returns:
      The ID of the command you want to cancel.

    • hasInstanceIds

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

    • instanceIds

      public final List<String> instanceIds()

      (Optional) A list of managed node IDs on which you want to cancel the command. If not provided, the command is canceled on every node on which it was requested.

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

      Returns:
      (Optional) A list of managed node IDs on which you want to cancel the command. If not provided, the command is canceled on every node on which it was requested.

    • toBuilder

      public CancelCommandRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CancelCommandRequest.Builder,CancelCommandRequest>
      Specified by:
      toBuilder in class SsmRequest

    • builder

      public static CancelCommandRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CancelCommandRequest.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)
      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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo