Class GetAllowedImagesSettingsResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.ec2.model.Ec2Response
software.amazon.awssdk.services.ec2.model.GetAllowedImagesSettingsResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetAllowedImagesSettingsResponse.Builder,GetAllowedImagesSettingsResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetAllowedImagesSettingsResponse extends Ec2Response implements ToCopyableBuilder<GetAllowedImagesSettingsResponse.Builder,GetAllowedImagesSettingsResponse>

  • Method Details

    • state

      public final String state()

      The current state of the Allowed AMIs setting at the account level in the specified Amazon Web Services Region.

      Possible values:

      • disabled: All AMIs are allowed.

      • audit-mode: All AMIs are allowed, but the ImageAllowed field is set to true if the AMI would be allowed with the current list of criteria if allowed AMIs was enabled.

      • enabled: Only AMIs matching the image criteria are discoverable and available for use.

      Returns:
      The current state of the Allowed AMIs setting at the account level in the specified Amazon Web Services Region.

      Possible values:

      • disabled: All AMIs are allowed.

      • audit-mode: All AMIs are allowed, but the ImageAllowed field is set to true if the AMI would be allowed with the current list of criteria if allowed AMIs was enabled.

      • enabled: Only AMIs matching the image criteria are discoverable and available for use.

    • hasImageCriteria

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

    • imageCriteria

      public final List<ImageCriterion> imageCriteria()

      The list of criteria for images that are discoverable and usable in the account in the specified Amazon Web Services Region.

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

      Returns:
      The list of criteria for images that are discoverable and usable in the account in the specified Amazon Web Services Region.

    • managedBy

      public final ManagedBy managedBy()

      The entity that manages the Allowed AMIs settings. Possible values include:

      • account - The Allowed AMIs settings is managed by the account.

      • declarative-policy - The Allowed AMIs settings is managed by a declarative policy and can't be modified by the account.

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

      Returns:
      The entity that manages the Allowed AMIs settings. Possible values include:

      • account - The Allowed AMIs settings is managed by the account.

      • declarative-policy - The Allowed AMIs settings is managed by a declarative policy and can't be modified by the account.

      See Also:

    • managedByAsString

      public final String managedByAsString()

      The entity that manages the Allowed AMIs settings. Possible values include:

      • account - The Allowed AMIs settings is managed by the account.

      • declarative-policy - The Allowed AMIs settings is managed by a declarative policy and can't be modified by the account.

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

      Returns:
      The entity that manages the Allowed AMIs settings. Possible values include:

      • account - The Allowed AMIs settings is managed by the account.

      • declarative-policy - The Allowed AMIs settings is managed by a declarative policy and can't be modified by the account.

      See Also:

    • toBuilder

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

    • builder

      public static GetAllowedImagesSettingsResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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