Package software.amazon.awssdk.services.cleanrooms.model

Class AnalysisParameter

java.lang.Object

software.amazon.awssdk.services.cleanrooms.model.AnalysisParameter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AnalysisParameter.Builder,AnalysisParameter>

@Generated("software.amazon.awssdk:codegen")
public final class AnalysisParameter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AnalysisParameter.Builder,AnalysisParameter>

Optional. The member who can query can provide this placeholder for a literal data value in an analysis template.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AnalysisParameter.Builder

Method Summary

Modifier and Type	Method	Description
static AnalysisParameter.Builder	builder()
String	defaultValue()	Optional.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the parameter.
List<SdkField<?>>	sdkFields()
static Class<? extends AnalysisParameter.Builder>	serializableBuilderClass()
AnalysisParameter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ParameterType	type()	The type of parameter.
String	typeAsString()	The type of parameter.

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

name

public final String name()

The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-) characters but cannot start or end with a hyphen.

Returns:

The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-) characters but cannot start or end with a hyphen.

type

public final ParameterType type()

The type of parameter.

If the service returns an enum value that is not available in the current SDK version, type will return ParameterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of parameter.

See Also:

ParameterType

typeAsString

public final String typeAsString()

The type of parameter.

If the service returns an enum value that is not available in the current SDK version, type will return ParameterType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of parameter.

See Also:

ParameterType

defaultValue

public final String defaultValue()

Optional. The default value that is applied in the analysis template. The member who can query can override this value in the query editor.

Returns:

Optional. The default value that is applied in the analysis template. The member who can query can override this value in the query editor.

toBuilder

public AnalysisParameter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AnalysisParameter.Builder,AnalysisParameter>

builder

public static AnalysisParameter.Builder builder()

serializableBuilderClass

public static Class<? extends AnalysisParameter.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo