software.amazon.awssdk.services.honeycode.model.ListTableRowsRequest Maven / Gradle / Ivy
/*
* 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.honeycode.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 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.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 ListTableRowsRequest extends HoneycodeRequest implements
ToCopyableBuilder {
private static final SdkField WORKBOOK_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("workbookId").getter(getter(ListTableRowsRequest::workbookId)).setter(setter(Builder::workbookId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("workbookId").build()).build();
private static final SdkField TABLE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("tableId").getter(getter(ListTableRowsRequest::tableId)).setter(setter(Builder::tableId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("tableId").build()).build();
private static final SdkField> ROW_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("rowIds")
.getter(getter(ListTableRowsRequest::rowIds))
.setter(setter(Builder::rowIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("rowIds").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("maxResults").getter(getter(ListTableRowsRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("maxResults").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("nextToken").getter(getter(ListTableRowsRequest::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(WORKBOOK_ID_FIELD,
TABLE_ID_FIELD, ROW_IDS_FIELD, MAX_RESULTS_FIELD, NEXT_TOKEN_FIELD));
private final String workbookId;
private final String tableId;
private final List rowIds;
private final Integer maxResults;
private final String nextToken;
private ListTableRowsRequest(BuilderImpl builder) {
super(builder);
this.workbookId = builder.workbookId;
this.tableId = builder.tableId;
this.rowIds = builder.rowIds;
this.maxResults = builder.maxResults;
this.nextToken = builder.nextToken;
}
/**
*
* The ID of the workbook that contains the table whose rows are being retrieved.
*
*
* If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
*
*
* @return The ID of the workbook that contains the table whose rows are being retrieved.
*
* If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
*/
public final String workbookId() {
return workbookId;
}
/**
*
* The ID of the table whose rows are being retrieved.
*
*
* If a table with the specified id could not be found, this API throws ResourceNotFoundException.
*
*
* @return The ID of the table whose rows are being retrieved.
*
* If a table with the specified id could not be found, this API throws ResourceNotFoundException.
*/
public final String tableId() {
return tableId;
}
/**
* For responses, this returns true if the service returned a value for the RowIds 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 hasRowIds() {
return rowIds != null && !(rowIds instanceof SdkAutoConstructList);
}
/**
*
* This parameter is optional. If one or more row ids are specified in this list, then only the specified row ids
* are returned in the result. If no row ids are specified here, then all the rows in the table are returned.
*
*
* 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 #hasRowIds} method.
*
*
* @return This parameter is optional. If one or more row ids are specified in this list, then only the specified
* row ids are returned in the result. If no row ids are specified here, then all the rows in the table are
* returned.
*/
public final List rowIds() {
return rowIds;
}
/**
*
* The maximum number of rows to return in each page of the results.
*
*
* @return The maximum number of rows to return in each page of the results.
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* This parameter is optional. If a nextToken is not specified, the API returns the first page of data.
*
*
* Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will
* throw ValidationException.
*
*
* @return This parameter is optional. If a nextToken is not specified, the API returns the first page of data.
*
* Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the
* API will throw ValidationException.
*/
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(workbookId());
hashCode = 31 * hashCode + Objects.hashCode(tableId());
hashCode = 31 * hashCode + Objects.hashCode(hasRowIds() ? rowIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
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 ListTableRowsRequest)) {
return false;
}
ListTableRowsRequest other = (ListTableRowsRequest) obj;
return Objects.equals(workbookId(), other.workbookId()) && Objects.equals(tableId(), other.tableId())
&& hasRowIds() == other.hasRowIds() && Objects.equals(rowIds(), other.rowIds())
&& Objects.equals(maxResults(), other.maxResults()) && 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("ListTableRowsRequest").add("WorkbookId", workbookId()).add("TableId", tableId())
.add("RowIds", hasRowIds() ? rowIds() : null).add("MaxResults", maxResults()).add("NextToken", nextToken())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "workbookId":
return Optional.ofNullable(clazz.cast(workbookId()));
case "tableId":
return Optional.ofNullable(clazz.cast(tableId()));
case "rowIds":
return Optional.ofNullable(clazz.cast(rowIds()));
case "maxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
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((ListTableRowsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends HoneycodeRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The ID of the workbook that contains the table whose rows are being retrieved.
*
*
* If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
*
*
* @param workbookId
* The ID of the workbook that contains the table whose rows are being retrieved.
*
* If a workbook with the specified id could not be found, this API throws ResourceNotFoundException.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder workbookId(String workbookId);
/**
*
* The ID of the table whose rows are being retrieved.
*
*
* If a table with the specified id could not be found, this API throws ResourceNotFoundException.
*
*
* @param tableId
* The ID of the table whose rows are being retrieved.
*
* If a table with the specified id could not be found, this API throws ResourceNotFoundException.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tableId(String tableId);
/**
*
* This parameter is optional. If one or more row ids are specified in this list, then only the specified row
* ids are returned in the result. If no row ids are specified here, then all the rows in the table are
* returned.
*
*
* @param rowIds
* This parameter is optional. If one or more row ids are specified in this list, then only the specified
* row ids are returned in the result. If no row ids are specified here, then all the rows in the table
* are returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder rowIds(Collection rowIds);
/**
*
* This parameter is optional. If one or more row ids are specified in this list, then only the specified row
* ids are returned in the result. If no row ids are specified here, then all the rows in the table are
* returned.
*
*
* @param rowIds
* This parameter is optional. If one or more row ids are specified in this list, then only the specified
* row ids are returned in the result. If no row ids are specified here, then all the rows in the table
* are returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder rowIds(String... rowIds);
/**
*
* The maximum number of rows to return in each page of the results.
*
*
* @param maxResults
* The maximum number of rows to return in each page of the results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* This parameter is optional. If a nextToken is not specified, the API returns the first page of data.
*
*
* Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API
* will throw ValidationException.
*
*
* @param nextToken
* This parameter is optional. If a nextToken is not specified, the API returns the first page of data.
*
*
* Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back,
* the API will throw ValidationException.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends HoneycodeRequest.BuilderImpl implements Builder {
private String workbookId;
private String tableId;
private List rowIds = DefaultSdkAutoConstructList.getInstance();
private Integer maxResults;
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(ListTableRowsRequest model) {
super(model);
workbookId(model.workbookId);
tableId(model.tableId);
rowIds(model.rowIds);
maxResults(model.maxResults);
nextToken(model.nextToken);
}
public final String getWorkbookId() {
return workbookId;
}
public final void setWorkbookId(String workbookId) {
this.workbookId = workbookId;
}
@Override
public final Builder workbookId(String workbookId) {
this.workbookId = workbookId;
return this;
}
public final String getTableId() {
return tableId;
}
public final void setTableId(String tableId) {
this.tableId = tableId;
}
@Override
public final Builder tableId(String tableId) {
this.tableId = tableId;
return this;
}
public final Collection getRowIds() {
if (rowIds instanceof SdkAutoConstructList) {
return null;
}
return rowIds;
}
public final void setRowIds(Collection rowIds) {
this.rowIds = RowIdListCopier.copy(rowIds);
}
@Override
public final Builder rowIds(Collection rowIds) {
this.rowIds = RowIdListCopier.copy(rowIds);
return this;
}
@Override
@SafeVarargs
public final Builder rowIds(String... rowIds) {
rowIds(Arrays.asList(rowIds));
return this;
}
public final Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
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 Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public ListTableRowsRequest build() {
return new ListTableRowsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}