ReportDefinitionField (AdWords AppEngine components 4.21.0 API)

java.lang.Object
- com.google.api.ads.adwords.jaxws.v201809.cm.ReportDefinitionField

public class ReportDefinitionField
extends Object

Represents the fields that can be used to create a ReportDefinition. This class allows the user to query the list of fields applicable to a given report type. Consumers of reports will be able use the retrieved fields through the ReportDefinitionService#getReportFields api and run the corresponding reports.

Java class for ReportDefinitionField complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ReportDefinitionField">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="fieldName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="displayFieldName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="xmlAttributeName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="fieldType" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="fieldBehavior" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="enumValues" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
         <element name="canSelect" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="canFilter" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="isEnumType" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="isBeta" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="isZeroRowCompatible" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="enumValuePairs" type="{https://adwords.google.com/api/adwords/cm/v201809}EnumValuePair" maxOccurs="unbounded" minOccurs="0"/>
         <element name="exclusiveFields" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`canFilter`
`protected Boolean`	`canSelect`
`protected String`	`displayFieldName`
`protected List<EnumValuePair>`	`enumValuePairs`
`protected List<String>`	`enumValues`
`protected List<String>`	`exclusiveFields`
`protected String`	`fieldBehavior`
`protected String`	`fieldName`
`protected String`	`fieldType`
`protected Boolean`	`isBeta`
`protected Boolean`	`isEnumType`
`protected Boolean`	`isZeroRowCompatible`
`protected String`	`xmlAttributeName`

Constructor Summary

Constructors
Constructor and Description

ReportDefinitionField()

Constructors
Constructor and Description
`ReportDefinitionField()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDisplayFieldName()` Gets the value of the displayFieldName property.
`List<EnumValuePair>`	`getEnumValuePairs()` Gets the value of the enumValuePairs property.
`List<String>`	`getEnumValues()` Gets the value of the enumValues property.
`List<String>`	`getExclusiveFields()` Gets the value of the exclusiveFields property.
`String`	`getFieldBehavior()` Gets the value of the fieldBehavior property.
`String`	`getFieldName()` Gets the value of the fieldName property.
`String`	`getFieldType()` Gets the value of the fieldType property.
`String`	`getXmlAttributeName()` Gets the value of the xmlAttributeName property.
`Boolean`	`isCanFilter()` Gets the value of the canFilter property.
`Boolean`	`isCanSelect()` Gets the value of the canSelect property.
`Boolean`	`isIsBeta()` Gets the value of the isBeta property.
`Boolean`	`isIsEnumType()` Gets the value of the isEnumType property.
`Boolean`	`isIsZeroRowCompatible()` Gets the value of the isZeroRowCompatible property.
`void`	`setCanFilter(Boolean value)` Sets the value of the canFilter property.
`void`	`setCanSelect(Boolean value)` Sets the value of the canSelect property.
`void`	`setDisplayFieldName(String value)` Sets the value of the displayFieldName property.
`void`	`setFieldBehavior(String value)` Sets the value of the fieldBehavior property.
`void`	`setFieldName(String value)` Sets the value of the fieldName property.
`void`	`setFieldType(String value)` Sets the value of the fieldType property.
`void`	`setIsBeta(Boolean value)` Sets the value of the isBeta property.
`void`	`setIsEnumType(Boolean value)` Sets the value of the isEnumType property.
`void`	`setIsZeroRowCompatible(Boolean value)` Sets the value of the isZeroRowCompatible property.
`void`	`setXmlAttributeName(String value)` Sets the value of the xmlAttributeName property.

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

- Field Detail
  - fieldName
```
protected String fieldName
```
  - displayFieldName
```
protected String displayFieldName
```
  - xmlAttributeName
```
protected String xmlAttributeName
```
  - fieldType
```
protected String fieldType
```
  - fieldBehavior
```
protected String fieldBehavior
```
  - enumValues
```
protected List<String> enumValues
```
  - canSelect
```
protected Boolean canSelect
```
  - canFilter
```
protected Boolean canFilter
```
  - isEnumType
```
protected Boolean isEnumType
```
  - isBeta
```
protected Boolean isBeta
```
  - isZeroRowCompatible
```
protected Boolean isZeroRowCompatible
```
  - enumValuePairs
```
protected List<EnumValuePair> enumValuePairs
```
  - exclusiveFields
```
protected List<String> exclusiveFields
```
- Constructor Detail
  - ReportDefinitionField
```
public ReportDefinitionField()
```
- Method Detail
  - getFieldName
```
public String getFieldName()
```
    Gets the value of the fieldName property.
    
    Returns:
    
    possible object is String
  - setFieldName
```
public void setFieldName(String value)
```
    Sets the value of the fieldName property.
    
    Parameters:
    
    value - allowed object is String
  - getDisplayFieldName
```
public String getDisplayFieldName()
```
    Gets the value of the displayFieldName property.
    
    Returns:
    
    possible object is String
  - setDisplayFieldName
```
public void setDisplayFieldName(String value)
```
    Sets the value of the displayFieldName property.
    
    Parameters:
    
    value - allowed object is String
  - getXmlAttributeName
```
public String getXmlAttributeName()
```
    Gets the value of the xmlAttributeName property.
    
    Returns:
    
    possible object is String
  - setXmlAttributeName
```
public void setXmlAttributeName(String value)
```
    Sets the value of the xmlAttributeName property.
    
    Parameters:
    
    value - allowed object is String
  - getFieldType
```
public String getFieldType()
```
    Gets the value of the fieldType property.
    
    Returns:
    
    possible object is String
  - setFieldType
```
public void setFieldType(String value)
```
    Sets the value of the fieldType property.
    
    Parameters:
    
    value - allowed object is String
  - getFieldBehavior
```
public String getFieldBehavior()
```
    Gets the value of the fieldBehavior property.
    
    Returns:
    
    possible object is String
  - setFieldBehavior
```
public void setFieldBehavior(String value)
```
    Sets the value of the fieldBehavior property.
    
    Parameters:
    
    value - allowed object is String
  - getEnumValues
```
public List<String> getEnumValues()
```
    Gets the value of the enumValues property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the enumValues property.
    For example, to add a new item, do as follows:
```
    getEnumValues().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String
  - isCanSelect
```
public Boolean isCanSelect()
```
    Gets the value of the canSelect property.
    
    Returns:
    
    possible object is Boolean
  - setCanSelect
```
public void setCanSelect(Boolean value)
```
    Sets the value of the canSelect property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isCanFilter
```
public Boolean isCanFilter()
```
    Gets the value of the canFilter property.
    
    Returns:
    
    possible object is Boolean
  - setCanFilter
```
public void setCanFilter(Boolean value)
```
    Sets the value of the canFilter property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isIsEnumType
```
public Boolean isIsEnumType()
```
    Gets the value of the isEnumType property.
    
    Returns:
    
    possible object is Boolean
  - setIsEnumType
```
public void setIsEnumType(Boolean value)
```
    Sets the value of the isEnumType property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isIsBeta
```
public Boolean isIsBeta()
```
    Gets the value of the isBeta property.
    
    Returns:
    
    possible object is Boolean
  - setIsBeta
```
public void setIsBeta(Boolean value)
```
    Sets the value of the isBeta property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isIsZeroRowCompatible
```
public Boolean isIsZeroRowCompatible()
```
    Gets the value of the isZeroRowCompatible property.
    
    Returns:
    
    possible object is Boolean
  - setIsZeroRowCompatible
```
public void setIsZeroRowCompatible(Boolean value)
```
    Sets the value of the isZeroRowCompatible property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getEnumValuePairs
```
public List<EnumValuePair> getEnumValuePairs()
```
    Gets the value of the enumValuePairs property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the enumValuePairs property.
    For example, to add a new item, do as follows:
```
    getEnumValuePairs().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list EnumValuePair
  - getExclusiveFields
```
public List<String> getExclusiveFields()
```
    Gets the value of the exclusiveFields property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the exclusiveFields property.
    For example, to add a new item, do as follows:
```
    getExclusiveFields().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String

Class ReportDefinitionField

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

fieldName

displayFieldName

xmlAttributeName

fieldType

fieldBehavior

enumValues

canSelect

canFilter

isEnumType

isBeta

isZeroRowCompatible

enumValuePairs

exclusiveFields

Constructor Detail

ReportDefinitionField

Method Detail

getFieldName

setFieldName

getDisplayFieldName

setDisplayFieldName

getXmlAttributeName

setXmlAttributeName

getFieldType

setFieldType

getFieldBehavior

setFieldBehavior

getEnumValues

isCanSelect

setCanSelect

isCanFilter

setCanFilter

isIsEnumType

setIsEnumType

isIsBeta

setIsBeta

isIsZeroRowCompatible

setIsZeroRowCompatible

getEnumValuePairs

getExclusiveFields