CreateComponentRequest (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.CreateComponentRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateComponentRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateComponentRequest.Builder`	`builder()`
`String`	`changeDescription()` The change description of the component.
`String`	`clientToken()` The idempotency token of the component.
`String`	`data()` The data of the component.
`String`	`description()` The description of the component.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSupportedOsVersions()` Returns true if the SupportedOsVersions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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 CreateComponentRequest.Builder>`	`serializableBuilderClass()`
`List<String>`	`supportedOsVersions()` The operating system (OS) version supported by the component.
`Map<String,String>`	`tags()` The tags of the component.
`CreateComponentRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`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. For example, major.minor.patch. This could be versioned like software (2.0.1) or like a date (2019.12.01).
    
    Returns:
    
    The semantic version of the component. This version follows the semantic version syntax. For example, major.minor.patch. This could be versioned like software (2.0.1) or like a date (2019.12.01).
  - 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. Describes what change has been made in this version, or what makes this version different from other versions of this component.
    
    Returns:
    
    The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.
  - 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
  - hasSupportedOsVersions
```
public final boolean hasSupportedOsVersions()
```
    Returns true if the SupportedOsVersions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - supportedOsVersions
```
public final List<String> supportedOsVersions()
```
    The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSupportedOsVersions() to see if a value was sent in this field.
    
    Returns:
    
    The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.
  - 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 S3 URL and the requester must have permission to access the S3 bucket. If you use 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 S3 URL and the requester must have permission to access the S3 bucket. If you use 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()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    The tags of the component.
  - clientToken
```
public final String clientToken()
```
    The idempotency token of the component.
    
    Returns:
    
    The idempotency token of the component.
  - toBuilder
```
public CreateComponentRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateComponentRequest.Builder,CreateComponentRequest>
    
    Specified by:
    
    toBuilder in class ImagebuilderRequest
  - builder
```
public static CreateComponentRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateComponentRequest.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 CreateComponentRequest

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

platform

platformAsString

hasSupportedOsVersions

supportedOsVersions

data

uri

kmsKeyId

hasTags

tags

clientToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields