ExportImageRequest (AWS Java SDK :: Services

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.ExportImageRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ExportImageRequest.Builder,ExportImageRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ExportImageRequest
extends Ec2Request
implements ToCopyableBuilder<ExportImageRequest.Builder,ExportImageRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ExportImageRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ExportImageRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ExportImageRequest.Builder`	`builder()`
`String`	`clientToken()` Token to enable idempotency for export image requests.
`String`	`description()` A description of the image being exported.
`DiskImageFormat`	`diskImageFormat()` The disk image format.
`String`	`diskImageFormatAsString()` The disk image format.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTagSpecifications()` For responses, this returns true if the service returned a value for the TagSpecifications property.
`String`	`imageId()` The ID of the image.
`String`	`roleName()` The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket.
`ExportTaskS3LocationRequest`	`s3ExportLocation()` Information about the destination Amazon S3 bucket.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ExportImageRequest.Builder>`	`serializableBuilderClass()`
`List<TagSpecification>`	`tagSpecifications()` The tags to apply to the export image task during creation.
`ExportImageRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - clientToken
```
public final String clientToken()
```
    Token to enable idempotency for export image requests.
    
    Returns:
    
    Token to enable idempotency for export image requests.
  - description
```
public final String description()
```
    A description of the image being exported. The maximum length is 255 characters.
    
    Returns:
    
    A description of the image being exported. The maximum length is 255 characters.
  - diskImageFormat
```
public final DiskImageFormat diskImageFormat()
```
    The disk image format.
    
    If the service returns an enum value that is not available in the current SDK version, diskImageFormat will return DiskImageFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from diskImageFormatAsString().
    
    Returns:
    
    The disk image format.
    
    See Also:
    
    DiskImageFormat
  - diskImageFormatAsString
```
public final String diskImageFormatAsString()
```
    The disk image format.
    
    If the service returns an enum value that is not available in the current SDK version, diskImageFormat will return DiskImageFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from diskImageFormatAsString().
    
    Returns:
    
    The disk image format.
    
    See Also:
    
    DiskImageFormat
  - imageId
```
public final String imageId()
```
    The ID of the image.
    
    Returns:
    
    The ID of the image.
  - s3ExportLocation
```
public final ExportTaskS3LocationRequest s3ExportLocation()
```
    Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the Amazon Web Services account [email protected].
    
    Returns:
    
    Information about the destination Amazon S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the Amazon Web Services account [email protected].
  - roleName
```
public final String roleName()
```
    The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.
    
    Returns:
    
    The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.
  - 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 export image task during creation.
    
    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 export image task during creation.
  - toBuilder
```
public ExportImageRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ExportImageRequest.Builder,ExportImageRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static ExportImageRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ExportImageRequest.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

Class ExportImageRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

clientToken

description

diskImageFormat

diskImageFormatAsString

imageId

s3ExportLocation

roleName

hasTagSpecifications

tagSpecifications

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields