Package software.amazon.awssdk.services.elasticbeanstalk.model

Class CreatePlatformVersionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.elasticbeanstalk.model.ElasticBeanstalkRequest

software.amazon.awssdk.services.elasticbeanstalk.model.CreatePlatformVersionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreatePlatformVersionRequest.Builder,CreatePlatformVersionRequest>

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

Request to create a new platform version.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreatePlatformVersionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreatePlatformVersionRequest.Builder	builder()
String	environmentName()	The name of the builder environment.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOptionSettings()	For responses, this returns true if the service returned a value for the OptionSettings property.
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
List<ConfigurationOptionSetting>	optionSettings()	The configuration option settings to apply to the builder environment.
S3Location	platformDefinitionBundle()	The location of the platform definition archive in Amazon S3.
String	platformName()	The name of your custom platform.
String	platformVersion()	The number, such as 1.0.2, for the new platform version.
List<SdkField<?>>	sdkFields()
static Class<? extends CreatePlatformVersionRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	Specifies the tags applied to the new platform version.
CreatePlatformVersionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

platformName

public final String platformName()

The name of your custom platform.

Returns:

The name of your custom platform.

platformVersion

public final String platformVersion()

The number, such as 1.0.2, for the new platform version.

Returns:

The number, such as 1.0.2, for the new platform version.

platformDefinitionBundle

public final S3Location platformDefinitionBundle()

The location of the platform definition archive in Amazon S3.

Returns:

The location of the platform definition archive in Amazon S3.

environmentName

public final String environmentName()

The name of the builder environment.

Returns:

The name of the builder environment.

hasOptionSettings

public final boolean hasOptionSettings()

For responses, this returns true if the service returned a value for the OptionSettings 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.

optionSettings

public final List<ConfigurationOptionSetting> optionSettings()

The configuration option settings to apply to the builder environment.

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 hasOptionSettings() method.

Returns:

The configuration option settings to apply to the builder environment.

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 List<Tag> tags()

Specifies the tags applied to the new platform version.

Elastic Beanstalk applies these tags only to the platform version. Environments that you create using the platform version don't inherit the tags.

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:

Specifies the tags applied to the new platform version.

Elastic Beanstalk applies these tags only to the platform version. Environments that you create using the platform version don't inherit the tags.

toBuilder

public CreatePlatformVersionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreatePlatformVersionRequest.Builder,CreatePlatformVersionRequest>

Specified by:

toBuilder in class ElasticBeanstalkRequest

builder

public static CreatePlatformVersionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreatePlatformVersionRequest.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