Package Avalara.SDK.model.EInvoicing.V1

Class DataInputField

java.lang.Object

Avalara.SDK.model.EInvoicing.V1.DataInputField

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.7.0")
public class DataInputField
extends Object

The Data Input Field

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataInputField.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static String	SERIALIZED_NAME_ACCEPTED_VALUES
static String	SERIALIZED_NAME_APPLICABLE_DOCUMENT_ROOTS
static String	SERIALIZED_NAME_CONDITIONAL_FOR
static String	SERIALIZED_NAME_DESCRIPTION
static String	SERIALIZED_NAME_DOCUMENTATION_LINK
static String	SERIALIZED_NAME_EXAMPLE_OR_FIXED_VALUE
static String	SERIALIZED_NAME_FIELD_ID
static String	SERIALIZED_NAME_FIELD_NAME
static String	SERIALIZED_NAME_ID
static String	SERIALIZED_NAME_IS_SEGMENT
static String	SERIALIZED_NAME_NAMESPACE
static String	SERIALIZED_NAME_NOT_USED_FOR
static String	SERIALIZED_NAME_OPTIONAL_FOR
static String	SERIALIZED_NAME_PATH
static String	SERIALIZED_NAME_REQUIRED_FOR

Constructor Summary

Constructors

Constructor	Description
DataInputField()

Method Summary

Modifier and Type	Method	Description
DataInputField	acceptedValues(Object acceptedValues)
DataInputField	addApplicableDocumentRootsItem(Object applicableDocumentRootsItem)
DataInputField	addConditionalForItem(ConditionalForField conditionalForItem)
DataInputField	applicableDocumentRoots(List<Object> applicableDocumentRoots)
DataInputField	conditionalFor(List<ConditionalForField> conditionalFor)
DataInputField	description(String description)
DataInputField	documentationLink(String documentationLink)
boolean	equals(Object o)
DataInputField	exampleOrFixedValue(String exampleOrFixedValue)
DataInputField	fieldId(String fieldId)
DataInputField	fieldName(String fieldName)
static DataInputField	fromJson(String jsonString)	Create an instance of DataInputField given an JSON string
Object	getAcceptedValues()	An object representing the acceptable values for this field
List<Object>	getApplicableDocumentRoots()	Get applicableDocumentRoots
List<ConditionalForField>	getConditionalFor()	Get conditionalFor
String	getDescription()	A description of this field
String	getDocumentationLink()	An example of the content for this field
String	getExampleOrFixedValue()	An example of the content for this field
String	getFieldId()	Field ID
String	getFieldName()	Field name
String	getId()	Field UUID
Boolean	getIsSegment()	Is this a segment of the schema
String	getNamespace()	Namespace of this field
DataInputFieldNotUsedFor	getNotUsedFor()	Get notUsedFor
DataInputFieldOptionalFor	getOptionalFor()	Get optionalFor
String	getPath()	Path to this field
DataInputFieldRequiredFor	getRequiredFor()	Get requiredFor
int	hashCode()
DataInputField	id(String id)
DataInputField	isSegment(Boolean isSegment)
DataInputField	namespace(String namespace)
DataInputField	notUsedFor(DataInputFieldNotUsedFor notUsedFor)
DataInputField	optionalFor(DataInputFieldOptionalFor optionalFor)
DataInputField	path(String path)
DataInputField	requiredFor(DataInputFieldRequiredFor requiredFor)
void	setAcceptedValues(Object acceptedValues)
void	setApplicableDocumentRoots(List<Object> applicableDocumentRoots)
void	setConditionalFor(List<ConditionalForField> conditionalFor)
void	setDescription(String description)
void	setDocumentationLink(String documentationLink)
void	setExampleOrFixedValue(String exampleOrFixedValue)
void	setFieldId(String fieldId)
void	setFieldName(String fieldName)
void	setId(String id)
void	setIsSegment(Boolean isSegment)
void	setNamespace(String namespace)
void	setNotUsedFor(DataInputFieldNotUsedFor notUsedFor)
void	setOptionalFor(DataInputFieldOptionalFor optionalFor)
void	setPath(String path)
void	setRequiredFor(DataInputFieldRequiredFor requiredFor)
String	toJson()	Convert an instance of DataInputField to an JSON string
String	toString()
static void	validateJsonElement(com.google.gson.JsonElement jsonElement)	Validates the JSON Element and throws an exception if issues found

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

Constant Field Values

SERIALIZED_NAME_FIELD_ID

public static final String SERIALIZED_NAME_FIELD_ID

See Also:

Constant Field Values

SERIALIZED_NAME_APPLICABLE_DOCUMENT_ROOTS

public static final String SERIALIZED_NAME_APPLICABLE_DOCUMENT_ROOTS

See Also:

Constant Field Values

SERIALIZED_NAME_PATH

public static final String SERIALIZED_NAME_PATH

See Also:

Constant Field Values

SERIALIZED_NAME_NAMESPACE

public static final String SERIALIZED_NAME_NAMESPACE

See Also:

Constant Field Values

SERIALIZED_NAME_FIELD_NAME

public static final String SERIALIZED_NAME_FIELD_NAME

See Also:

Constant Field Values

SERIALIZED_NAME_EXAMPLE_OR_FIXED_VALUE

public static final String SERIALIZED_NAME_EXAMPLE_OR_FIXED_VALUE

See Also:

Constant Field Values

SERIALIZED_NAME_ACCEPTED_VALUES

public static final String SERIALIZED_NAME_ACCEPTED_VALUES

See Also:

Constant Field Values

SERIALIZED_NAME_DOCUMENTATION_LINK

public static final String SERIALIZED_NAME_DOCUMENTATION_LINK

See Also:

Constant Field Values

SERIALIZED_NAME_DESCRIPTION

public static final String SERIALIZED_NAME_DESCRIPTION

See Also:

Constant Field Values

SERIALIZED_NAME_IS_SEGMENT

public static final String SERIALIZED_NAME_IS_SEGMENT

See Also:

Constant Field Values

SERIALIZED_NAME_REQUIRED_FOR

public static final String SERIALIZED_NAME_REQUIRED_FOR

See Also:

Constant Field Values

SERIALIZED_NAME_CONDITIONAL_FOR

public static final String SERIALIZED_NAME_CONDITIONAL_FOR

See Also:

Constant Field Values

SERIALIZED_NAME_NOT_USED_FOR

public static final String SERIALIZED_NAME_NOT_USED_FOR

See Also:

Constant Field Values

SERIALIZED_NAME_OPTIONAL_FOR

public static final String SERIALIZED_NAME_OPTIONAL_FOR

See Also:

Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail

DataInputField

public DataInputField()

Method Detail

id

public DataInputField id(String id)

getId

@Nullable
public String getId()

Field UUID

Returns:

id

setId

public void setId(String id)

fieldId

public DataInputField fieldId(String fieldId)

getFieldId

@Nullable
public String getFieldId()

Field ID

Returns:

fieldId

setFieldId

public void setFieldId(String fieldId)

applicableDocumentRoots

public DataInputField applicableDocumentRoots(List<Object> applicableDocumentRoots)

addApplicableDocumentRootsItem

public DataInputField addApplicableDocumentRootsItem(Object applicableDocumentRootsItem)

getApplicableDocumentRoots

@Nullable
public List<Object> getApplicableDocumentRoots()

Get applicableDocumentRoots

Returns:

applicableDocumentRoots

setApplicableDocumentRoots

public void setApplicableDocumentRoots(List<Object> applicableDocumentRoots)

path

public DataInputField path(String path)

getPath

@Nullable
public String getPath()

Path to this field

Returns:

path

setPath

public void setPath(String path)

namespace

public DataInputField namespace(String namespace)

getNamespace

@Nullable
public String getNamespace()

Namespace of this field

Returns:

namespace

setNamespace

public void setNamespace(String namespace)

fieldName

public DataInputField fieldName(String fieldName)

getFieldName

@Nullable
public String getFieldName()

Field name

Returns:

fieldName

setFieldName

public void setFieldName(String fieldName)

exampleOrFixedValue

public DataInputField exampleOrFixedValue(String exampleOrFixedValue)

getExampleOrFixedValue

@Nullable
public String getExampleOrFixedValue()

An example of the content for this field

Returns:

exampleOrFixedValue

setExampleOrFixedValue

public void setExampleOrFixedValue(String exampleOrFixedValue)

acceptedValues

public DataInputField acceptedValues(Object acceptedValues)

getAcceptedValues

@Nullable
public Object getAcceptedValues()

An object representing the acceptable values for this field

Returns:

acceptedValues

setAcceptedValues

public void setAcceptedValues(Object acceptedValues)

documentationLink

public DataInputField documentationLink(String documentationLink)

getDocumentationLink

@Nullable
public String getDocumentationLink()

An example of the content for this field

Returns:

documentationLink

setDocumentationLink

public void setDocumentationLink(String documentationLink)

description

public DataInputField description(String description)

getDescription

@Nullable
public String getDescription()

A description of this field

Returns:

description

setDescription

public void setDescription(String description)

isSegment

public DataInputField isSegment(Boolean isSegment)

getIsSegment

@Nullable
public Boolean getIsSegment()

Is this a segment of the schema

Returns:

isSegment

setIsSegment

public void setIsSegment(Boolean isSegment)

requiredFor

public DataInputField requiredFor(DataInputFieldRequiredFor requiredFor)

getRequiredFor

@Nullable
public DataInputFieldRequiredFor getRequiredFor()

Get requiredFor

Returns:

requiredFor

setRequiredFor

public void setRequiredFor(DataInputFieldRequiredFor requiredFor)

conditionalFor

public DataInputField conditionalFor(List<ConditionalForField> conditionalFor)

addConditionalForItem

public DataInputField addConditionalForItem(ConditionalForField conditionalForItem)

getConditionalFor

@Nullable
public List<ConditionalForField> getConditionalFor()

Get conditionalFor

Returns:

conditionalFor

setConditionalFor

public void setConditionalFor(List<ConditionalForField> conditionalFor)

notUsedFor

public DataInputField notUsedFor(DataInputFieldNotUsedFor notUsedFor)

getNotUsedFor

@Nullable
public DataInputFieldNotUsedFor getNotUsedFor()

Get notUsedFor

Returns:

notUsedFor

setNotUsedFor

public void setNotUsedFor(DataInputFieldNotUsedFor notUsedFor)

optionalFor

public DataInputField optionalFor(DataInputFieldOptionalFor optionalFor)

getOptionalFor

@Nullable
public DataInputFieldOptionalFor getOptionalFor()

Get optionalFor

Returns:

optionalFor

setOptionalFor

public void setOptionalFor(DataInputFieldOptionalFor optionalFor)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonElement

public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws IOException

Validates the JSON Element and throws an exception if issues found

Parameters:

jsonElement - JSON Element

Throws:

IOException - if the JSON Element is invalid with respect to DataInputField

fromJson

public static DataInputField fromJson(String jsonString)
                               throws IOException

Create an instance of DataInputField given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of DataInputField

Throws:

IOException - if the JSON string is invalid with respect to DataInputField

toJson

public String toJson()

Convert an instance of DataInputField to an JSON string

Returns:

JSON string