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

Class CreateAnalysisTemplateRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cleanrooms.model.CleanRoomsRequest

software.amazon.awssdk.services.cleanrooms.model.CreateAnalysisTemplateRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAnalysisTemplateRequest.Builder,CreateAnalysisTemplateRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateAnalysisTemplateRequest.Builder

Method Summary

Modifier and Type	Method	Description
List<AnalysisParameter>	analysisParameters()	The parameters of the analysis template.
static CreateAnalysisTemplateRequest.Builder	builder()
String	description()	The description of the analysis template.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
AnalysisFormat	format()	The format of the analysis template.
String	formatAsString()	The format of the analysis template.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAnalysisParameters()	For responses, this returns true if the service returned a value for the AnalysisParameters property.
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	membershipIdentifier()	The identifier for a membership resource.
String	name()	The name of the analysis template.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAnalysisTemplateRequest.Builder>	serializableBuilderClass()
AnalysisSource	source()	The information in the analysis template.
Map<String,String>	tags()	An optional label that you can assign to a resource when you create it.
CreateAnalysisTemplateRequest.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

description

public final String description()

The description of the analysis template.

Returns:

The description of the analysis template.

membershipIdentifier

public final String membershipIdentifier()

The identifier for a membership resource.

Returns:

The identifier for a membership resource.

name

public final String name()

The name of the analysis template.

Returns:

The name of the analysis template.

format

public final AnalysisFormat format()

The format of the analysis template.

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

Returns:

The format of the analysis template.

See Also:

AnalysisFormat

formatAsString

public final String formatAsString()

The format of the analysis template.

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

Returns:

The format of the analysis template.

See Also:

AnalysisFormat

source

public final AnalysisSource source()

The information in the analysis template. Currently supports text, the query text for the analysis template.

Returns:

The information in the analysis template. Currently supports text, the query text for the analysis template.

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()

An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

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:

An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.

hasAnalysisParameters

public final boolean hasAnalysisParameters()

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

analysisParameters

public final List<AnalysisParameter> analysisParameters()

The parameters of the analysis template.

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

Returns:

The parameters of the analysis template.

toBuilder

public CreateAnalysisTemplateRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAnalysisTemplateRequest.Builder,CreateAnalysisTemplateRequest>

Specified by:

toBuilder in class CleanRoomsRequest

builder

public static CreateAnalysisTemplateRequest.Builder builder()

serializableBuilderClass

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