com.exacttarget.fuelsdk

Class ETDataExtension

java.lang.Object

com.exacttarget.fuelsdk.ETObject

com.exacttarget.fuelsdk.ETApiObject

com.exacttarget.fuelsdk.ETSoapObject

com.exacttarget.fuelsdk.ETDataExtension

public class ETDataExtension
extends ETSoapObject

An ETDataExtension object represents a data extension in the Salesforce Marketing Cloud.

Nested Class Summary

Nested classes/interfaces inherited from class com.exacttarget.fuelsdk.ETSoapObject

ETSoapObject.DataExtensionRowConverter, ETSoapObject.EnumConverter, ETSoapObject.ExternalObjectConverter, ETSoapObject.InternalObjectConverter

Field Summary

Fields inherited from class com.exacttarget.fuelsdk.ETSoapObject

PAGE_SIZE

Constructor Summary

Constructors

Constructor and Description
ETDataExtension() Class constructor, Initializes a new instance of the class.

Method Summary

Modifier and Type	Method and Description
void	addColumn(ETDataExtensionColumn column)
void	addColumn(String name)
void	addColumn(String name, Boolean isPrimaryKey)
void	addColumn(String name, ETDataExtensionColumn.Type type)
void	addColumn(String name, ETDataExtensionColumn.Type type, Boolean isPrimaryKey)
void	addColumn(String name, ETDataExtensionColumn.Type type, Integer length, Integer precision, Integer scale, Boolean isPrimaryKey, Boolean isRequired, String defaultValue)
ETResponse<ETDataExtensionRow>	delete(ETDataExtensionRow... rows)
ETResponse<ETDataExtensionRow>	delete(List<ETDataExtensionRow> rows)
ETResponse<ETDataExtensionRow>	delete(String filter)
Integer	getCategoryId() Deprecated. Use getFolderId().
ETDataExtensionColumn	getColumn(String name)
List<String>	getColumnNames()
List<ETDataExtensionColumn>	getColumns()
Date	getCreatedDate()
String	getCustomerKey() Deprecated. Use getKey().
String	getDescription()
Integer	getFolderId()
String	getId()
Boolean	getIsSendable()
Boolean	getIsTestable()
String	getKey()
Date	getModifiedDate()
String	getName()
ETDataExtensionColumn	getSendableDataExtensionField()
Attribute	getSendableSubscriberField()
void	hydrate() Calls the retrieveColumns() method
ETResponse<ETDataExtensionRow>	insert(ETDataExtensionRow... rows)
ETResponse<ETDataExtensionRow>	insert(List<ETDataExtensionRow> rows)
List<ETDataExtensionColumn>	retrieveColumns()
static List<ETDataExtensionColumn>	retrieveColumns(ETClient client, String key)
static ETResponse<ETDataExtensionRow>	select(ETClient client, String dataExtension, ETFilter filter)
static ETResponse<ETDataExtensionRow>	select(ETClient client, String dataExtension, ETFilter filter, Integer page, Integer pageSize, String... columns) Deprecated. Pass columns in filter argument.
static ETResponse<ETDataExtensionRow>	select(ETClient client, String dataExtension, ETFilter filter, String... columns) Deprecated. Pass columns in filter argument.
static ETResponse<ETDataExtensionRow>	select(ETClient client, String dataExtension, Integer page, Integer pageSize, ETFilter filter)
static ETResponse<ETDataExtensionRow>	select(ETClient client, String dataExtension, Integer page, Integer pageSize, String... filter)
static ETResponse<ETDataExtensionRow>	select(ETClient client, String dataExtension, String... filter)
static ETResponse<ETDataExtensionRow>	select(ETClient client, String dataExtension, String filter, Integer page, Integer pageSize, String... columns) Deprecated. Pass columns in filter argument.
ETResponse<ETDataExtensionRow>	select(ETFilter filter)
ETResponse<ETDataExtensionRow>	select(ETFilter filter, Integer page, Integer pageSize, String... columns) Deprecated. Pass columns in filter argument.
ETResponse<ETDataExtensionRow>	select(ETFilter filter, String... columns) Deprecated. Pass columns in filter argument.
ETResponse<ETDataExtensionRow>	select(Integer page, Integer pageSize, ETFilter filter)
ETResponse<ETDataExtensionRow>	select(Integer page, Integer pageSize, String... filter)
ETResponse<ETDataExtensionRow>	select(String... filter)
ETResponse<ETDataExtensionRow>	select(String filter, Integer page, Integer pageSize, String... columns) Deprecated. Pass columns in filter argument.
void	setCategoryId(Integer categoryId) Deprecated. Use setFolderId().
void	setCreatedDate(Date createdDate)
void	setCustomerKey(String customerKey) Deprecated. Use setKey().
void	setDescription(String description)
void	setFolderId(Integer folderId)
void	setId(String id)
void	setIsSendable(Boolean isSendable)
void	setIsTestable(Boolean isTestable)
void	setKey(String key)
void	setModifiedDate(Date modifiedDate)
void	setName(String name)
void	setSendableDataExtensionField(ETDataExtensionColumn sendableDataExtensionField)
void	setSendableSubscriberField(Attribute sendableSubscriberField)
ETResponse<ETDataExtensionRow>	update(ETDataExtensionRow... rows)
ETResponse<ETDataExtensionRow>	update(List<ETDataExtensionRow> rows)
ETResponse<ETDataExtensionRow>	update(String filter, String... values)

Methods inherited from class com.exacttarget.fuelsdk.ETSoapObject

create, delete, delete, fromInternal, getInternalProperties, getInternalProperty, retrieve, retrieve, retrieve, retrieve, toFilterPart, toInternal, update

Methods inherited from class com.exacttarget.fuelsdk.ETApiObject

getAllModified, getModified, setModified

Methods inherited from class com.exacttarget.fuelsdk.ETObject

getAllFields, getAllFields, getClient, getField, getField, setClient, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ETDataExtension

public ETDataExtension()

Class constructor, Initializes a new instance of the class.

Method Detail

getId

public String getId()

Specified by:

getId in class ETApiObject

Returns:

The Identifier of the ETDataExtension object.

setId

public void setId(String id)

Specified by:

setId in class ETApiObject

Parameters:

id - The Identifier of the ETDataExtension object.

getKey

public String getKey()

Returns:

The Customer Key of the ETDataExtension object.

setKey

public void setKey(String key)

Parameters:

key - The Customer Key of the ETDataExtension object.

getName

public String getName()

Returns:

The name of the ETDataExtension object.

setName

public void setName(String name)

Parameters:

name - The name of the ETDataExtension object.

getDescription

public String getDescription()

Returns:

The description of the ETDataExtension.

setDescription

public void setDescription(String description)

Parameters:

description - The description of the ETDataExtension.

getCreatedDate

public Date getCreatedDate()

Returns:

The created date of the ETDataExtension object.

setCreatedDate

public void setCreatedDate(Date createdDate)

Parameters:

createdDate - The created date of the ETDataExtension object.

getModifiedDate

public Date getModifiedDate()

Returns:

The modified date of the ETDataExtension object.

setModifiedDate

public void setModifiedDate(Date modifiedDate)

Parameters:

modifiedDate - The modified date of the ETDataExtension object.

getFolderId

public Integer getFolderId()

Returns:

The folder identifier.

setFolderId

public void setFolderId(Integer folderId)

Parameters:

folderId - The folder identifier.

getSendableSubscriberField

public Attribute getSendableSubscriberField()

Returns:

the sendableSubscriberField

setSendableSubscriberField

public void setSendableSubscriberField(Attribute sendableSubscriberField)

Parameters:

sendableSubscriberField - the sendableSubscriberField to set

getSendableDataExtensionField

public ETDataExtensionColumn getSendableDataExtensionField()

Returns:

the sendableDataExtensionField

setSendableDataExtensionField

public void setSendableDataExtensionField(ETDataExtensionColumn sendableDataExtensionField)

Parameters:

sendableDataExtensionField - the sendableDataExtensionField to set

getColumns

public List<ETDataExtensionColumn> getColumns()

Returns:

The List of all ETDataExtensionColumn

getColumn

public ETDataExtensionColumn getColumn(String name)

Parameters:

name - The column name

Returns:

The ETDataExtensionColumn

addColumn

public void addColumn(String name)

Parameters:

name - The column name of the ETDataExtension object.

addColumn

public void addColumn(String name,
                      ETDataExtensionColumn.Type type)

Parameters:

name - The column name of the ETDataExtension object.

type - The ETDataExtensionColumn type

addColumn

public void addColumn(String name,
                      Boolean isPrimaryKey)

Parameters:

name - The column name of the ETDataExtension object.

isPrimaryKey - true if the column is primary key, false otherwise.

addColumn

public void addColumn(String name,
                      ETDataExtensionColumn.Type type,
                      Boolean isPrimaryKey)

Parameters:

name - The column name of the ETDataExtension object.

type - The ETDataExtensionColumn type

isPrimaryKey - true if the column is primary key, false otherwise.

addColumn

public void addColumn(String name,
                      ETDataExtensionColumn.Type type,
                      Integer length,
                      Integer precision,
                      Integer scale,
                      Boolean isPrimaryKey,
                      Boolean isRequired,
                      String defaultValue)

Parameters:

name - The column name of the ETDataExtension object.

type - The ETDataExtensionColumn type

length - The length

precision - The precision

scale - The scale

isPrimaryKey - true if the column is primary key, false otherwise.

isRequired - true if the column is required, false otherwise.

defaultValue - The default value of the column

addColumn

public void addColumn(ETDataExtensionColumn column)

Parameters:

column - The ETDataExtensionColumn object to add.

getColumnNames

public List<String> getColumnNames()
                            throws ETSdkException

Returns:

The List of ETDataExtension Column names

Throws:

ETSdkException

getIsSendable

public Boolean getIsSendable()

Returns:

true if it is sendable data extension, false otherwise.

setIsSendable

public void setIsSendable(Boolean isSendable)

Parameters:

isSendable - true if it is sendable data extension, false otherwise.

getIsTestable

public Boolean getIsTestable()

Returns:

true if it is testable data extension, false otherwise.

setIsTestable

public void setIsTestable(Boolean isTestable)

Parameters:

isTestable - true if it is testable data extension, false otherwise.

getCustomerKey

@Deprecated
public String getCustomerKey()

Deprecated. Use getKey().

setCustomerKey

@Deprecated
public void setCustomerKey(String customerKey)

Deprecated. Use setKey().

getCategoryId

@Deprecated
public Integer getCategoryId()

Deprecated. Use getFolderId().

setCategoryId

@Deprecated
public void setCategoryId(Integer categoryId)

Deprecated. Use setFolderId().

select

public static ETResponse<ETDataExtensionRow> select(ETClient client,
                                                    String dataExtension,
                                                    ETFilter filter)
                                             throws ETSdkException

Parameters:

client - The ETClient object

dataExtension - The data extension

filter - The ETFilter to be used to select rows

Returns:

The ETResponse of ETDataExtensionRow

Throws:

ETSdkException

select

public static ETResponse<ETDataExtensionRow> select(ETClient client,
                                                    String dataExtension,
                                                    String... filter)
                                             throws ETSdkException

Parameters:

client - The ETClient object

dataExtension - The data extension

filter - The filter to be used to select rows as variable arguments of String

Returns:

The ETResponse of ETDataExtensionRow

Throws:

ETSdkException

select

public static ETResponse<ETDataExtensionRow> select(ETClient client,
                                                    String dataExtension,
                                                    Integer page,
                                                    Integer pageSize,
                                                    ETFilter filter)
                                             throws ETSdkException

Parameters:

client - The ETClient object

dataExtension - The data extension

page - The page number

pageSize - The page size

filter - The ETFilter to be used to select rows

Returns:

The ETResponse of ETDataExtensionRow

Throws:

ETSdkException

select

public static ETResponse<ETDataExtensionRow> select(ETClient client,
                                                    String dataExtension,
                                                    Integer page,
                                                    Integer pageSize,
                                                    String... filter)
                                             throws ETSdkException

Parameters:

client - The ETClient object

dataExtension - The data extension

page - The page number

pageSize - The page size

filter - The filter to be used to select rows as variable arguments of String

Returns:

The ETResponse of ETDataExtensionRow

Throws:

ETSdkException

select

@Deprecated
public static ETResponse<ETDataExtensionRow> select(ETClient client,
                                                                String dataExtension,
                                                                ETFilter filter,
                                                                String... columns)
                                                         throws ETSdkException

Deprecated. Pass columns in filter argument.

Throws:

ETSdkException

select

@Deprecated
public static ETResponse<ETDataExtensionRow> select(ETClient client,
                                                                String dataExtension,
                                                                ETFilter filter,
                                                                Integer page,
                                                                Integer pageSize,
                                                                String... columns)
                                                         throws ETSdkException

Deprecated. Pass columns in filter argument.

Throws:

ETSdkException

select

@Deprecated
public static ETResponse<ETDataExtensionRow> select(ETClient client,
                                                                String dataExtension,
                                                                String filter,
                                                                Integer page,
                                                                Integer pageSize,
                                                                String... columns)
                                                         throws ETSdkException

Deprecated. Pass columns in filter argument.

Throws:

ETSdkException

select

public ETResponse<ETDataExtensionRow> select(ETFilter filter)
                                      throws ETSdkException

Parameters:

filter - The ETFilter to be used to select rows

Returns:

The ETResponse of ETDataExtensionRow

Throws:

ETSdkException

select

public ETResponse<ETDataExtensionRow> select(String... filter)
                                      throws ETSdkException

Parameters:

