Class CreateContainerRecipeRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateContainerRecipeRequest.Builder,
CreateContainerRecipeRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
Unique, case-sensitive identifier you provide to ensure idempotency of the request.final List
<ComponentConfiguration> Components for build and test that are included in the container recipe.final ContainerType
The type of container to create.final String
The type of container to create.final String
The description of the container recipe.final String
The Dockerfile template used to build your image as an inline data blob.final String
The Amazon S3 URI for the Dockerfile that will be used to build your container image.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Components property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
Specifies the operating system version for the base image.final InstanceConfiguration
A group of options that can be used to configure an instance for building and testing container images.final String
kmsKeyId()
Identifies which KMS key is used to encrypt the container image.final String
name()
The name of the container recipe.final String
The base image for the container recipe.final Platform
Specifies the operating system platform when you use a custom base image.final String
Specifies the operating system platform when you use a custom base image.final String
The semantic version of the container recipe.static Class
<? extends CreateContainerRecipeRequest.Builder> tags()
Tags that are attached to the container recipe.The destination repository for the container image.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The working directory for use during build and test workflows.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnContainerType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontainerTypeAsString()
.- Returns:
- The type of container to create.
- See Also:
-
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 returnContainerType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcontainerTypeAsString()
.- Returns:
- The type of container to create.
- See Also:
-
name
The name of the container recipe.
- Returns:
- The name of the container recipe.
-
description
The description of the container recipe.
- Returns:
- The description of the container recipe.
-
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 theisEmpty()
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
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
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
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
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
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 returnPlatform.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformOverrideAsString()
.- Returns:
- Specifies the operating system platform when you use a custom base image.
- See Also:
-
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 returnPlatform.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformOverrideAsString()
.- Returns:
- Specifies the operating system platform when you use a custom base image.
- See Also:
-
imageOsVersionOverride
Specifies the operating system version for the base image.
- Returns:
- Specifies the operating system version for the base image.
-
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 theisEmpty()
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
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
The working directory for use during build and test workflows.
- Returns:
- The working directory for use during build and test workflows.
-
targetRepository
The destination repository for the container image.
- Returns:
- The destination repository for the container image.
-
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateContainerRecipeRequest.Builder,
CreateContainerRecipeRequest> - Specified by:
toBuilder
in classImagebuilderRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-