software.amazon.awssdk.services.quicksight.model.FolderSummary 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.io.Serializable;
import java.time.Instant;
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.Function;
import software.amazon.awssdk.annotations.Generated;
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;
/**
*
* A summary of information about an existing Amazon QuickSight folder.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class FolderSummary implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Arn")
.getter(getter(FolderSummary::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Arn").build()).build();
private static final SdkField FOLDER_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("FolderId").getter(getter(FolderSummary::folderId)).setter(setter(Builder::folderId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FolderId").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(FolderSummary::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField FOLDER_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("FolderType").getter(getter(FolderSummary::folderTypeAsString)).setter(setter(Builder::folderType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FolderType").build()).build();
private static final SdkField CREATED_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreatedTime").getter(getter(FolderSummary::createdTime)).setter(setter(Builder::createdTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreatedTime").build()).build();
private static final SdkField LAST_UPDATED_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("LastUpdatedTime").getter(getter(FolderSummary::lastUpdatedTime))
.setter(setter(Builder::lastUpdatedTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LastUpdatedTime").build()).build();
private static final SdkField SHARING_MODEL_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SharingModel").getter(getter(FolderSummary::sharingModelAsString)).setter(setter(Builder::sharingModel))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SharingModel").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ARN_FIELD, FOLDER_ID_FIELD,
NAME_FIELD, FOLDER_TYPE_FIELD, CREATED_TIME_FIELD, LAST_UPDATED_TIME_FIELD, SHARING_MODEL_FIELD));
private static final long serialVersionUID = 1L;
private final String arn;
private final String folderId;
private final String name;
private final String folderType;
private final Instant createdTime;
private final Instant lastUpdatedTime;
private final String sharingModel;
private FolderSummary(BuilderImpl builder) {
this.arn = builder.arn;
this.folderId = builder.folderId;
this.name = builder.name;
this.folderType = builder.folderType;
this.createdTime = builder.createdTime;
this.lastUpdatedTime = builder.lastUpdatedTime;
this.sharingModel = builder.sharingModel;
}
/**
*
* The Amazon Resource Name (ARN) of the folder.
*
*
* @return The Amazon Resource Name (ARN) of the folder.
*/
public final String arn() {
return arn;
}
/**
*
* The ID of the folder.
*
*
* @return The ID of the folder.
*/
public final String folderId() {
return folderId;
}
/**
*
* The display name of the folder.
*
*
* @return The display name of the folder.
*/
public final String name() {
return name;
}
/**
*
* The type of folder.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #folderType} will
* return {@link FolderType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #folderTypeAsString}.
*
*
* @return The type of folder.
* @see FolderType
*/
public final FolderType folderType() {
return FolderType.fromValue(folderType);
}
/**
*
* The type of folder.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #folderType} will
* return {@link FolderType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #folderTypeAsString}.
*
*
* @return The type of folder.
* @see FolderType
*/
public final String folderTypeAsString() {
return folderType;
}
/**
*
* The time that the folder was created.
*
*
* @return The time that the folder was created.
*/
public final Instant createdTime() {
return createdTime;
}
/**
*
* The time that the folder was last updated.
*
*
* @return The time that the folder was last updated.
*/
public final Instant lastUpdatedTime() {
return lastUpdatedTime;
}
/**
*
* The sharing scope of the folder.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sharingModel} will
* return {@link SharingModel#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sharingModelAsString}.
*
*
* @return The sharing scope of the folder.
* @see SharingModel
*/
public final SharingModel sharingModel() {
return SharingModel.fromValue(sharingModel);
}
/**
*
* The sharing scope of the folder.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sharingModel} will
* return {@link SharingModel#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #sharingModelAsString}.
*
*
* @return The sharing scope of the folder.
* @see SharingModel
*/
public final String sharingModelAsString() {
return sharingModel;
}
@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 + Objects.hashCode(arn());
hashCode = 31 * hashCode + Objects.hashCode(folderId());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(folderTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(createdTime());
hashCode = 31 * hashCode + Objects.hashCode(lastUpdatedTime());
hashCode = 31 * hashCode + Objects.hashCode(sharingModelAsString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof FolderSummary)) {
return false;
}
FolderSummary other = (FolderSummary) obj;
return Objects.equals(arn(), other.arn()) && Objects.equals(folderId(), other.folderId())
&& Objects.equals(name(), other.name()) && Objects.equals(folderTypeAsString(), other.folderTypeAsString())
&& Objects.equals(createdTime(), other.createdTime())
&& Objects.equals(lastUpdatedTime(), other.lastUpdatedTime())
&& Objects.equals(sharingModelAsString(), other.sharingModelAsString());
}
/**
* 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("FolderSummary").add("Arn", arn()).add("FolderId", folderId()).add("Name", name())
.add("FolderType", folderTypeAsString()).add("CreatedTime", createdTime())
.add("LastUpdatedTime", lastUpdatedTime()).add("SharingModel", sharingModelAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Arn":
return Optional.ofNullable(clazz.cast(arn()));
case "FolderId":
return Optional.ofNullable(clazz.cast(folderId()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "FolderType":
return Optional.ofNullable(clazz.cast(folderTypeAsString()));
case "CreatedTime":
return Optional.ofNullable(clazz.cast(createdTime()));
case "LastUpdatedTime":
return Optional.ofNullable(clazz.cast(lastUpdatedTime()));
case "SharingModel":
return Optional.ofNullable(clazz.cast(sharingModelAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((FolderSummary) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The Amazon Resource Name (ARN) of the folder.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the folder.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
* The ID of the folder.
*
*
* @param folderId
* The ID of the folder.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder folderId(String folderId);
/**
*
* The display name of the folder.
*
*
* @param name
* The display name of the folder.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The type of folder.
*
*
* @param folderType
* The type of folder.
* @see FolderType
* @return Returns a reference to this object so that method calls can be chained together.
* @see FolderType
*/
Builder folderType(String folderType);
/**
*
* The type of folder.
*
*
* @param folderType
* The type of folder.
* @see FolderType
* @return Returns a reference to this object so that method calls can be chained together.
* @see FolderType
*/
Builder folderType(FolderType folderType);
/**
*
* The time that the folder was created.
*
*
* @param createdTime
* The time that the folder was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder createdTime(Instant createdTime);
/**
*
* The time that the folder was last updated.
*
*
* @param lastUpdatedTime
* The time that the folder was last updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder lastUpdatedTime(Instant lastUpdatedTime);
/**
*
* The sharing scope of the folder.
*
*
* @param sharingModel
* The sharing scope of the folder.
* @see SharingModel
* @return Returns a reference to this object so that method calls can be chained together.
* @see SharingModel
*/
Builder sharingModel(String sharingModel);
/**
*
* The sharing scope of the folder.
*
*
* @param sharingModel
* The sharing scope of the folder.
* @see SharingModel
* @return Returns a reference to this object so that method calls can be chained together.
* @see SharingModel
*/
Builder sharingModel(SharingModel sharingModel);
}
static final class BuilderImpl implements Builder {
private String arn;
private String folderId;
private String name;
private String folderType;
private Instant createdTime;
private Instant lastUpdatedTime;
private String sharingModel;
private BuilderImpl() {
}
private BuilderImpl(FolderSummary model) {
arn(model.arn);
folderId(model.folderId);
name(model.name);
folderType(model.folderType);
createdTime(model.createdTime);
lastUpdatedTime(model.lastUpdatedTime);
sharingModel(model.sharingModel);
}
public final String getArn() {
return arn;
}
public final void setArn(String arn) {
this.arn = arn;
}
@Override
public final Builder arn(String arn) {
this.arn = arn;
return this;
}
public final String getFolderId() {
return folderId;
}
public final void setFolderId(String folderId) {
this.folderId = folderId;
}
@Override
public final Builder folderId(String folderId) {
this.folderId = folderId;
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getFolderType() {
return folderType;
}
public final void setFolderType(String folderType) {
this.folderType = folderType;
}
@Override
public final Builder folderType(String folderType) {
this.folderType = folderType;
return this;
}
@Override
public final Builder folderType(FolderType folderType) {
this.folderType(folderType == null ? null : folderType.toString());
return this;
}
public final Instant getCreatedTime() {
return createdTime;
}
public final void setCreatedTime(Instant createdTime) {
this.createdTime = createdTime;
}
@Override
public final Builder createdTime(Instant createdTime) {
this.createdTime = createdTime;
return this;
}
public final Instant getLastUpdatedTime() {
return lastUpdatedTime;
}
public final void setLastUpdatedTime(Instant lastUpdatedTime) {
this.lastUpdatedTime = lastUpdatedTime;
}
@Override
public final Builder lastUpdatedTime(Instant lastUpdatedTime) {
this.lastUpdatedTime = lastUpdatedTime;
return this;
}
public final String getSharingModel() {
return sharingModel;
}
public final void setSharingModel(String sharingModel) {
this.sharingModel = sharingModel;
}
@Override
public final Builder sharingModel(String sharingModel) {
this.sharingModel = sharingModel;
return this;
}
@Override
public final Builder sharingModel(SharingModel sharingModel) {
this.sharingModel(sharingModel == null ? null : sharingModel.toString());
return this;
}
@Override
public FolderSummary build() {
return new FolderSummary(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}