FieldMetadata (Salesforce Einstein Analytics Connector

java.lang.Object
- org.mule.modules.salesforce.analytics.internal.metadata.FieldMetadata

```
public class FieldMetadata
extends Object
```
Data transfer object holding metadata information regarding the field to be sent to salesforce.

Constructor Summary

Constructors
Constructor and Description

FieldMetadata()

Constructors
Constructor and Description
`FieldMetadata()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`getCanTruncateValue()` Getter method for canTruncateValue.Indicates whether to truncate a value when the value exceeds the precision.
`String`	`getDecimalSeparator()` Getter method for .For numeric fields only.
`String`	`getDefaultValue()` Getter method for default value of the field, if any.
`String`	`getDescription()` Getter method for description of the object.
`Integer`	`getFirstDayOfWeek()` Getter method for firstDayOfWeek.
`Integer`	`getFiscalMonthOffset()` Getter method for fiscal offset.
`String`	`getFormat()` Getter method for format of the field.
`String`	`getFullyQualifiedName()` Getter method for fully qualified name.
`Boolean`	`getIsMultiValue()` Getter method for flag that tels if the field is a multi value field or not.
`Boolean`	`getIsSkipped()` Getter method for isSkipped.Indicates whether to skip the field when the data is uploaded.
`Boolean`	`getIsSystemField()` Getter method for flag that tells if the field is system field and should be excluded from query results.
`Boolean`	`getIsUniqueId()` Getter method for flag that tels if the field is a primary key or not.
`Boolean`	`getIsYearEndFiscalYear()` Getter method for isYearEndFiscalYear.For date fields only.
`String`	`getLabel()` Getter method for display name of the field.
`String`	`getMultiValueSeparator()` Getter method for multi value separator in case the field is a multi value field.
`String`	`getName()` Getter method for unique API name of the field.
`Integer`	`getPrecision()` Getter method for precision of the field.
`Integer`	`getScale()` Setter method for scale of the field.
`DataType`	`getType()` Getter method for type of the field.
`void`	`setCanTruncateValue(Boolean canTruncateValue)` Setter method for canTruncateValue.Indicates whether to truncate a value when the value exceeds the precision.
`void`	`setDecimalSeparator(String decimalSeparator)` Setter method for decimalSeparator.For numeric fields only.
`void`	`setDefaultValue(String defaultValue)` Setter method for default value of the field, if any.
`void`	`setDescription(String description)` Setter method for description of the object.
`void`	`setFirstDayOfWeek(Integer firstDayOfWeek)` Setter method for firstDayOfWeek.
`void`	`setFiscalMonthOffset(Integer fiscalMonthOffset)` Setter method for fiscal offset.
`void`	`setFormat(String format)` Setter method for format of the field.
`void`	`setFullyQualifiedName(String fullyQualifiedName)` Setter method for fully qualified name.
`void`	`setIsMultiValue(Boolean isMultiValue)` Setter method for flag that tels if the field is a multi value field or not.
`void`	`setIsSkipped(Boolean isSkipped)` Setter method for isSkipped.Indicates whether to skip the field when the data is uploaded.
`void`	`setIsSystemField(Boolean isSystemField)` Setter method for flag that tells if the field is system field and should be excluded from query results.
`void`	`setIsUniqueId(Boolean isUniqueId)` Setter method for flag that tels if the field is a primary key or not.
`void`	`setIsYearEndFiscalYear(Boolean isYearEndFiscalYear)` Setter method for isYearEndFiscalYear.For date fields only.
`void`	`setLabel(String label)` Setter method for display name of the field.
`void`	`setMultiValueSeparator(String multiValueSeparator)` Setter method for multi value separator in case the field is a multi value field.
`void`	`setName(String name)` Setter method for unique API name of the field.
`void`	`setPrecision(Integer precision)` Setter method for precision of the field.
`void`	`setScale(Integer scale)` Setter method for scale of the field.
`void`	`setType(DataType type)` Setter method for type of the field.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FieldMetadata
```
public FieldMetadata()
```
- Method Detail
  - getDescription
```
public String getDescription()
```
    Getter method for description of the object.
    
    Returns:
    
    description of the object
  - setDescription
```
public void setDescription(String description)
```
    Setter method for description of the object.
    
    Parameters:
    
    description - - description of the object
  - getFullyQualifiedName
```
public String getFullyQualifiedName()
```
    Getter method for fully qualified name. Full path that uniquely identifies the field.
    
    Returns:
    
    full path that uniquely identifies the field.
  - setFullyQualifiedName
```
public void setFullyQualifiedName(String fullyQualifiedName)
```
    Setter method for fully qualified name. Full path that uniquely identifies the field.
    
    Parameters:
    
    fullyQualifiedName - - full path that uniquely identifies the field.
  - getLabel
```
public String getLabel()
```
    Getter method for display name of the field.
    
    Returns:
    
    display name of the field
  - setLabel
```
public void setLabel(String label)
```
    Setter method for display name of the field.
    
    Parameters:
    
    label - - display name of the field
  - getName
```
public String getName()
```
    Getter method for unique API name of the field.
    
    Returns:
    
    unique API name of the field
  - setName
```
public void setName(String name)
```
    Setter method for unique API name of the field.
    
    Parameters:
    
    name - - unique API name of the field
  - getIsSystemField
```
public Boolean getIsSystemField()
```
    Getter method for flag that tells if the field is system field and should be excluded from query results.
    
    Returns:
    
    true if the field is system field, false otherwise
  - setIsSystemField
```
public void setIsSystemField(Boolean isSystemField)
```
    Setter method for flag that tells if the field is system field and should be excluded from query results.
    
    Parameters:
    
    isSystemField - - true if the field is system field, false otherwise
  - getDefaultValue
```
public String getDefaultValue()
```
    Getter method for default value of the field, if any. All numeric types must have a default value.
    
    Returns:
    
    the default value of the field
  - setDefaultValue
```
public void setDefaultValue(String defaultValue)
```
    Setter method for default value of the field, if any. All numeric types must have a default value.
    
    Parameters:
    
    defaultValue - the default value of the field. All numeric types must have a default value
  - getIsUniqueId
```
public Boolean getIsUniqueId()
```
    Getter method for flag that tels if the field is a primary key or not.
    
    Returns:
    
    true if the field represents a primary key, false otherwise
  - setIsUniqueId
```
public void setIsUniqueId(Boolean isUniqueId)
```
    Setter method for flag that tels if the field is a primary key or not.
    
    Parameters:
    
    isUniqueId - boolean value indicating if the field represents the a primary key
  - getIsMultiValue
```
public Boolean getIsMultiValue()
```
    Getter method for flag that tels if the field is a multi value field or not.
    
    Returns:
    
    true if the field represents a multi value field, false otherwise
  - setIsMultiValue
```
public void setIsMultiValue(Boolean isMultiValue)
```
    Setter method for flag that tels if the field is a multi value field or not.
    
    Parameters:
    
    isMultiValue - boolean value indicating if the field represents a multi value field
  - getMultiValueSeparator
```
public String getMultiValueSeparator()
```
    Getter method for multi value separator in case the field is a multi value field.
    
    Returns:
    
    the separator for multi value field
  - setMultiValueSeparator
```
public void setMultiValueSeparator(String multiValueSeparator)
```
    Setter method for multi value separator in case the field is a multi value field.
    
    Parameters:
    
    multiValueSeparator - - the separator for multi value field
  - getType
```
public DataType getType()
```
    Getter method for type of the field. Can be Text, Numeric, or Date.
    
    Returns:
    
    the type of the field
  - setType
```
public void setType(DataType type)
```
    Setter method for type of the field. Can be Text, Numeric, or Date.
    
    Parameters:
    
    type - - the type of the field
  - getPrecision
```
public Integer getPrecision()
```
    Getter method for precision of the field. Maximum number of digits in a numeric value, including all numbers to the left and to the right of the decimal point (but excluding the decimal point character)
    
    Returns:
    
    the precision of the field
  - setPrecision
```
public void setPrecision(Integer precision)
```
    Setter method for precision of the field. Maximum number of digits in a numeric value, including all numbers to the left and to the right of the decimal point (but excluding the decimal point character)
    
    Parameters:
    
    precision - - the precision of the field
  - getScale
```
public Integer getScale()
```
    Setter method for scale of the field. Number of digits to the right of the decimal point in a numeric value.
    
    Returns:
    
    the scale of the field
  - setScale
```
public void setScale(Integer scale)
```
    Setter method for scale of the field. Number of digits to the right of the decimal point in a numeric value.
    
    Parameters:
    
    scale - - the scale of the field
  - getFormat
```
public String getFormat()
```
    Getter method for format of the field. Format of the numeric or date value.
    
    Returns:
    
    the format of the field
  - setFormat
```
public void setFormat(String format)
```
    Setter method for format of the field. Format of the numeric or date value.
    
    Parameters:
    
    format - - the format of the field
  - getFiscalMonthOffset
```
public Integer getFiscalMonthOffset()
```
    Getter method for fiscal offset. Offset, in months, that the fiscal year differs from the calendar year. Represented as the month number - 1. For example, if the fiscal year starts in January, the offset is 0 (1 - 1). If the fiscal year starts in October, the offset is 9 (10 - 1)
    
    Returns:
    
    the fiscal offset of the field
  - setFiscalMonthOffset
```
public void setFiscalMonthOffset(Integer fiscalMonthOffset)
```
    Setter method for fiscal offset. Offset, in months, that the fiscal year differs from the calendar year. Represented as the month number - 1. For example, if the fiscal year starts in January, the offset is 0 (1 - 1). If the fiscal year starts in October, the offset is 9 (10 - 1)
    
    Parameters:
    
    fiscalMonthOffset - - the fiscal offset of the field
  - getCanTruncateValue
```
public Boolean getCanTruncateValue()
```
    Getter method for canTruncateValue.Indicates whether to truncate a value when the value exceeds the precision. The default is true. If true, truncates the value.
    
    Returns:
    
    true/false
  - setCanTruncateValue
```
public void setCanTruncateValue(Boolean canTruncateValue)
```
    Setter method for canTruncateValue.Indicates whether to truncate a value when the value exceeds the precision. The default is true. If true, truncates the value.
    
    Parameters:
    
    canTruncateValue - boolean value specifying if the value of the field should be truncated if it exceeds the precision
  - getDecimalSeparator
```
public String getDecimalSeparator()
```
    Getter method for .For numeric fields only. The character that separates digits in a decimal number. Can be used to handle international number formats where the decimal separator is ','. The default is '.'
    
    Returns:
    
    decimalSeparator
  - setDecimalSeparator
```
public void setDecimalSeparator(String decimalSeparator)
```
    Setter method for decimalSeparator.For numeric fields only. The character that separates digits in a decimal number. Can be used to handle international number formats where the decimal separator is ','. The default is '.'
    
    Parameters:
    
    decimalSeparator - value of the decimal separator
  - getIsYearEndFiscalYear
```
public Boolean getIsYearEndFiscalYear()
```
    Getter method for isYearEndFiscalYear.For date fields only. Indicates whether the fiscal year is the year in which the fiscal year ends or begins. Because the fiscal year can start in one calendar year and end in another, specify which year to use for the fiscal year. If true, then the fiscal year is the year in which the fiscal year ends. The default is true. If false, then the fiscal year is the year in which the fiscal year begins. Example: "isYearEndFiscalYear": true This field is relevant only when fiscalMonthOffset is greater than 0.
    
    Returns:
    
    isYearEndFiscalYear - true, then the fiscal year is the year in which the fiscal year ends / false, then the fiscal year is the year in which the fiscal year begins
  - setIsYearEndFiscalYear
```
public void setIsYearEndFiscalYear(Boolean isYearEndFiscalYear)
```
    Setter method for isYearEndFiscalYear.For date fields only. Indicates whether the fiscal year is the year in which the fiscal year ends or begins. Because the fiscal year can start in one calendar year and end in another, specify which year to use for the fiscal year. If true, then the fiscal year is the year in which the fiscal year ends. The default is true. If false, then the fiscal year is the year in which the fiscal year begins. Example: "isYearEndFiscalYear": true This field is relevant only when fiscalMonthOffset is greater than 0.
    
    Parameters:
    
    isYearEndFiscalYear - - true, then the fiscal year is the year in which the fiscal year ends / false, then the fiscal year is the year in which the fiscal year begins
  - getFirstDayOfWeek
```
public Integer getFirstDayOfWeek()
```
    Getter method for firstDayOfWeek. For date fields only. The first day of the week for the calendar year and, if applicable, fiscal year. Use 0 to set the first day to be Sunday, 1 to set firstDayOfWeek Number No the first day to be Monday, and so on. Use -1 to set the first day to be January 1. The default is -1.
    
    Returns:
    
    firstDayOfWeek -0 to set the first day to be Sunday
  - setFirstDayOfWeek
```
public void setFirstDayOfWeek(Integer firstDayOfWeek)
```
    Setter method for firstDayOfWeek. For date fields only. The first day of the week for the calendar year and, if applicable, fiscal year. Use 0 to set the first day to be Sunday, 1 to set firstDayOfWeek Number No the first day to be Monday, and so on. Use -1 to set the first day to be January 1. The default is -1.
    
    Parameters:
    
    firstDayOfWeek - -0 to set the first day to be Sunday
  - getIsSkipped
```
public Boolean getIsSkipped()
```
    Getter method for isSkipped.Indicates whether to skip the field when the data is uploaded.
    
    Returns:
    
    isSkipped
  - setIsSkipped
```
public void setIsSkipped(Boolean isSkipped)
```
    Setter method for isSkipped.Indicates whether to skip the field when the data is uploaded.
    
    Parameters:
    
    isSkipped - boolean value indicating if the field should be skipped when the data is uploaded

Class FieldMetadata

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FieldMetadata

Method Detail

getDescription

setDescription

getFullyQualifiedName

setFullyQualifiedName

getLabel

setLabel

getName

setName

getIsSystemField

setIsSystemField

getDefaultValue

setDefaultValue

getIsUniqueId

setIsUniqueId

getIsMultiValue

setIsMultiValue

getMultiValueSeparator

setMultiValueSeparator

getType

setType

getPrecision

setPrecision

getScale

setScale

getFormat

setFormat

getFiscalMonthOffset

setFiscalMonthOffset

getCanTruncateValue

setCanTruncateValue

getDecimalSeparator

setDecimalSeparator

getIsYearEndFiscalYear

setIsYearEndFiscalYear

getFirstDayOfWeek

setFirstDayOfWeek

getIsSkipped

setIsSkipped