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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateContainerRecipeRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateContainerRecipeRequest.Builder`	`builder()`
`String`	`clientToken()` The client token used to make this request idempotent.
`List<ComponentConfiguration>`	`components()` Components for build and test that are included in the container recipe.
`ContainerType`	`containerType()` The type of container to create.
`String`	`containerTypeAsString()` The type of container to create.
`String`	`description()` The description of the container recipe.
`String`	`dockerfileTemplateData()` The Dockerfile template used to build your image as an inline data blob.
`String`	`dockerfileTemplateUri()` The Amazon S3 URI for the Dockerfile that will be used to build your container image.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasComponents()` For responses, this returns true if the service returned a value for the Components property.
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`imageOsVersionOverride()` Specifies the operating system version for the base image.
`InstanceConfiguration`	`instanceConfiguration()` A group of options that can be used to configure an instance for building and testing container images.
`String`	`kmsKeyId()` Identifies which KMS key is used to encrypt the container image.
`String`	`name()` The name of the container recipe.
`String`	`parentImage()` The base image for the container recipe.
`Platform`	`platformOverride()` Specifies the operating system platform when you use a custom base image.
`String`	`platformOverrideAsString()` Specifies the operating system platform when you use a custom base image.
`List<SdkField<?>>`	`sdkFields()`
`String`	`semanticVersion()` The semantic version of the container recipe.
`static Class<? extends CreateContainerRecipeRequest.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()` Tags that are attached to the container recipe.
`TargetContainerRepository`	`targetRepository()` The destination repository for the container image.
`CreateContainerRecipeRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`workingDirectory()` The working directory for use during build and test workflows.

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
  - containerType
```
public final ContainerType containerType()
```
    The type of container to create.
    
    If the service returns an enum value that is not available in the current SDK version, containerType will return ContainerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from containerTypeAsString().
    
    Returns:
    
    The type of container to create.
    
    See Also:
    
    ContainerType
  - containerTypeAsString
```
public final String containerTypeAsString()
```
    The type of container to create.
    
    If the service returns an enum value that is not available in the current SDK version, containerType will return ContainerType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from containerTypeAsString().
    
    Returns:
    
    The type of container to create.
    
    See Also:
    
    ContainerType
  - name
```
public final String name()
```
    The name of the container recipe.
    
    Returns:
    
    The name of the container recipe.
  - description
```
public final String description()
```
    The description of the container recipe.
    
    Returns:
    
    The description of the container recipe.
  - semanticVersion
```
public final String semanticVersion()
```
    The semantic version of the container recipe. 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.
    
    Returns:
    
    The semantic version of the container recipe. 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.
  - hasComponents
```
public final boolean hasComponents()
```
    For responses, this returns true if the service returned a value for the Components 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.
  - components
```
public final List<ComponentConfiguration> components()
```
    Components for build and test that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.
    
    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 hasComponents() method.
    
    Returns:
    
    Components for build and test that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.
  - instanceConfiguration
```
public final InstanceConfiguration instanceConfiguration()
```
    A group of options that can be used to configure an instance for building and testing container images.
    
    Returns:
    
    A group of options that can be used to configure an instance for building and testing container images.
  - dockerfileTemplateData
```
public final String dockerfileTemplateData()
```
    The Dockerfile template used to build your image as an inline data blob.
    
    Returns:
    
    The Dockerfile template used to build your image as an inline data blob.
  - dockerfileTemplateUri
```
public final String dockerfileTemplateUri()
```
    The Amazon S3 URI for the Dockerfile that will be used to build your container image.
    
    Returns:
    
    The Amazon S3 URI for the Dockerfile that will be used to build your container image.
  - platformOverride
```
public final Platform platformOverride()
```
    Specifies the operating system platform when you use a custom base image.
    
    If the service returns an enum value that is not available in the current SDK version, platformOverride will return Platform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformOverrideAsString().
    
    Returns:
    
    Specifies the operating system platform when you use a custom base image.
    
    See Also:
    
    Platform
  - platformOverrideAsString
```
public final String platformOverrideAsString()
```
    Specifies the operating system platform when you use a custom base image.
    
    If the service returns an enum value that is not available in the current SDK version, platformOverride will return Platform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformOverrideAsString().
    
    Returns:
    
    Specifies the operating system platform when you use a custom base image.
    
    See Also:
    
    Platform
  - imageOsVersionOverride
```
public final String imageOsVersionOverride()
```
    Specifies the operating system version for the base image.
    
    Returns:
    
    Specifies the operating system version for the base image.
  - parentImage
```
public final String parentImage()
```
    The base image for the container recipe.
    
    Returns:
    
    The base image for the container 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 container recipe.
    
    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 container recipe.
  - workingDirectory
```
public final String workingDirectory()
```
    The working directory for use during build and test workflows.
    
    Returns:
    
    The working directory for use during build and test workflows.
  - targetRepository
```
public final TargetContainerRepository targetRepository()
```
    The destination repository for the container image.
    
    Returns:
    
    The destination repository for the container image.
  - kmsKeyId
```
public final String kmsKeyId()
```
    Identifies which KMS key is used to encrypt the container image.
    
    Returns:
    
    Identifies which KMS key is used to encrypt the container image.
  - clientToken
```
public final String clientToken()
```
    The client token used to make this request idempotent.
    
    Returns:
    
    The client token used to make this request idempotent.
  - toBuilder
```
public CreateContainerRecipeRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateContainerRecipeRequest.Builder,CreateContainerRecipeRequest>
    
    Specified by:
    
    toBuilder in class ImagebuilderRequest
  - builder
```
public static CreateContainerRecipeRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateContainerRecipeRequest.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 CreateContainerRecipeRequest

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

containerType

containerTypeAsString

name

description

semanticVersion

hasComponents

components

instanceConfiguration

dockerfileTemplateData

dockerfileTemplateUri

platformOverride

platformOverrideAsString

imageOsVersionOverride

parentImage

hasTags

tags

workingDirectory

targetRepository

kmsKeyId

clientToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields