Package software.amazon.awssdk.services.ec2.model

Class ResourceTypeOption

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

The options that affect the scope of the response.

See Also:

  • Method Details

    • optionName

      public final ImageReferenceOptionName optionName()

      The name of the option.

      • For ec2:Instance:

        Specify state-name - The current state of the EC2 instance.

      • For ec2:LaunchTemplate:

        Specify version-depth - The number of launch template versions to check, starting from the most recent version.

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

      Returns:
      The name of the option.

      • For ec2:Instance:

        Specify state-name - The current state of the EC2 instance.

      • For ec2:LaunchTemplate:

        Specify version-depth - The number of launch template versions to check, starting from the most recent version.

      See Also:

    • optionNameAsString

      public final String optionNameAsString()

      The name of the option.

      • For ec2:Instance:

        Specify state-name - The current state of the EC2 instance.

      • For ec2:LaunchTemplate:

        Specify version-depth - The number of launch template versions to check, starting from the most recent version.

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

      Returns:
      The name of the option.

      • For ec2:Instance:

        Specify state-name - The current state of the EC2 instance.

      • For ec2:LaunchTemplate:

        Specify version-depth - The number of launch template versions to check, starting from the most recent version.

      See Also:

    • hasOptionValues

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

    • optionValues

      public final List<String> optionValues()

      A value for the specified option.

      • For state-name:

        • Valid values: pending | running | shutting-down | terminated | stopping | stopped

        • Default: All states

      • For version-depth:

        • Valid values: Integers between 1 and 10000

        • Default: 10

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

      Returns:
      A value for the specified option.

      • For state-name:

        • Valid values: pending | running | shutting-down | terminated | stopping | stopped

        • Default: All states

      • For version-depth:

        • Valid values: Integers between 1 and 10000

        • Default: 10

    • toBuilder

      public ResourceTypeOption.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ResourceTypeOption.Builder,ResourceTypeOption>

    • builder

      public static ResourceTypeOption.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

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