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

Class CreateImageUsageReportRequest

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

  • Method Details

    • imageId

      public final String imageId()

      The ID of the image to report on.

      Returns:
      The ID of the image to report on.

    • dryRun

      public final Boolean dryRun()

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Returns:
      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

    • hasResourceTypes

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

    • resourceTypes

      public final List<ImageUsageResourceTypeRequest> resourceTypes()

      The resource types to include in the report.

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

      Returns:
      The resource types to include in the report.

    • hasAccountIds

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

    • accountIds

      public final List<String> accountIds()

      The Amazon Web Services account IDs to include in the report. To include all accounts, omit this parameter.

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

      Returns:
      The Amazon Web Services account IDs to include in the report. To include all accounts, omit this parameter.

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier that you provide to ensure idempotency of the request.

      Returns:
      A unique, case-sensitive identifier that you provide to ensure idempotency of the request.

    • hasTagSpecifications

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

    • tagSpecifications

      public final List<TagSpecification> tagSpecifications()

      The tags to apply to the report on creation. The ResourceType must be set to image-usage-report; any other value will cause the report creation to fail.

      To tag a report after it has been created, see CreateTags.

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

      Returns:
      The tags to apply to the report on creation. The ResourceType must be set to image-usage-report; any other value will cause the report creation to fail.

      To tag a report after it has been created, see CreateTags.

    • toBuilder

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

    • builder

      public static CreateImageUsageReportRequest.Builder builder()

    • serializableBuilderClass

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