com.amazonaws.services.honeycode.model.GetScreenDataResult Maven / Gradle / Ivy
/*
* Copyright 2017-2022 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 com.amazonaws.services.honeycode.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetScreenDataResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* A map of all the rows on the screen keyed by block name.
*
*/
private java.util.Map results;
/**
*
* Indicates the cursor of the workbook at which the data returned by this workbook is read. Workbook cursor keeps
* increasing with every update and the increments are not sequential.
*
*/
private Long workbookCursor;
/**
*
* Provides the pagination token to load the next page if there are more results matching the request. If a
* pagination token is not present in the response, it means that all data matching the query has been loaded.
*
*/
private String nextToken;
/**
*
* A map of all the rows on the screen keyed by block name.
*
*
* @return A map of all the rows on the screen keyed by block name.
*/
public java.util.Map getResults() {
return results;
}
/**
*
* A map of all the rows on the screen keyed by block name.
*
*
* @param results
* A map of all the rows on the screen keyed by block name.
*/
public void setResults(java.util.Map results) {
this.results = results;
}
/**
*
* A map of all the rows on the screen keyed by block name.
*
*
* @param results
* A map of all the rows on the screen keyed by block name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetScreenDataResult withResults(java.util.Map results) {
setResults(results);
return this;
}
/**
* Add a single Results entry
*
* @see GetScreenDataResult#withResults
* @returns a reference to this object so that method calls can be chained together.
*/
public GetScreenDataResult addResultsEntry(String key, ResultSet value) {
if (null == this.results) {
this.results = new java.util.HashMap();
}
if (this.results.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.results.put(key, value);
return this;
}
/**
* Removes all the entries added into Results.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetScreenDataResult clearResultsEntries() {
this.results = null;
return this;
}
/**
*
* Indicates the cursor of the workbook at which the data returned by this workbook is read. Workbook cursor keeps
* increasing with every update and the increments are not sequential.
*
*
* @param workbookCursor
* Indicates the cursor of the workbook at which the data returned by this workbook is read. Workbook cursor
* keeps increasing with every update and the increments are not sequential.
*/
public void setWorkbookCursor(Long workbookCursor) {
this.workbookCursor = workbookCursor;
}
/**
*
* Indicates the cursor of the workbook at which the data returned by this workbook is read. Workbook cursor keeps
* increasing with every update and the increments are not sequential.
*
*
* @return Indicates the cursor of the workbook at which the data returned by this workbook is read. Workbook cursor
* keeps increasing with every update and the increments are not sequential.
*/
public Long getWorkbookCursor() {
return this.workbookCursor;
}
/**
*
* Indicates the cursor of the workbook at which the data returned by this workbook is read. Workbook cursor keeps
* increasing with every update and the increments are not sequential.
*
*
* @param workbookCursor
* Indicates the cursor of the workbook at which the data returned by this workbook is read. Workbook cursor
* keeps increasing with every update and the increments are not sequential.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetScreenDataResult withWorkbookCursor(Long workbookCursor) {
setWorkbookCursor(workbookCursor);
return this;
}
/**
*
* Provides the pagination token to load the next page if there are more results matching the request. If a
* pagination token is not present in the response, it means that all data matching the query has been loaded.
*
*
* @param nextToken
* Provides the pagination token to load the next page if there are more results matching the request. If a
* pagination token is not present in the response, it means that all data matching the query has been
* loaded.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* Provides the pagination token to load the next page if there are more results matching the request. If a
* pagination token is not present in the response, it means that all data matching the query has been loaded.
*
*
* @return Provides the pagination token to load the next page if there are more results matching the request. If a
* pagination token is not present in the response, it means that all data matching the query has been
* loaded.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* Provides the pagination token to load the next page if there are more results matching the request. If a
* pagination token is not present in the response, it means that all data matching the query has been loaded.
*
*
* @param nextToken
* Provides the pagination token to load the next page if there are more results matching the request. If a
* pagination token is not present in the response, it means that all data matching the query has been
* loaded.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetScreenDataResult withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getResults() != null)
sb.append("Results: ").append("***Sensitive Data Redacted***").append(",");
if (getWorkbookCursor() != null)
sb.append("WorkbookCursor: ").append(getWorkbookCursor()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetScreenDataResult == false)
return false;
GetScreenDataResult other = (GetScreenDataResult) obj;
if (other.getResults() == null ^ this.getResults() == null)
return false;
if (other.getResults() != null && other.getResults().equals(this.getResults()) == false)
return false;
if (other.getWorkbookCursor() == null ^ this.getWorkbookCursor() == null)
return false;
if (other.getWorkbookCursor() != null && other.getWorkbookCursor().equals(this.getWorkbookCursor()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getResults() == null) ? 0 : getResults().hashCode());
hashCode = prime * hashCode + ((getWorkbookCursor() == null) ? 0 : getWorkbookCursor().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public GetScreenDataResult clone() {
try {
return (GetScreenDataResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}