@Generated(value="software.amazon.awssdk:codegen") public final class CreateComponentRequest extends ImagebuilderRequest implements ToCopyableBuilder<CreateComponentRequest.Builder,CreateComponentRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateComponentRequest.Builder |
| 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()
Component
data contains inline YAML document content for 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()
For responses, this returns true if the service returned a value for the SupportedOsVersions property.
|
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 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 a YAML component document file. |
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String name()
The name of the component.
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.
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.
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.
public final String description()
The description of the component. Describes the contents of the component.
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.
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().
Platformpublic 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().
Platformpublic final boolean hasSupportedOsVersions()
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.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 base image OS version during image recipe creation.
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 hasSupportedOsVersions() method.
public final String data()
Component data contains inline YAML document content for the component. Alternatively, you can
specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify both
properties.
data contains inline YAML document content for the component. Alternatively, you
can specify the uri of a YAML document file stored in Amazon S3. However, you cannot specify
both properties.public final String uri()
The uri of a YAML component document file. This must be an S3 URL (s3://bucket/key),
and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can
specify component content up to your service quota.
Alternatively, you can specify the YAML document inline, using the component data property. You
cannot specify both properties.
uri of a YAML component document file. This must be an S3 URL (
s3://bucket/key), and the requester must have permission to access the S3 bucket it points
to. If you use Amazon S3, you can specify component content up to your service quota.
Alternatively, you can specify the YAML document inline, using the component data property.
You cannot specify both properties.
public final String kmsKeyId()
The ID of the KMS key that should be used to encrypt this component.
public final boolean hasTags()
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.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.
public final String clientToken()
The idempotency token of the component.
public CreateComponentRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateComponentRequest.Builder,CreateComponentRequest>toBuilder in class ImagebuilderRequestpublic static CreateComponentRequest.Builder builder()
public static Class<? extends CreateComponentRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.