ImportVmImageRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.imagebuilder.model.ImagebuilderRequest
    - - software.amazon.awssdk.services.imagebuilder.model.ImportVmImageRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ImportVmImageRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ImportVmImageRequest.Builder`	`builder()`
`String`	`clientToken()` Unique, case-sensitive identifier you provide to ensure idempotency of the request.
`String`	`description()` The description for the base image that is created by the import process.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`name()` The name of the base image that is created by the import process.
`String`	`osVersion()` The operating system version for the imported VM.
`Platform`	`platform()` The operating system platform for the imported VM.
`String`	`platformAsString()` The operating system platform for the imported VM.
`List<SdkField<?>>`	`sdkFields()`
`String`	`semanticVersion()` The semantic version to attach to the base image that was created during the .
`static Class<? extends ImportVmImageRequest.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()` Tags that are attached to the import resources.
`ImportVmImageRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`vmImportTaskId()` The `importTaskId` (API) or `ImportTaskId` (CLI) from the Amazon EC2 VM import process.

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
  - name
```
public final String name()
```
    The name of the base image that is created by the import process.
    
    Returns:
    
    The name of the base image that is created by the import process.
  - semanticVersion
```
public final String semanticVersion()
```
    The semantic version to attach to the base image that was created during the . You can assign values for the first three, and can filter on all of them.
    
    Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
    
    Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
    
    Returns:
    
    The semantic version to attach to the base image that was created during the import process. This version follows the semantic version syntax.
    
    The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.
    
    Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.
    
    Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.
  - description
```
public final String description()
```
    The description for the base image that is created by the import process.
    
    Returns:
    
    The description for the base image that is created by the import process.
  - platform
```
public final Platform platform()
```
    The operating system platform for the imported VM.
    
    If the service returns an enum value that is not available in the current SDK version, platform will return Platform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().
    
    Returns:
    
    The operating system platform for the imported VM.
    
    See Also:
    
    Platform
  - platformAsString
```
public final String platformAsString()
```
    The operating system platform for the imported VM.
    
    If the service returns an enum value that is not available in the current SDK version, platform will return Platform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().
    
    Returns:
    
    The operating system platform for the imported VM.
    
    See Also:
    
    Platform
  - osVersion
```
public final String osVersion()
```
    The operating system version for the imported VM.
    
    Returns:
    
    The operating system version for the imported VM.
  - vmImportTaskId
```
public final String vmImportTaskId()
```
    The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull in the AMI that is created from the VM source as the base image for your recipe.
    
    Returns:
    
    The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull in the AMI that is created from the VM source as the base image for your recipe.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final Map<String,String> tags()
```
    Tags that are attached to the import resources.
    
    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 hasTags() method.
    
    Returns:
    
    Tags that are attached to the import resources.
  - clientToken
```
public final String clientToken()
```
    Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
    
    Returns:
    
    Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
  - toBuilder
```
public ImportVmImageRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ImportVmImageRequest.Builder,ImportVmImageRequest>
    
    Specified by:
    
    toBuilder in class ImagebuilderRequest
  - builder
```
public static ImportVmImageRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ImportVmImageRequest.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 ImportVmImageRequest

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

name

semanticVersion

description

platform

platformAsString

osVersion

vmImportTaskId

hasTags

tags

clientToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields