com.amazonaws.services.pinpointsmsvoicev2.model.DescribeRegistrationFieldDefinitionsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-pinpointsmsvoicev2 Show documentation
/*
* Copyright 2019-2024 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.pinpointsmsvoicev2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeRegistrationFieldDefinitionsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The type of registration form. The list of RegistrationTypes can be found using the
* DescribeRegistrationTypeDefinitions action.
*
*/
private String registrationType;
/**
*
* The path to the section of the registration.
*
*/
private String sectionPath;
/**
*
* An array of paths to the registration form field.
*
*/
private java.util.List fieldPaths;
/**
*
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in
* the initial request.
*
*/
private String nextToken;
/**
*
* The maximum number of results to return per each request.
*
*/
private Integer maxResults;
/**
*
* The type of registration form. The list of RegistrationTypes can be found using the
* DescribeRegistrationTypeDefinitions action.
*
*
* @param registrationType
* The type of registration form. The list of RegistrationTypes can be found using the
* DescribeRegistrationTypeDefinitions action.
*/
public void setRegistrationType(String registrationType) {
this.registrationType = registrationType;
}
/**
*
* The type of registration form. The list of RegistrationTypes can be found using the
* DescribeRegistrationTypeDefinitions action.
*
*
* @return The type of registration form. The list of RegistrationTypes can be found using the
* DescribeRegistrationTypeDefinitions action.
*/
public String getRegistrationType() {
return this.registrationType;
}
/**
*
* The type of registration form. The list of RegistrationTypes can be found using the
* DescribeRegistrationTypeDefinitions action.
*
*
* @param registrationType
* The type of registration form. The list of RegistrationTypes can be found using the
* DescribeRegistrationTypeDefinitions action.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRegistrationFieldDefinitionsRequest withRegistrationType(String registrationType) {
setRegistrationType(registrationType);
return this;
}
/**
*
* The path to the section of the registration.
*
*
* @param sectionPath
* The path to the section of the registration.
*/
public void setSectionPath(String sectionPath) {
this.sectionPath = sectionPath;
}
/**
*
* The path to the section of the registration.
*
*
* @return The path to the section of the registration.
*/
public String getSectionPath() {
return this.sectionPath;
}
/**
*
* The path to the section of the registration.
*
*
* @param sectionPath
* The path to the section of the registration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRegistrationFieldDefinitionsRequest withSectionPath(String sectionPath) {
setSectionPath(sectionPath);
return this;
}
/**
*
* An array of paths to the registration form field.
*
*
* @return An array of paths to the registration form field.
*/
public java.util.List getFieldPaths() {
return fieldPaths;
}
/**
*
* An array of paths to the registration form field.
*
*
* @param fieldPaths
* An array of paths to the registration form field.
*/
public void setFieldPaths(java.util.Collection fieldPaths) {
if (fieldPaths == null) {
this.fieldPaths = null;
return;
}
this.fieldPaths = new java.util.ArrayList(fieldPaths);
}
/**
*
* An array of paths to the registration form field.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFieldPaths(java.util.Collection)} or {@link #withFieldPaths(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param fieldPaths
* An array of paths to the registration form field.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRegistrationFieldDefinitionsRequest withFieldPaths(String... fieldPaths) {
if (this.fieldPaths == null) {
setFieldPaths(new java.util.ArrayList(fieldPaths.length));
}
for (String ele : fieldPaths) {
this.fieldPaths.add(ele);
}
return this;
}
/**
*
* An array of paths to the registration form field.
*
*
* @param fieldPaths
* An array of paths to the registration form field.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRegistrationFieldDefinitionsRequest withFieldPaths(java.util.Collection fieldPaths) {
setFieldPaths(fieldPaths);
return this;
}
/**
*
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in
* the initial request.
*
*
* @param nextToken
* The token to be used for the next set of paginated results. You don't need to supply a value for this
* field in the initial request.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in
* the initial request.
*
*
* @return The token to be used for the next set of paginated results. You don't need to supply a value for this
* field in the initial request.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The token to be used for the next set of paginated results. You don't need to supply a value for this field in
* the initial request.
*
*
* @param nextToken
* The token to be used for the next set of paginated results. You don't need to supply a value for this
* field in the initial request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRegistrationFieldDefinitionsRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of results to return per each request.
*
*
* @param maxResults
* The maximum number of results to return per each request.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of results to return per each request.
*
*
* @return The maximum number of results to return per each request.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of results to return per each request.
*
*
* @param maxResults
* The maximum number of results to return per each request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeRegistrationFieldDefinitionsRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
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 (getRegistrationType() != null)
sb.append("RegistrationType: ").append(getRegistrationType()).append(",");
if (getSectionPath() != null)
sb.append("SectionPath: ").append(getSectionPath()).append(",");
if (getFieldPaths() != null)
sb.append("FieldPaths: ").append(getFieldPaths()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeRegistrationFieldDefinitionsRequest == false)
return false;
DescribeRegistrationFieldDefinitionsRequest other = (DescribeRegistrationFieldDefinitionsRequest) obj;
if (other.getRegistrationType() == null ^ this.getRegistrationType() == null)
return false;
if (other.getRegistrationType() != null && other.getRegistrationType().equals(this.getRegistrationType()) == false)
return false;
if (other.getSectionPath() == null ^ this.getSectionPath() == null)
return false;
if (other.getSectionPath() != null && other.getSectionPath().equals(this.getSectionPath()) == false)
return false;
if (other.getFieldPaths() == null ^ this.getFieldPaths() == null)
return false;
if (other.getFieldPaths() != null && other.getFieldPaths().equals(this.getFieldPaths()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getRegistrationType() == null) ? 0 : getRegistrationType().hashCode());
hashCode = prime * hashCode + ((getSectionPath() == null) ? 0 : getSectionPath().hashCode());
hashCode = prime * hashCode + ((getFieldPaths() == null) ? 0 : getFieldPaths().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
return hashCode;
}
@Override
public DescribeRegistrationFieldDefinitionsRequest clone() {
return (DescribeRegistrationFieldDefinitionsRequest) super.clone();
}
}