Package com.ibm.cloud.is.vpc.v1.model

Class CreateImageExportJobOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.is.vpc.v1.model.CreateImageExportJobOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class CreateImageExportJobOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The createImageExportJob options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateImageExportJobOptions.Builder	Builder.
static interface	CreateImageExportJobOptions.Format	The format to use for the exported image.

Method Summary

Modifier and Type	Method	Description
String	format()	Gets the format.
String	imageId()	Gets the imageId.
String	name()	Gets the name.
CreateImageExportJobOptions.Builder	newBuilder()	New builder.
CloudObjectStorageBucketIdentity	storageBucket()	Gets the storageBucket.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public CreateImageExportJobOptions.Builder newBuilder()

New builder.

Returns:

a CreateImageExportJobOptions builder

imageId

public String imageId()

Gets the imageId. The image identifier.

Returns:

the imageId

storageBucket

public CloudObjectStorageBucketIdentity storageBucket()

Gets the storageBucket. The Cloud Object Storage bucket to export the image to. The bucket must exist and an IAM service authorization must grant `Image Service for VPC` of `VPC Infrastructure Services` writer access to the bucket.

Returns:

the storageBucket

format

public String format()

Gets the format. The format to use for the exported image. If the image is encrypted, only `qcow2` is supported.

Returns:

the format

name

public String name()

Gets the name. The name for this image export job. The name must not be used by another export job for the image. If unspecified, the name will be a hyphenated list of randomly-selected words prefixed with the first 16 characters of the parent image name. The exported image object name in Cloud Object Storage (`storage_object.name` in the response) will be based on this name. The object name will be unique within the bucket.

Returns:

the name