software.amazon.awssdk.services.workdocs.model.GetFolderPathRequest 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 GetFolderPathRequest extends WorkDocsRequest implements
ToCopyableBuilder {
private static final SdkField AUTHENTICATION_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AuthenticationToken").getter(getter(GetFolderPathRequest::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(GetFolderPathRequest::folderId)).setter(setter(Builder::folderId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("FolderId").build()).build();
private static final SdkField LIMIT_FIELD = SdkField. builder(MarshallingType.INTEGER).memberName("Limit")
.getter(getter(GetFolderPathRequest::limit)).setter(setter(Builder::limit))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("limit").build()).build();
private static final SdkField FIELDS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Fields")
.getter(getter(GetFolderPathRequest::fields)).setter(setter(Builder::fields))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("fields").build()).build();
private static final SdkField MARKER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Marker")
.getter(getter(GetFolderPathRequest::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("marker").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(AUTHENTICATION_TOKEN_FIELD,
FOLDER_ID_FIELD, LIMIT_FIELD, FIELDS_FIELD, MARKER_FIELD));
private final String authenticationToken;
private final String folderId;
private final Integer limit;
private final String fields;
private final String marker;
private GetFolderPathRequest(BuilderImpl builder) {
super(builder);
this.authenticationToken = builder.authenticationToken;
this.folderId = builder.folderId;
this.limit = builder.limit;
this.fields = builder.fields;
this.marker = builder.marker;
}
/**
*
* 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;
}
/**
*
* The maximum number of levels in the hierarchy to return.
*
*
* @return The maximum number of levels in the hierarchy to return.
*/
public final Integer limit() {
return limit;
}
/**
*
* A comma-separated list of values. Specify "NAME" to include the names of the parent folders.
*
*
* @return A comma-separated list of values. Specify "NAME" to include the names of the parent folders.
*/
public final String fields() {
return fields;
}
/**
*
* This value is not supported.
*
*
* @return This value is not supported.
*/
public final String marker() {
return marker;
}
@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(authenticationToken());
hashCode = 31 * hashCode + Objects.hashCode(folderId());
hashCode = 31 * hashCode + Objects.hashCode(limit());
hashCode = 31 * hashCode + Objects.hashCode(fields());
hashCode = 31 * hashCode + Objects.hashCode(marker());
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 GetFolderPathRequest)) {
return false;
}
GetFolderPathRequest other = (GetFolderPathRequest) obj;
return Objects.equals(authenticationToken(), other.authenticationToken()) && Objects.equals(folderId(), other.folderId())
&& Objects.equals(limit(), other.limit()) && Objects.equals(fields(), other.fields())
&& Objects.equals(marker(), other.marker());
}
/**
* 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("GetFolderPathRequest")
.add("AuthenticationToken", authenticationToken() == null ? null : "*** Sensitive Data Redacted ***")
.add("FolderId", folderId()).add("Limit", limit()).add("Fields", fields()).add("Marker", marker()).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 "Limit":
return Optional.ofNullable(clazz.cast(limit()));
case "Fields":
return Optional.ofNullable(clazz.cast(fields()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetFolderPathRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends WorkDocsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials
* to access the API.
*
*
* @param authenticationToken
* Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator
* credentials to access the API.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder authenticationToken(String authenticationToken);
/**
*
* 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 maximum number of levels in the hierarchy to return.
*
*
* @param limit
* The maximum number of levels in the hierarchy to return.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder limit(Integer limit);
/**
*
* A comma-separated list of values. Specify "NAME" to include the names of the parent folders.
*
*
* @param fields
* A comma-separated list of values. Specify "NAME" to include the names of the parent folders.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder fields(String fields);
/**
*
* This value is not supported.
*
*
* @param marker
* This value is not supported.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder marker(String marker);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends WorkDocsRequest.BuilderImpl implements Builder {
private String authenticationToken;
private String folderId;
private Integer limit;
private String fields;
private String marker;
private BuilderImpl() {
}
private BuilderImpl(GetFolderPathRequest model) {
super(model);
authenticationToken(model.authenticationToken);
folderId(model.folderId);
limit(model.limit);
fields(model.fields);
marker(model.marker);
}
public final String getAuthenticationToken() {
return authenticationToken;
}
public final void setAuthenticationToken(String authenticationToken) {
this.authenticationToken = authenticationToken;
}
@Override
public final Builder authenticationToken(String authenticationToken) {
this.authenticationToken = authenticationToken;
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 Integer getLimit() {
return limit;
}
public final void setLimit(Integer limit) {
this.limit = limit;
}
@Override
public final Builder limit(Integer limit) {
this.limit = limit;
return this;
}
public final String getFields() {
return fields;
}
public final void setFields(String fields) {
this.fields = fields;
}
@Override
public final Builder fields(String fields) {
this.fields = fields;
return this;
}
public final String getMarker() {
return marker;
}
public final void setMarker(String marker) {
this.marker = marker;
}
@Override
public final Builder marker(String marker) {
this.marker = marker;
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 GetFolderPathRequest build() {
return new GetFolderPathRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy