DataExtension (Salesforce Marketing Cloud Java SDK 1.5.1 API)

java.lang.Object
- com.exacttarget.fuelsdk.internal.APIObject
- - com.exacttarget.fuelsdk.internal.DataExtension

public class DataExtension
extends APIObject

Java class for DataExtension complex type.

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

 <complexType name="DataExtension">
   <complexContent>
     <extension base="{http://exacttarget.com/wsdl/partnerAPI}APIObject">
       <sequence>
         <element name="Name" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Description" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="IsSendable" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="IsTestable" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="SendableDataExtensionField" type="{http://exacttarget.com/wsdl/partnerAPI}DataExtensionField" minOccurs="0"/>
         <element name="SendableSubscriberField" type="{http://exacttarget.com/wsdl/partnerAPI}Attribute" minOccurs="0"/>
         <element name="Template" type="{http://exacttarget.com/wsdl/partnerAPI}DataExtensionTemplate" minOccurs="0"/>
         <element name="DataRetentionPeriodLength" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="DataRetentionPeriodUnitOfMeasure" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="RowBasedRetention" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="ResetRetentionPeriodOnImport" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="DeleteAtEndOfRetentionPeriod" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="RetainUntil" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Fields" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <sequence>
                   <element name="Field" type="{http://exacttarget.com/wsdl/partnerAPI}DataExtensionField" maxOccurs="unbounded" minOccurs="0"/>
                 </sequence>
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="DataRetentionPeriod" type="{http://exacttarget.com/wsdl/partnerAPI}DateTimeUnitOfMeasure" minOccurs="0"/>
         <element name="CategoryID" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="Status" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DataExtension.Fields
Java class for anonymous complex type.

Nested Classes
Modifier and Type	Class and Description
`static class`	`DataExtension.Fields` Java class for anonymous complex type.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Long`	`categoryID`
`protected DateTimeUnitOfMeasure`	`dataRetentionPeriod`
`protected Integer`	`dataRetentionPeriodLength`
`protected Integer`	`dataRetentionPeriodUnitOfMeasure`
`protected Boolean`	`deleteAtEndOfRetentionPeriod`
`protected String`	`description`
`protected DataExtension.Fields`	`fields`
`protected Boolean`	`isSendable`
`protected Boolean`	`isTestable`
`protected String`	`name`
`protected Boolean`	`resetRetentionPeriodOnImport`
`protected String`	`retainUntil`
`protected Boolean`	`rowBasedRetention`
`protected DataExtensionField`	`sendableDataExtensionField`
`protected Attribute`	`sendableSubscriberField`
`protected String`	`status`
`protected DataExtensionTemplate`	`template`

Fields inherited from class com.exacttarget.fuelsdk.internal.APIObject
client, correlationID, createdDate, customerKey, id, modifiedDate, objectID, objectState, owner, partnerKey, partnerProperties

Constructor Summary

Constructors
Constructor and Description

DataExtension()

Constructors
Constructor and Description
`DataExtension()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long`	`getCategoryID()` Gets the value of the categoryID property.
`DateTimeUnitOfMeasure`	`getDataRetentionPeriod()` Gets the value of the dataRetentionPeriod property.
`Integer`	`getDataRetentionPeriodLength()` Gets the value of the dataRetentionPeriodLength property.
`Integer`	`getDataRetentionPeriodUnitOfMeasure()` Gets the value of the dataRetentionPeriodUnitOfMeasure property.
`Boolean`	`getDeleteAtEndOfRetentionPeriod()` Gets the value of the deleteAtEndOfRetentionPeriod property.
`String`	`getDescription()` Gets the value of the description property.
`DataExtension.Fields`	`getFields()` Gets the value of the fields property.
`Boolean`	`getIsSendable()` Gets the value of the isSendable property.
`Boolean`	`getIsTestable()` Gets the value of the isTestable property.
`String`	`getName()` Gets the value of the name property.
`Boolean`	`getResetRetentionPeriodOnImport()` Gets the value of the resetRetentionPeriodOnImport property.
`String`	`getRetainUntil()` Gets the value of the retainUntil property.
`Boolean`	`getRowBasedRetention()` Gets the value of the rowBasedRetention property.
`DataExtensionField`	`getSendableDataExtensionField()` Gets the value of the sendableDataExtensionField property.
`Attribute`	`getSendableSubscriberField()` Gets the value of the sendableSubscriberField property.
`String`	`getStatus()` Gets the value of the status property.
`DataExtensionTemplate`	`getTemplate()` Gets the value of the template property.
`void`	`setCategoryID(Long value)` Sets the value of the categoryID property.
`void`	`setDataRetentionPeriod(DateTimeUnitOfMeasure value)` Sets the value of the dataRetentionPeriod property.
`void`	`setDataRetentionPeriodLength(Integer value)` Sets the value of the dataRetentionPeriodLength property.
`void`	`setDataRetentionPeriodUnitOfMeasure(Integer value)` Sets the value of the dataRetentionPeriodUnitOfMeasure property.
`void`	`setDeleteAtEndOfRetentionPeriod(Boolean value)` Sets the value of the deleteAtEndOfRetentionPeriod property.
`void`	`setDescription(String value)` Sets the value of the description property.
`void`	`setFields(DataExtension.Fields value)` Sets the value of the fields property.
`void`	`setIsSendable(Boolean value)` Sets the value of the isSendable property.
`void`	`setIsTestable(Boolean value)` Sets the value of the isTestable property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setResetRetentionPeriodOnImport(Boolean value)` Sets the value of the resetRetentionPeriodOnImport property.
`void`	`setRetainUntil(String value)` Sets the value of the retainUntil property.
`void`	`setRowBasedRetention(Boolean value)` Sets the value of the rowBasedRetention property.
`void`	`setSendableDataExtensionField(DataExtensionField value)` Sets the value of the sendableDataExtensionField property.
`void`	`setSendableSubscriberField(Attribute value)` Sets the value of the sendableSubscriberField property.
`void`	`setStatus(String value)` Sets the value of the status property.
`void`	`setTemplate(DataExtensionTemplate value)` Sets the value of the template property.
`String`	`toString()` Generates a String representation of the contents of this type.

Methods inherited from class com.exacttarget.fuelsdk.internal.APIObject
getClient, getCorrelationID, getCreatedDate, getCustomerKey, getId, getModifiedDate, getObjectID, getObjectState, getOwner, getPartnerKey, getPartnerProperties, setClient, setCorrelationID, setCreatedDate, setCustomerKey, setId, setModifiedDate, setObjectID, setObjectState, setOwner, setPartnerKey

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

- Field Detail
  - name
```
protected String name
```
  - description
```
protected String description
```
  - isSendable
```
protected Boolean isSendable
```
  - isTestable
```
protected Boolean isTestable
```
  - sendableDataExtensionField
```
protected DataExtensionField sendableDataExtensionField
```
  - sendableSubscriberField
```
protected Attribute sendableSubscriberField
```
  - template
```
protected DataExtensionTemplate template
```
  - dataRetentionPeriodLength
```
protected Integer dataRetentionPeriodLength
```
  - dataRetentionPeriodUnitOfMeasure
```
protected Integer dataRetentionPeriodUnitOfMeasure
```
  - rowBasedRetention
```
protected Boolean rowBasedRetention
```
  - resetRetentionPeriodOnImport
```
protected Boolean resetRetentionPeriodOnImport
```
  - deleteAtEndOfRetentionPeriod
```
protected Boolean deleteAtEndOfRetentionPeriod
```
  - retainUntil
```
protected String retainUntil
```
  - fields
```
protected DataExtension.Fields fields
```
  - dataRetentionPeriod
```
protected DateTimeUnitOfMeasure dataRetentionPeriod
```
  - categoryID
```
protected Long categoryID
```
  - status
```
protected String status
```
- Constructor Detail
  - DataExtension
```
public DataExtension()
```
- Method Detail
  - getName
```
public String getName()
```
    Gets the value of the name property.
    
    Returns:
    
    possible object is String
  - setName
```
public void setName(String value)
```
    Sets the value of the name property.
    
    Parameters:
    
    value - allowed object is String
  - getDescription
```
public String getDescription()
```
    Gets the value of the description property.
    
    Returns:
    
    possible object is String
  - setDescription
```
public void setDescription(String value)
```
    Sets the value of the description property.
    
    Parameters:
    
    value - allowed object is String
  - getIsSendable
```
public Boolean getIsSendable()
```
    Gets the value of the isSendable property.
    
    Returns:
    
    possible object is Boolean
  - setIsSendable
```
public void setIsSendable(Boolean value)
```
    Sets the value of the isSendable property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getIsTestable
```
public Boolean getIsTestable()
```
    Gets the value of the isTestable property.
    
    Returns:
    
    possible object is Boolean
  - setIsTestable
```
public void setIsTestable(Boolean value)
```
    Sets the value of the isTestable property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getSendableDataExtensionField
```
public DataExtensionField getSendableDataExtensionField()
```
    Gets the value of the sendableDataExtensionField property.
    
    Returns:
    
    possible object is DataExtensionField
  - setSendableDataExtensionField
```
public void setSendableDataExtensionField(DataExtensionField value)
```
    Sets the value of the sendableDataExtensionField property.
    
    Parameters:
    
    value - allowed object is DataExtensionField
  - getSendableSubscriberField
```
public Attribute getSendableSubscriberField()
```
    Gets the value of the sendableSubscriberField property.
    
    Returns:
    
    possible object is Attribute
  - setSendableSubscriberField
```
public void setSendableSubscriberField(Attribute value)
```
    Sets the value of the sendableSubscriberField property.
    
    Parameters:
    
    value - allowed object is Attribute
  - getTemplate
```
public DataExtensionTemplate getTemplate()
```
    Gets the value of the template property.
    
    Returns:
    
    possible object is DataExtensionTemplate
  - setTemplate
```
public void setTemplate(DataExtensionTemplate value)
```
    Sets the value of the template property.
    
    Parameters:
    
    value - allowed object is DataExtensionTemplate
  - getDataRetentionPeriodLength
```
public Integer getDataRetentionPeriodLength()
```
    Gets the value of the dataRetentionPeriodLength property.
    
    Returns:
    
    possible object is Integer
  - setDataRetentionPeriodLength
```
public void setDataRetentionPeriodLength(Integer value)
```
    Sets the value of the dataRetentionPeriodLength property.
    
    Parameters:
    
    value - allowed object is Integer
  - getDataRetentionPeriodUnitOfMeasure
```
public Integer getDataRetentionPeriodUnitOfMeasure()
```
    Gets the value of the dataRetentionPeriodUnitOfMeasure property.
    
    Returns:
    
    possible object is Integer
  - setDataRetentionPeriodUnitOfMeasure
```
public void setDataRetentionPeriodUnitOfMeasure(Integer value)
```
    Sets the value of the dataRetentionPeriodUnitOfMeasure property.
    
    Parameters:
    
    value - allowed object is Integer
  - getRowBasedRetention
```
public Boolean getRowBasedRetention()
```
    Gets the value of the rowBasedRetention property.
    
    Returns:
    
    possible object is Boolean
  - setRowBasedRetention
```
public void setRowBasedRetention(Boolean value)
```
    Sets the value of the rowBasedRetention property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getResetRetentionPeriodOnImport
```
public Boolean getResetRetentionPeriodOnImport()
```
    Gets the value of the resetRetentionPeriodOnImport property.
    
    Returns:
    
    possible object is Boolean
  - setResetRetentionPeriodOnImport
```
public void setResetRetentionPeriodOnImport(Boolean value)
```
    Sets the value of the resetRetentionPeriodOnImport property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getDeleteAtEndOfRetentionPeriod
```
public Boolean getDeleteAtEndOfRetentionPeriod()
```
    Gets the value of the deleteAtEndOfRetentionPeriod property.
    
    Returns:
    
    possible object is Boolean
  - setDeleteAtEndOfRetentionPeriod
```
public void setDeleteAtEndOfRetentionPeriod(Boolean value)
```
    Sets the value of the deleteAtEndOfRetentionPeriod property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getRetainUntil
```
public String getRetainUntil()
```
    Gets the value of the retainUntil property.
    
    Returns:
    
    possible object is String
  - setRetainUntil
```
public void setRetainUntil(String value)
```
    Sets the value of the retainUntil property.
    
    Parameters:
    
    value - allowed object is String
  - getFields
```
public DataExtension.Fields getFields()
```
    Gets the value of the fields property.
    
    Returns:
    
    possible object is DataExtension.Fields
  - setFields
```
public void setFields(DataExtension.Fields value)
```
    Sets the value of the fields property.
    
    Parameters:
    
    value - allowed object is DataExtension.Fields
  - getDataRetentionPeriod
```
public DateTimeUnitOfMeasure getDataRetentionPeriod()
```
    Gets the value of the dataRetentionPeriod property.
    
    Returns:
    
    possible object is DateTimeUnitOfMeasure
  - setDataRetentionPeriod
```
public void setDataRetentionPeriod(DateTimeUnitOfMeasure value)
```
    Sets the value of the dataRetentionPeriod property.
    
    Parameters:
    
    value - allowed object is DateTimeUnitOfMeasure
  - getCategoryID
```
public Long getCategoryID()
```
    Gets the value of the categoryID property.
    
    Returns:
    
    possible object is Long
  - setCategoryID
```
public void setCategoryID(Long value)
```
    Sets the value of the categoryID property.
    
    Parameters:
    
    value - allowed object is Long
  - getStatus
```
public String getStatus()
```
    Gets the value of the status property.
    
    Returns:
    
    possible object is String
  - setStatus
```
public void setStatus(String value)
```
    Sets the value of the status property.
    
    Parameters:
    
    value - allowed object is String
  - toString
```
public String toString()
```
    Generates a String representation of the contents of this type. This is an extension method, produced by the 'ts' xjc plugin
    
    Overrides:
    
    toString in class APIObject

Class DataExtension

Nested Class Summary

Field Summary

Fields inherited from class com.exacttarget.fuelsdk.internal.APIObject

Constructor Summary

Method Summary

Methods inherited from class com.exacttarget.fuelsdk.internal.APIObject

Methods inherited from class java.lang.Object

Field Detail

name

description

isSendable

isTestable

sendableDataExtensionField

sendableSubscriberField

template

dataRetentionPeriodLength

dataRetentionPeriodUnitOfMeasure

rowBasedRetention

resetRetentionPeriodOnImport

deleteAtEndOfRetentionPeriod

retainUntil

fields

dataRetentionPeriod

categoryID

status

Constructor Detail

DataExtension

Method Detail

getName

setName

getDescription

setDescription

getIsSendable

setIsSendable

getIsTestable

setIsTestable

getSendableDataExtensionField

setSendableDataExtensionField

getSendableSubscriberField

setSendableSubscriberField

getTemplate

setTemplate

getDataRetentionPeriodLength

setDataRetentionPeriodLength

getDataRetentionPeriodUnitOfMeasure

setDataRetentionPeriodUnitOfMeasure

getRowBasedRetention

setRowBasedRetention

getResetRetentionPeriodOnImport

setResetRetentionPeriodOnImport

getDeleteAtEndOfRetentionPeriod

setDeleteAtEndOfRetentionPeriod

getRetainUntil

setRetainUntil

getFields

setFields

getDataRetentionPeriod

setDataRetentionPeriod

getCategoryID

setCategoryID

getStatus

setStatus

toString