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

Class DescribeConfigurationOptionsRequest

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.DescribeConfigurationOptionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeConfigurationOptionsRequest.Builder,DescribeConfigurationOptionsRequest>

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

Result message containing a list of application version descriptions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeConfigurationOptionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationName()	The name of the application associated with the configuration template or environment.
static DescribeConfigurationOptionsRequest.Builder	builder()
String	environmentName()	The name of the environment whose configuration options you want to describe.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOptions()	For responses, this returns true if the service returned a value for the Options property.
List<OptionSpecification>	options()	If specified, restricts the descriptions to only the specified options.
String	platformArn()	The ARN of the custom platform.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeConfigurationOptionsRequest.Builder>	serializableBuilderClass()
String	solutionStackName()	The name of the solution stack whose configuration options you want to describe.
String	templateName()	The name of the configuration template whose configuration options you want to describe.
DescribeConfigurationOptionsRequest.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

applicationName

public final String applicationName()

The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.

Returns:

The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.

templateName

public final String templateName()

The name of the configuration template whose configuration options you want to describe.

Returns:

The name of the configuration template whose configuration options you want to describe.

environmentName

public final String environmentName()

The name of the environment whose configuration options you want to describe.

Returns:

The name of the environment whose configuration options you want to describe.

solutionStackName

public final String solutionStackName()

The name of the solution stack whose configuration options you want to describe.

Returns:

The name of the solution stack whose configuration options you want to describe.

platformArn

public final String platformArn()

The ARN of the custom platform.

Returns:

The ARN of the custom platform.

hasOptions

public final boolean hasOptions()

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

options

public final List<OptionSpecification> options()

If specified, restricts the descriptions to only the specified options.

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

Returns:

If specified, restricts the descriptions to only the specified options.

toBuilder

public DescribeConfigurationOptionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeConfigurationOptionsRequest.Builder,DescribeConfigurationOptionsRequest>

Specified by:

toBuilder in class ElasticBeanstalkRequest

builder

public static DescribeConfigurationOptionsRequest.Builder builder()

serializableBuilderClass

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