software.amazon.awssdk.services.qbusiness.model.ListDocumentsResponse Maven / Gradle / Ivy
Show all versions of qbusiness 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.qbusiness.model;
import java.util.Arrays;
import java.util.Collection;
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 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 ListDocumentsResponse extends QBusinessResponse implements
ToCopyableBuilder {
private static final SdkField> DOCUMENT_DETAIL_LIST_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("documentDetailList")
.getter(getter(ListDocumentsResponse::documentDetailList))
.setter(setter(Builder::documentDetailList))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("documentDetailList").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(DocumentDetails::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("nextToken").getter(getter(ListDocumentsResponse::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("nextToken").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DOCUMENT_DETAIL_LIST_FIELD,
NEXT_TOKEN_FIELD));
private final List documentDetailList;
private final String nextToken;
private ListDocumentsResponse(BuilderImpl builder) {
super(builder);
this.documentDetailList = builder.documentDetailList;
this.nextToken = builder.nextToken;
}
/**
* For responses, this returns true if the service returned a value for the DocumentDetailList 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 hasDocumentDetailList() {
return documentDetailList != null && !(documentDetailList instanceof SdkAutoConstructList);
}
/**
*
* A list of document details.
*
*
* 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 #hasDocumentDetailList} method.
*
*
* @return A list of document details.
*/
public final List documentDetailList() {
return documentDetailList;
}
/**
*
* If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business
* returns a pagination token in the response. You can use this pagination token to retrieve the next set of
* documents.
*
*
* @return If the maxResults response was incomplete because there is more data to retrieve, Amazon Q
* Business returns a pagination token in the response. You can use this pagination token to retrieve the
* next set of documents.
*/
public final String nextToken() {
return nextToken;
}
@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(hasDocumentDetailList() ? documentDetailList() : null);
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
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 ListDocumentsResponse)) {
return false;
}
ListDocumentsResponse other = (ListDocumentsResponse) obj;
return hasDocumentDetailList() == other.hasDocumentDetailList()
&& Objects.equals(documentDetailList(), other.documentDetailList())
&& Objects.equals(nextToken(), other.nextToken());
}
/**
* 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("ListDocumentsResponse")
.add("DocumentDetailList", hasDocumentDetailList() ? documentDetailList() : null).add("NextToken", nextToken())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "documentDetailList":
return Optional.ofNullable(clazz.cast(documentDetailList()));
case "nextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListDocumentsResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends QBusinessResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* A list of document details.
*
*
* @param documentDetailList
* A list of document details.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder documentDetailList(Collection documentDetailList);
/**
*
* A list of document details.
*
*
* @param documentDetailList
* A list of document details.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder documentDetailList(DocumentDetails... documentDetailList);
/**
*
* A list of document details.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.qbusiness.model.DocumentDetails.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.qbusiness.model.DocumentDetails#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.qbusiness.model.DocumentDetails.Builder#build()} is called immediately
* and its result is passed to {@link #documentDetailList(List)}.
*
* @param documentDetailList
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.qbusiness.model.DocumentDetails.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #documentDetailList(java.util.Collection)
*/
Builder documentDetailList(Consumer... documentDetailList);
/**
*
* If the maxResults response was incomplete because there is more data to retrieve, Amazon Q
* Business returns a pagination token in the response. You can use this pagination token to retrieve the next
* set of documents.
*
*
* @param nextToken
* If the maxResults response was incomplete because there is more data to retrieve, Amazon
* Q Business returns a pagination token in the response. You can use this pagination token to retrieve
* the next set of documents.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
}
static final class BuilderImpl extends QBusinessResponse.BuilderImpl implements Builder {
private List documentDetailList = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(ListDocumentsResponse model) {
super(model);
documentDetailList(model.documentDetailList);
nextToken(model.nextToken);
}
public final List getDocumentDetailList() {
List result = DocumentDetailListCopier.copyToBuilder(this.documentDetailList);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setDocumentDetailList(Collection documentDetailList) {
this.documentDetailList = DocumentDetailListCopier.copyFromBuilder(documentDetailList);
}
@Override
public final Builder documentDetailList(Collection documentDetailList) {
this.documentDetailList = DocumentDetailListCopier.copy(documentDetailList);
return this;
}
@Override
@SafeVarargs
public final Builder documentDetailList(DocumentDetails... documentDetailList) {
documentDetailList(Arrays.asList(documentDetailList));
return this;
}
@Override
@SafeVarargs
public final Builder documentDetailList(Consumer... documentDetailList) {
documentDetailList(Stream.of(documentDetailList).map(c -> DocumentDetails.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
@Override
public ListDocumentsResponse build() {
return new ListDocumentsResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}