ExportImageRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.ec2.model.ExportImageRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<ExportImageRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ExportImageRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<ExportImageRequest>

See Also:: Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

ExportImageRequest()

Constructors
Constructor and Description
`ExportImageRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ExportImageRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`String`	`getClientToken()` Token to enable idempotency for export image requests.
`String`	`getDescription()` A description of the image being exported.
`String`	`getDiskImageFormat()` The disk image format.
`Request<ExportImageRequest>`	`getDryRunRequest()` This method is intended for internal use only.
`String`	`getImageId()` The ID of the image.
`String`	`getRoleName()` The name of the role that grants VM Import/Export permission to export images to your S3 bucket.
`ExportTaskS3LocationRequest`	`getS3ExportLocation()` Information about the destination S3 bucket.
`int`	`hashCode()`
`void`	`setClientToken(String clientToken)` Token to enable idempotency for export image requests.
`void`	`setDescription(String description)` A description of the image being exported.
`void`	`setDiskImageFormat(String diskImageFormat)` The disk image format.
`void`	`setImageId(String imageId)` The ID of the image.
`void`	`setRoleName(String roleName)` The name of the role that grants VM Import/Export permission to export images to your S3 bucket.
`void`	`setS3ExportLocation(ExportTaskS3LocationRequest s3ExportLocation)` Information about the destination S3 bucket.
`String`	`toString()` Returns a string representation of this object.
`ExportImageRequest`	`withClientToken(String clientToken)` Token to enable idempotency for export image requests.
`ExportImageRequest`	`withDescription(String description)` A description of the image being exported.
`ExportImageRequest`	`withDiskImageFormat(DiskImageFormat diskImageFormat)` The disk image format.
`ExportImageRequest`	`withDiskImageFormat(String diskImageFormat)` The disk image format.
`ExportImageRequest`	`withImageId(String imageId)` The ID of the image.
`ExportImageRequest`	`withRoleName(String roleName)` The name of the role that grants VM Import/Export permission to export images to your S3 bucket.
`ExportImageRequest`	`withS3ExportLocation(ExportTaskS3LocationRequest s3ExportLocation)` Information about the destination S3 bucket.

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

- Constructor Detail
  - ExportImageRequest
```
public ExportImageRequest()
```
- Method Detail
  - setClientToken
```
public void setClientToken(String clientToken)
```
    Token to enable idempotency for export image requests.
    
    Parameters:
    
    clientToken - Token to enable idempotency for export image requests.
  - getClientToken
```
public String getClientToken()
```
    Token to enable idempotency for export image requests.
    
    Returns:
    
    Token to enable idempotency for export image requests.
  - withClientToken
```
public ExportImageRequest withClientToken(String clientToken)
```
    Token to enable idempotency for export image requests.
    
    Parameters:
    
    clientToken - Token to enable idempotency for export image requests.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the image being exported. The maximum length is 255 bytes.
    
    Parameters:
    
    description - A description of the image being exported. The maximum length is 255 bytes.
  - getDescription
```
public String getDescription()
```
    A description of the image being exported. The maximum length is 255 bytes.
    
    Returns:
    
    A description of the image being exported. The maximum length is 255 bytes.
  - withDescription
```
public ExportImageRequest withDescription(String description)
```
    A description of the image being exported. The maximum length is 255 bytes.
    
    Parameters:
    
    description - A description of the image being exported. The maximum length is 255 bytes.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDiskImageFormat
```
public void setDiskImageFormat(String diskImageFormat)
```
    The disk image format.
    
    Parameters:
    
    diskImageFormat - The disk image format.
    
    See Also:
    
    DiskImageFormat
  - getDiskImageFormat
```
public String getDiskImageFormat()
```
    The disk image format.
    
    Returns:
    
    The disk image format.
    
    See Also:
    
    DiskImageFormat
  - withDiskImageFormat
```
public ExportImageRequest withDiskImageFormat(String diskImageFormat)
```
    The disk image format.
    
    Parameters:
    
    diskImageFormat - The disk image format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DiskImageFormat
  - withDiskImageFormat
```
public ExportImageRequest withDiskImageFormat(DiskImageFormat diskImageFormat)
```
    The disk image format.
    
    Parameters:
    
    diskImageFormat - The disk image format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DiskImageFormat
  - setImageId
```
public void setImageId(String imageId)
```
    The ID of the image.
    
    Parameters:
    
    imageId - The ID of the image.
  - getImageId
```
public String getImageId()
```
    The ID of the image.
    
    Returns:
    
    The ID of the image.
  - withImageId
```
public ExportImageRequest withImageId(String imageId)
```
    The ID of the image.
    
    Parameters:
    
    imageId - The ID of the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3ExportLocation
```
public void setS3ExportLocation(ExportTaskS3LocationRequest s3ExportLocation)
```
    Information about the destination S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account [email protected].
    
    Parameters:
    
    s3ExportLocation - Information about the destination S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account [email protected].
  - getS3ExportLocation
```
public ExportTaskS3LocationRequest getS3ExportLocation()
```
    Information about the destination S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account [email protected].
    
    Returns:
    
    Information about the destination S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account [email protected].
  - withS3ExportLocation
```
public ExportImageRequest withS3ExportLocation(ExportTaskS3LocationRequest s3ExportLocation)
```
    Information about the destination S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account [email protected].
    
    Parameters:
    
    s3ExportLocation - Information about the destination S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account [email protected].
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleName
```
public void setRoleName(String roleName)
```
    The name of the role that grants VM Import/Export permission to export images to your S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.
    
    Parameters:
    
    roleName - The name of the role that grants VM Import/Export permission to export images to your S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.
  - getRoleName
```
public String getRoleName()
```
    The name of the role that grants VM Import/Export permission to export images to your 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 S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.
  - withRoleName
```
public ExportImageRequest withRoleName(String roleName)
```
    The name of the role that grants VM Import/Export permission to export images to your S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.
    
    Parameters:
    
    roleName - The name of the role that grants VM Import/Export permission to export images to your S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDryRunRequest
```
public Request<ExportImageRequest> getDryRunRequest()
```
    This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.
    
    Specified by:
    
    getDryRunRequest in interface DryRunSupportedRequest<ExportImageRequest>
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ExportImageRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class ExportImageRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ExportImageRequest

Method Detail

setClientToken

getClientToken

withClientToken

setDescription

getDescription

withDescription

setDiskImageFormat

getDiskImageFormat

withDiskImageFormat

withDiskImageFormat

setImageId

getImageId

withImageId

setS3ExportLocation

getS3ExportLocation

withS3ExportLocation

setRoleName

getRoleName

withRoleName

getDryRunRequest

toString

equals

hashCode

clone