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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ImportComponentRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ImportComponentRequest.Builder`	`builder()`
`String`	`changeDescription()`	The change description of the component.
`String`	`clientToken()`	Unique, case-sensitive identifier you provide to ensure idempotency of the request.
`String`	`data()`	The data of the component.
`String`	`description()`	The description of the component.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`ComponentFormat`	`format()`	The format of the resource that you want to import as a component.
`String`	`formatAsString()`	The format of the resource that you want to import as a component.
`<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`	`kmsKeyId()`	The ID of the KMS key that should be used to encrypt this component.
`String`	`name()`	The name of the component.
`Platform`	`platform()`	The platform of the component.
`String`	`platformAsString()`	The platform of the component.
`List<SdkField<?>>`	`sdkFields()`
`String`	`semanticVersion()`	The semantic version of the component.
`static Class<? extends ImportComponentRequest.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()`	The tags of the component.
`ImportComponentRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`ComponentType`	`type()`	The type of the component denotes whether the component is used to build the image, or only to test it.
`String`	`typeAsString()`	The type of the component denotes whether the component is used to build the image, or only to test it.
`String`	`uri()`	The uri of the component.

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 component.
    
    Returns:
    
    The name of the component.
  - semanticVersion
```
public final String semanticVersion()
```
    The semantic version of the component. 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.
    
    Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
    
    Returns:
    
    The semantic version of the component. 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.
    
    Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
  - description
```
public final String description()
```
    The description of the component. Describes the contents of the component.
    
    Returns:
    
    The description of the component. Describes the contents of the component.
  - changeDescription
```
public final String changeDescription()
```
    The change description of the component. This description indicates the change that has been made in this version, or what makes this version different from other versions of the component.
    
    Returns:
    
    The change description of the component. This description indicates the change that has been made in this version, or what makes this version different from other versions of the component.
  - type
```
public final ComponentType type()
```
    The type of the component denotes whether the component is used to build the image, or only to test it.
    
    If the service returns an enum value that is not available in the current SDK version, type will return ComponentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of the component denotes whether the component is used to build the image, or only to test it.
    
    See Also:
    
    ComponentType
  - typeAsString
```
public final String typeAsString()
```
    The type of the component denotes whether the component is used to build the image, or only to test it.
    
    If the service returns an enum value that is not available in the current SDK version, type will return ComponentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of the component denotes whether the component is used to build the image, or only to test it.
    
    See Also:
    
    ComponentType
  - format
```
public final ComponentFormat format()
```
    The format of the resource that you want to import as a component.
    
    If the service returns an enum value that is not available in the current SDK version, format will return ComponentFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().
    
    Returns:
    
    The format of the resource that you want to import as a component.
    
    See Also:
    
    ComponentFormat
  - formatAsString
```
public final String formatAsString()
```
    The format of the resource that you want to import as a component.
    
    If the service returns an enum value that is not available in the current SDK version, format will return ComponentFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().
    
    Returns:
    
    The format of the resource that you want to import as a component.
    
    See Also:
    
    ComponentFormat
  - platform
```
public final Platform platform()
```
    The platform of the component.
    
    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 platform of the component.
    
    See Also:
    
    Platform
  - platformAsString
```
public final String platformAsString()
```
    The platform of the component.
    
    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 platform of the component.
    
    See Also:
    
    Platform
  - data
```
public final String data()
```
    The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.
    
    Returns:
    
    The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.
  - uri
```
public final String uri()
```
    The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.
    
    Returns:
    
    The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.
  - kmsKeyId
```
public final String kmsKeyId()
```
    The ID of the KMS key that should be used to encrypt this component.
    
    Returns:
    
    The ID of the KMS key that should be used to encrypt this component.
  - 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()
```
    The tags of the component.
    
    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:
    
    The tags of the component.
  - 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 ImportComponentRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ImportComponentRequest.Builder,ImportComponentRequest>
    
    Specified by:
    
    toBuilder in class ImagebuilderRequest
  - builder
```
public static ImportComponentRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ImportComponentRequest.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 ImportComponentRequest

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

changeDescription

type

typeAsString

format

formatAsString

platform

platformAsString

data

uri

kmsKeyId

hasTags

tags

clientToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields