software.amazon.awssdk.services.workdocs.model.GetFolderRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of workdocs Show documentation
Show all versions of workdocs Show documentation
The AWS Java SDK for Amazon WorkDocs module holds the client classes that are used for
communicating with Amazon WorkDocs Service.
/*
* 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.workdocs.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 GetFolderRequest extends WorkDocsRequest implements
ToCopyableBuilder {
private static final SdkField AUTHENTICATION_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AuthenticationToken").getter(getter(GetFolderRequest::authenticationToken))
.setter(setter(Builder::authenticationToken))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("Authentication").build()).build();
private static final SdkField FOLDER_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("FolderId").getter(getter(GetFolderRequest::folderId)).setter(setter(Builder::folderId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("FolderId").build()).build();
private static final SdkField INCLUDE_CUSTOM_METADATA_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("IncludeCustomMetadata").getter(getter(GetFolderRequest::includeCustomMetadata))
.setter(setter(Builder::includeCustomMetadata))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("includeCustomMetadata").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(AUTHENTICATION_TOKEN_FIELD,
FOLDER_ID_FIELD, INCLUDE_CUSTOM_METADATA_FIELD));
private final String authenticationToken;
private final String folderId;
private final Boolean includeCustomMetadata;
private GetFolderRequest(BuilderImpl builder) {
super(builder);
this.authenticationToken = builder.authenticationToken;
this.folderId = builder.folderId;
this.includeCustomMetadata = builder.includeCustomMetadata;
}
/**
*
* Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to
* access the API.
*
*
* @return Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator
* credentials to access the API.
*/
public final String authenticationToken() {
return authenticationToken;
}
/**
*
* The ID of the folder.
*
*
* @return The ID of the folder.
*/
public final String folderId() {
return folderId;
}
/**
*
* Set to TRUE to include custom metadata in the response.
*
*
* @return Set to TRUE to include custom metadata in the response.
*/
public final Boolean includeCustomMetadata() {
return includeCustomMetadata;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(authenticationToken());
hashCode = 31 * hashCode + Objects.hashCode(folderId());
hashCode = 31 * hashCode + Objects.hashCode(includeCustomMetadata());
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 GetFolderRequest)) {
return false;
}
GetFolderRequest other = (GetFolderRequest) obj;
return Objects.equals(authenticationToken(), other.authenticationToken()) && Objects.equals(folderId(), other.folderId())
&& Objects.equals(includeCustomMetadata(), other.includeCustomMetadata());
}
/**
* 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("GetFolderRequest")
.add("AuthenticationToken", authenticationToken() == null ? null : "*** Sensitive Data Redacted ***")
.add("FolderId", folderId()).add("IncludeCustomMetadata", includeCustomMetadata()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AuthenticationToken":
return Optional.ofNullable(clazz.cast(authenticationToken()));
case "FolderId":
return Optional.ofNullable(clazz.cast(folderId()));
case "IncludeCustomMetadata":
return Optional.ofNullable(clazz.cast(includeCustomMetadata()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function
© 2015 - 2025 Weber Informatics LLC | Privacy Policy