software.amazon.awssdk.services.quicksight.model.DescribeTemplateRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of quicksight Show documentation
Show all versions of quicksight Show documentation
The AWS Java SDK for QuickSight module holds the client classes that are used for
communicating with QuickSight.
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.quicksight.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeTemplateRequest extends QuickSightRequest implements
ToCopyableBuilder {
private static final SdkField AWS_ACCOUNT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AwsAccountId").getter(getter(DescribeTemplateRequest::awsAccountId))
.setter(setter(Builder::awsAccountId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("AwsAccountId").build()).build();
private static final SdkField TEMPLATE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TemplateId").getter(getter(DescribeTemplateRequest::templateId)).setter(setter(Builder::templateId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("TemplateId").build()).build();
private static final SdkField VERSION_NUMBER_FIELD = SdkField. builder(MarshallingType.LONG)
.memberName("VersionNumber").getter(getter(DescribeTemplateRequest::versionNumber))
.setter(setter(Builder::versionNumber))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("version-number").build())
.build();
private static final SdkField ALIAS_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AliasName").getter(getter(DescribeTemplateRequest::aliasName)).setter(setter(Builder::aliasName))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("alias-name").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(AWS_ACCOUNT_ID_FIELD,
TEMPLATE_ID_FIELD, VERSION_NUMBER_FIELD, ALIAS_NAME_FIELD));
private final String awsAccountId;
private final String templateId;
private final Long versionNumber;
private final String aliasName;
private DescribeTemplateRequest(BuilderImpl builder) {
super(builder);
this.awsAccountId = builder.awsAccountId;
this.templateId = builder.templateId;
this.versionNumber = builder.versionNumber;
this.aliasName = builder.aliasName;
}
/**
*
* The ID of the Amazon Web Services account that contains the template that you're describing.
*
*
* @return The ID of the Amazon Web Services account that contains the template that you're describing.
*/
public final String awsAccountId() {
return awsAccountId;
}
/**
*
* The ID for the template.
*
*
* @return The ID for the template.
*/
public final String templateId() {
return templateId;
}
/**
*
* (Optional) The number for the version to describe. If a VersionNumber parameter value isn't
* provided, the latest version of the template is described.
*
*
* @return (Optional) The number for the version to describe. If a VersionNumber parameter value isn't
* provided, the latest version of the template is described.
*/
public final Long versionNumber() {
return versionNumber;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String aliasName() {
return aliasName;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(awsAccountId());
hashCode = 31 * hashCode + Objects.hashCode(templateId());
hashCode = 31 * hashCode + Objects.hashCode(versionNumber());
hashCode = 31 * hashCode + Objects.hashCode(aliasName());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof DescribeTemplateRequest)) {
return false;
}
DescribeTemplateRequest other = (DescribeTemplateRequest) obj;
return Objects.equals(awsAccountId(), other.awsAccountId()) && Objects.equals(templateId(), other.templateId())
&& Objects.equals(versionNumber(), other.versionNumber()) && Objects.equals(aliasName(), other.aliasName());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("DescribeTemplateRequest").add("AwsAccountId", awsAccountId()).add("TemplateId", templateId())
.add("VersionNumber", versionNumber()).add("AliasName", aliasName()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AwsAccountId":
return Optional.ofNullable(clazz.cast(awsAccountId()));
case "TemplateId":
return Optional.ofNullable(clazz.cast(templateId()));
case "VersionNumber":
return Optional.ofNullable(clazz.cast(versionNumber()));
case "AliasName":
return Optional.ofNullable(clazz.cast(aliasName()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeTemplateRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends QuickSightRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The ID of the Amazon Web Services account that contains the template that you're describing.
*
*
* @param awsAccountId
* The ID of the Amazon Web Services account that contains the template that you're describing.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder awsAccountId(String awsAccountId);
/**
*
* The ID for the template.
*
*
* @param templateId
* The ID for the template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder templateId(String templateId);
/**
*
* (Optional) The number for the version to describe. If a VersionNumber parameter value isn't
* provided, the latest version of the template is described.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder versionNumber(Long versionNumber);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder aliasName(String aliasName);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends QuickSightRequest.BuilderImpl implements Builder {
private String awsAccountId;
private String templateId;
private Long versionNumber;
private String aliasName;
private BuilderImpl() {
}
private BuilderImpl(DescribeTemplateRequest model) {
super(model);
awsAccountId(model.awsAccountId);
templateId(model.templateId);
versionNumber(model.versionNumber);
aliasName(model.aliasName);
}
public final String getAwsAccountId() {
return awsAccountId;
}
public final void setAwsAccountId(String awsAccountId) {
this.awsAccountId = awsAccountId;
}
@Override
public final Builder awsAccountId(String awsAccountId) {
this.awsAccountId = awsAccountId;
return this;
}
public final String getTemplateId() {
return templateId;
}
public final void setTemplateId(String templateId) {
this.templateId = templateId;
}
@Override
public final Builder templateId(String templateId) {
this.templateId = templateId;
return this;
}
public final Long getVersionNumber() {
return versionNumber;
}
public final void setVersionNumber(Long versionNumber) {
this.versionNumber = versionNumber;
}
@Override
public final Builder versionNumber(Long versionNumber) {
this.versionNumber = versionNumber;
return this;
}
public final String getAliasName() {
return aliasName;
}
public final void setAliasName(String aliasName) {
this.aliasName = aliasName;
}
@Override
public final Builder aliasName(String aliasName) {
this.aliasName = aliasName;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeTemplateRequest build() {
return new DescribeTemplateRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}