software.amazon.awssdk.services.workdocs.model.DescribeDocumentVersionsResponse Maven / Gradle / Ivy
Show all versions of workdocs Show documentation
/*
* 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.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
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 DescribeDocumentVersionsResponse extends WorkDocsResponse implements
ToCopyableBuilder {
private static final SdkField> DOCUMENT_VERSIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("DocumentVersions")
.getter(getter(DescribeDocumentVersionsResponse::documentVersions))
.setter(setter(Builder::documentVersions))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DocumentVersions").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(DocumentVersionMetadata::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField MARKER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Marker")
.getter(getter(DescribeDocumentVersionsResponse::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DOCUMENT_VERSIONS_FIELD,
MARKER_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final List documentVersions;
private final String marker;
private DescribeDocumentVersionsResponse(BuilderImpl builder) {
super(builder);
this.documentVersions = builder.documentVersions;
this.marker = builder.marker;
}
/**
* For responses, this returns true if the service returned a value for the DocumentVersions property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasDocumentVersions() {
return documentVersions != null && !(documentVersions instanceof SdkAutoConstructList);
}
/**
*
* The document versions.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasDocumentVersions} method.
*
*
* @return The document versions.
*/
public final List documentVersions() {
return documentVersions;
}
/**
*
* The marker to use when requesting the next set of results. If there are no additional results, the string is
* empty.
*
*
* @return The marker to use when requesting the next set of results. If there are no additional results, the string
* is empty.
*/
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(hasDocumentVersions() ? documentVersions() : null);
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 DescribeDocumentVersionsResponse)) {
return false;
}
DescribeDocumentVersionsResponse other = (DescribeDocumentVersionsResponse) obj;
return hasDocumentVersions() == other.hasDocumentVersions()
&& Objects.equals(documentVersions(), other.documentVersions()) && 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("DescribeDocumentVersionsResponse")
.add("DocumentVersions", hasDocumentVersions() ? documentVersions() : null).add("Marker", marker()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DocumentVersions":
return Optional.ofNullable(clazz.cast(documentVersions()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("DocumentVersions", DOCUMENT_VERSIONS_FIELD);
map.put("Marker", MARKER_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeDocumentVersionsResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends WorkDocsResponse.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The document versions.
*
*
* @param documentVersions
* The document versions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder documentVersions(Collection documentVersions);
/**
*
* The document versions.
*
*
* @param documentVersions
* The document versions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder documentVersions(DocumentVersionMetadata... documentVersions);
/**
*
* The document versions.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.workdocs.model.DocumentVersionMetadata.Builder} avoiding the need to
* create one manually via
* {@link software.amazon.awssdk.services.workdocs.model.DocumentVersionMetadata#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.workdocs.model.DocumentVersionMetadata.Builder#build()} is called
* immediately and its result is passed to {@link #documentVersions(List)}.
*
* @param documentVersions
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.workdocs.model.DocumentVersionMetadata.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #documentVersions(java.util.Collection)
*/
Builder documentVersions(Consumer... documentVersions);
/**
*
* The marker to use when requesting the next set of results. If there are no additional results, the string is
* empty.
*
*
* @param marker
* The marker to use when requesting the next set of results. If there are no additional results, the
* string is empty.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder marker(String marker);
}
static final class BuilderImpl extends WorkDocsResponse.BuilderImpl implements Builder {
private List documentVersions = DefaultSdkAutoConstructList.getInstance();
private String marker;
private BuilderImpl() {
}
private BuilderImpl(DescribeDocumentVersionsResponse model) {
super(model);
documentVersions(model.documentVersions);
marker(model.marker);
}
public final List getDocumentVersions() {
List result = DocumentVersionMetadataListCopier.copyToBuilder(this.documentVersions);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setDocumentVersions(Collection documentVersions) {
this.documentVersions = DocumentVersionMetadataListCopier.copyFromBuilder(documentVersions);
}
@Override
public final Builder documentVersions(Collection documentVersions) {
this.documentVersions = DocumentVersionMetadataListCopier.copy(documentVersions);
return this;
}
@Override
@SafeVarargs
public final Builder documentVersions(DocumentVersionMetadata... documentVersions) {
documentVersions(Arrays.asList(documentVersions));
return this;
}
@Override
@SafeVarargs
public final Builder documentVersions(Consumer... documentVersions) {
documentVersions(Stream.of(documentVersions).map(c -> DocumentVersionMetadata.builder().applyMutation(c).build())
.collect(Collectors.toList()));
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 DescribeDocumentVersionsResponse build() {
return new DescribeDocumentVersionsResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}