com.amazonaws.services.pinpointsmsvoicev2.model.RegistrationFieldDefinition 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.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Provides a description of the specified field.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RegistrationFieldDefinition implements Serializable, Cloneable, StructuredPojo {
/**
*
* The section path of the field.
*
*/
private String sectionPath;
/**
*
* The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of
* FieldPaths.
*
*/
private String fieldPath;
/**
*
* The type of field.
*
*/
private String fieldType;
/**
*
* Specifies if the field for the registration form is required, conditional or optional.
*
*/
private String fieldRequirement;
/**
*
* The validation rules for a select field.
*
*/
private SelectValidation selectValidation;
/**
*
* The validation rules for a text field.
*
*/
private TextValidation textValidation;
/**
*
* An array of RegistrationFieldDisplayHints objects for the field.
*
*/
private RegistrationFieldDisplayHints displayHints;
/**
*
* The section path of the field.
*
*
* @param sectionPath
* The section path of the field.
*/
public void setSectionPath(String sectionPath) {
this.sectionPath = sectionPath;
}
/**
*
* The section path of the field.
*
*
* @return The section path of the field.
*/
public String getSectionPath() {
return this.sectionPath;
}
/**
*
* The section path of the field.
*
*
* @param sectionPath
* The section path of the field.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RegistrationFieldDefinition withSectionPath(String sectionPath) {
setSectionPath(sectionPath);
return this;
}
/**
*
* The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of
* FieldPaths.
*
*
* @param fieldPath
* The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a
* list of FieldPaths.
*/
public void setFieldPath(String fieldPath) {
this.fieldPath = fieldPath;
}
/**
*
* The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of
* FieldPaths.
*
*
* @return The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a
* list of FieldPaths.
*/
public String getFieldPath() {
return this.fieldPath;
}
/**
*
* The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a list of
* FieldPaths.
*
*
* @param fieldPath
* The path to the registration form field. You can use DescribeRegistrationFieldDefinitions for a
* list of FieldPaths.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RegistrationFieldDefinition withFieldPath(String fieldPath) {
setFieldPath(fieldPath);
return this;
}
/**
*
* The type of field.
*
*
* @param fieldType
* The type of field.
* @see FieldType
*/
public void setFieldType(String fieldType) {
this.fieldType = fieldType;
}
/**
*
* The type of field.
*
*
* @return The type of field.
* @see FieldType
*/
public String getFieldType() {
return this.fieldType;
}
/**
*
* The type of field.
*
*
* @param fieldType
* The type of field.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FieldType
*/
public RegistrationFieldDefinition withFieldType(String fieldType) {
setFieldType(fieldType);
return this;
}
/**
*
* The type of field.
*
*
* @param fieldType
* The type of field.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FieldType
*/
public RegistrationFieldDefinition withFieldType(FieldType fieldType) {
this.fieldType = fieldType.toString();
return this;
}
/**
*
* Specifies if the field for the registration form is required, conditional or optional.
*
*
* @param fieldRequirement
* Specifies if the field for the registration form is required, conditional or optional.
* @see FieldRequirement
*/
public void setFieldRequirement(String fieldRequirement) {
this.fieldRequirement = fieldRequirement;
}
/**
*
* Specifies if the field for the registration form is required, conditional or optional.
*
*
* @return Specifies if the field for the registration form is required, conditional or optional.
* @see FieldRequirement
*/
public String getFieldRequirement() {
return this.fieldRequirement;
}
/**
*
* Specifies if the field for the registration form is required, conditional or optional.
*
*
* @param fieldRequirement
* Specifies if the field for the registration form is required, conditional or optional.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FieldRequirement
*/
public RegistrationFieldDefinition withFieldRequirement(String fieldRequirement) {
setFieldRequirement(fieldRequirement);
return this;
}
/**
*
* Specifies if the field for the registration form is required, conditional or optional.
*
*
* @param fieldRequirement
* Specifies if the field for the registration form is required, conditional or optional.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FieldRequirement
*/
public RegistrationFieldDefinition withFieldRequirement(FieldRequirement fieldRequirement) {
this.fieldRequirement = fieldRequirement.toString();
return this;
}
/**
*
* The validation rules for a select field.
*
*
* @param selectValidation
* The validation rules for a select field.
*/
public void setSelectValidation(SelectValidation selectValidation) {
this.selectValidation = selectValidation;
}
/**
*
* The validation rules for a select field.
*
*
* @return The validation rules for a select field.
*/
public SelectValidation getSelectValidation() {
return this.selectValidation;
}
/**
*
* The validation rules for a select field.
*
*
* @param selectValidation
* The validation rules for a select field.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RegistrationFieldDefinition withSelectValidation(SelectValidation selectValidation) {
setSelectValidation(selectValidation);
return this;
}
/**
*
* The validation rules for a text field.
*
*
* @param textValidation
* The validation rules for a text field.
*/
public void setTextValidation(TextValidation textValidation) {
this.textValidation = textValidation;
}
/**
*
* The validation rules for a text field.
*
*
* @return The validation rules for a text field.
*/
public TextValidation getTextValidation() {
return this.textValidation;
}
/**
*
* The validation rules for a text field.
*
*
* @param textValidation
* The validation rules for a text field.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RegistrationFieldDefinition withTextValidation(TextValidation textValidation) {
setTextValidation(textValidation);
return this;
}
/**
*
* An array of RegistrationFieldDisplayHints objects for the field.
*
*
* @param displayHints
* An array of RegistrationFieldDisplayHints objects for the field.
*/
public void setDisplayHints(RegistrationFieldDisplayHints displayHints) {
this.displayHints = displayHints;
}
/**
*
* An array of RegistrationFieldDisplayHints objects for the field.
*
*
* @return An array of RegistrationFieldDisplayHints objects for the field.
*/
public RegistrationFieldDisplayHints getDisplayHints() {
return this.displayHints;
}
/**
*
* An array of RegistrationFieldDisplayHints objects for the field.
*
*
* @param displayHints
* An array of RegistrationFieldDisplayHints objects for the field.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RegistrationFieldDefinition withDisplayHints(RegistrationFieldDisplayHints displayHints) {
setDisplayHints(displayHints);
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 (getSectionPath() != null)
sb.append("SectionPath: ").append(getSectionPath()).append(",");
if (getFieldPath() != null)
sb.append("FieldPath: ").append(getFieldPath()).append(",");
if (getFieldType() != null)
sb.append("FieldType: ").append(getFieldType()).append(",");
if (getFieldRequirement() != null)
sb.append("FieldRequirement: ").append(getFieldRequirement()).append(",");
if (getSelectValidation() != null)
sb.append("SelectValidation: ").append(getSelectValidation()).append(",");
if (getTextValidation() != null)
sb.append("TextValidation: ").append(getTextValidation()).append(",");
if (getDisplayHints() != null)
sb.append("DisplayHints: ").append(getDisplayHints());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RegistrationFieldDefinition == false)
return false;
RegistrationFieldDefinition other = (RegistrationFieldDefinition) obj;
if (other.getSectionPath() == null ^ this.getSectionPath() == null)
return false;
if (other.getSectionPath() != null && other.getSectionPath().equals(this.getSectionPath()) == false)
return false;
if (other.getFieldPath() == null ^ this.getFieldPath() == null)
return false;
if (other.getFieldPath() != null && other.getFieldPath().equals(this.getFieldPath()) == false)
return false;
if (other.getFieldType() == null ^ this.getFieldType() == null)
return false;
if (other.getFieldType() != null && other.getFieldType().equals(this.getFieldType()) == false)
return false;
if (other.getFieldRequirement() == null ^ this.getFieldRequirement() == null)
return false;
if (other.getFieldRequirement() != null && other.getFieldRequirement().equals(this.getFieldRequirement()) == false)
return false;
if (other.getSelectValidation() == null ^ this.getSelectValidation() == null)
return false;
if (other.getSelectValidation() != null && other.getSelectValidation().equals(this.getSelectValidation()) == false)
return false;
if (other.getTextValidation() == null ^ this.getTextValidation() == null)
return false;
if (other.getTextValidation() != null && other.getTextValidation().equals(this.getTextValidation()) == false)
return false;
if (other.getDisplayHints() == null ^ this.getDisplayHints() == null)
return false;
if (other.getDisplayHints() != null && other.getDisplayHints().equals(this.getDisplayHints()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSectionPath() == null) ? 0 : getSectionPath().hashCode());
hashCode = prime * hashCode + ((getFieldPath() == null) ? 0 : getFieldPath().hashCode());
hashCode = prime * hashCode + ((getFieldType() == null) ? 0 : getFieldType().hashCode());
hashCode = prime * hashCode + ((getFieldRequirement() == null) ? 0 : getFieldRequirement().hashCode());
hashCode = prime * hashCode + ((getSelectValidation() == null) ? 0 : getSelectValidation().hashCode());
hashCode = prime * hashCode + ((getTextValidation() == null) ? 0 : getTextValidation().hashCode());
hashCode = prime * hashCode + ((getDisplayHints() == null) ? 0 : getDisplayHints().hashCode());
return hashCode;
}
@Override
public RegistrationFieldDefinition clone() {
try {
return (RegistrationFieldDefinition) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.pinpointsmsvoicev2.model.transform.RegistrationFieldDefinitionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}