filter - The filter to be used to select rows as variable arguments of String

Returns:

The ETResponse of ETDataExtensionRow

Throws:

ETSdkException

select

public ETResponse<ETDataExtensionRow> select(Integer page,
                                             Integer pageSize,
                                             ETFilter filter)
                                      throws ETSdkException

Parameters:

page - The page number

pageSize - The page size

filter - The ETFilter to be used to select rows

Returns:

The ETResponse of ETDataExtensionRow

Throws:

ETSdkException

select

public ETResponse<ETDataExtensionRow> select(Integer page,
                                             Integer pageSize,
                                             String... filter)
                                      throws ETSdkException

Parameters:

page - The page number

pageSize - The page size

filter - The filter to be used to select rows as variable arguments of String

Returns:

The ETResponse of ETDataExtensionRow

Throws:

ETSdkException

select

@Deprecated
public ETResponse<ETDataExtensionRow> select(ETFilter filter,
                                                         String... columns)
                                                  throws ETSdkException

Deprecated. Pass columns in filter argument.

Throws:

ETSdkException

select

@Deprecated
public ETResponse<ETDataExtensionRow> select(ETFilter filter,
                                                         Integer page,
                                                         Integer pageSize,
                                                         String... columns)
                                                  throws ETSdkException

Deprecated. Pass columns in filter argument.

Throws:

ETSdkException

select

@Deprecated
public ETResponse<ETDataExtensionRow> select(String filter,
                                                         Integer page,
                                                         Integer pageSize,
                                                         String... columns)
                                                  throws ETSdkException

Deprecated. Pass columns in filter argument.

Throws:

ETSdkException

insert

public ETResponse<ETDataExtensionRow> insert(ETDataExtensionRow... rows)
                                      throws ETSdkException

Parameters:

rows - The filter to be used to insert rows as variable arguments of ETDataExtensionRow

Returns:

The ETResponse of ETDataExtensionRow

Throws:

ETSdkException

insert

public ETResponse<ETDataExtensionRow> insert(List<ETDataExtensionRow> rows)
                                      throws ETSdkException

Parameters:

rows - The filter to be used to insert rows as List of ETDataExtensionRow

Returns:

The ETResponse of ETDataExtensionRow

Throws:

ETSdkException

update

public ETResponse<ETDataExtensionRow> update(ETDataExtensionRow... rows)
                                      throws ETSdkException

Parameters:

rows - The filter to be used to update rows as variable arguments of ETDataExtensionRow

Returns:

The ETResponse of ETDataExtensionRow

Throws:

ETSdkException

update

public ETResponse<ETDataExtensionRow> update(List<ETDataExtensionRow> rows)
                                      throws ETSdkException

Parameters:

rows - The filter to be used to update rows as List of ETDataExtensionRow

Returns:

The ETResponse of ETDataExtensionRow

Throws:

ETSdkException

delete

public ETResponse<ETDataExtensionRow> delete(ETDataExtensionRow... rows)
                                      throws ETSdkException

Parameters:

rows - The filter to be used to delete rows as variable arguments of ETDataExtensionRow

Returns:

The ETResponse of ETDataExtensionRow

Throws:

ETSdkException

delete

public ETResponse<ETDataExtensionRow> delete(List<ETDataExtensionRow> rows)
                                      throws ETSdkException

Parameters:

rows - The filter to be used to delete rows as List of ETDataExtensionRow

Returns:

The ETResponse of ETDataExtensionRow

Throws:

ETSdkException

update

public ETResponse<ETDataExtensionRow> update(String filter,
                                             String... values)
                                      throws ETSdkException

Parameters:

filter - The filter to be used to update rows

values - The values as variable arguments of String which is used to do the update

Returns:

The ETResponse of ETDataExtensionRow

Throws:

ETSdkException

delete

public ETResponse<ETDataExtensionRow> delete(String filter)
                                      throws ETSdkException

Parameters:

filter - The filter to be used to delete rows

Returns:

The ETResponse of ETDataExtensionRow

Throws:

ETSdkException

hydrate

public void hydrate()
             throws ETSdkException

Calls the retrieveColumns() method

Throws:

ETSdkException

retrieveColumns

public static List<ETDataExtensionColumn> retrieveColumns(ETClient client,
                                                          String key)
                                                   throws ETSdkException

Parameters:

client - The ETClient object

key - The key

Returns:

The List of ETDataExtensionColumn

Throws:

ETSdkException

retrieveColumns

public List<ETDataExtensionColumn> retrieveColumns()
                                            throws ETSdkException

Returns:

The List of ETDataExtensionColumn

Throws:

ETSdkException