Package software.amazon.awssdk.services.quicksight.model

Class DescribeTemplateRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.quicksight.model.QuickSightRequest

software.amazon.awssdk.services.quicksight.model.DescribeTemplateRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeTemplateRequest.Builder,DescribeTemplateRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeTemplateRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	aliasName()	The alias of the template that you want to describe.
String	awsAccountId()	The ID of the Amazon Web Services account that contains the template that you're describing.
static DescribeTemplateRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeTemplateRequest.Builder>	serializableBuilderClass()
String	templateId()	The ID for the template.
DescribeTemplateRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Long	versionNumber()	(Optional) The number for the version to describe.

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

awsAccountId

public final String awsAccountId()

The ID of the Amazon Web Services account that contains the template that you're describing.

Returns:

The ID of the Amazon Web Services account that contains the template that you're describing.

templateId

public final String templateId()

The ID for the template.

Returns:

The ID for the template.

versionNumber

public final Long versionNumber()

(Optional) The number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the template is described.

Returns:

(Optional) The number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the template is described.

aliasName

public final String aliasName()

The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.

Returns:

The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.

toBuilder

public DescribeTemplateRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeTemplateRequest.Builder,DescribeTemplateRequest>

Specified by:

toBuilder in class QuickSightRequest

builder

public static DescribeTemplateRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo