public class ETDataExtension extends ETSoapObject
ETDataExtension
object represents a data extension
in the Salesforce Marketing Cloud.ETSoapObject.DataExtensionRowConverter, ETSoapObject.EnumConverter, ETSoapObject.ExternalObjectConverter, ETSoapObject.InternalObjectConverter
PAGE_SIZE
Constructor and Description |
---|
ETDataExtension()
Class constructor, Initializes a new instance of the class.
|
create, delete, delete, fromInternal, getInternalProperties, getInternalProperty, retrieve, retrieve, retrieve, retrieve, toFilterPart, toInternal, update
getAllModified, getModified, setModified
getAllFields, getAllFields, getClient, getField, getField, setClient, toString
public ETDataExtension()
public String getId()
getId
in class ETApiObject
public void setId(String id)
setId
in class ETApiObject
id
- The Identifier of the ETDataExtension object.public String getKey()
public void setKey(String key)
key
- The Customer Key of the ETDataExtension object.public String getName()
public void setName(String name)
name
- The name of the ETDataExtension object.public String getDescription()
public void setDescription(String description)
description
- The description of the ETDataExtension.public Date getCreatedDate()
public void setCreatedDate(Date createdDate)
createdDate
- The created date of the ETDataExtension object.public Date getModifiedDate()
public void setModifiedDate(Date modifiedDate)
modifiedDate
- The modified date of the ETDataExtension object.public Integer getFolderId()
public void setFolderId(Integer folderId)
folderId
- The folder identifier.public Attribute getSendableSubscriberField()
public void setSendableSubscriberField(Attribute sendableSubscriberField)
sendableSubscriberField
- the sendableSubscriberField to setpublic ETDataExtensionColumn getSendableDataExtensionField()
public void setSendableDataExtensionField(ETDataExtensionColumn sendableDataExtensionField)
sendableDataExtensionField
- the sendableDataExtensionField to setpublic List<ETDataExtensionColumn> getColumns()
public ETDataExtensionColumn getColumn(String name)
name
- The column namepublic void addColumn(String name)
name
- The column name of the ETDataExtension object.public void addColumn(String name, ETDataExtensionColumn.Type type)
name
- The column name of the ETDataExtension object.type
- The ETDataExtensionColumn typepublic void addColumn(String name, Boolean isPrimaryKey)
name
- The column name of the ETDataExtension object.isPrimaryKey
- true if the column is primary key, false otherwise.public void addColumn(String name, ETDataExtensionColumn.Type type, Boolean isPrimaryKey)
name
- The column name of the ETDataExtension object.type
- The ETDataExtensionColumn typeisPrimaryKey
- true if the column is primary key, false otherwise.public void addColumn(String name, ETDataExtensionColumn.Type type, Integer length, Integer precision, Integer scale, Boolean isPrimaryKey, Boolean isRequired, String defaultValue)
name
- The column name of the ETDataExtension object.type
- The ETDataExtensionColumn typelength
- The lengthprecision
- The precisionscale
- The scaleisPrimaryKey
- true if the column is primary key, false otherwise.isRequired
- true if the column is required, false otherwise.defaultValue
- The default value of the columnpublic void addColumn(ETDataExtensionColumn column)
column
- The ETDataExtensionColumn object to add.public List<String> getColumnNames() throws ETSdkException
ETSdkException
public Boolean getIsSendable()
public void setIsSendable(Boolean isSendable)
isSendable
- true if it is sendable data extension, false otherwise.public Boolean getIsTestable()
public void setIsTestable(Boolean isTestable)
isTestable
- true if it is testable data extension, false otherwise.@Deprecated public String getCustomerKey()
getKey()
.@Deprecated public void setCustomerKey(String customerKey)
setKey()
.@Deprecated public Integer getCategoryId()
getFolderId()
.@Deprecated public void setCategoryId(Integer categoryId)
setFolderId()
.public static ETResponse<ETDataExtensionRow> select(ETClient client, String dataExtension, ETFilter filter) throws ETSdkException
client
- The ETClient objectdataExtension
- The data extensionfilter
- The ETFilter to be used to select rowsETSdkException
public static ETResponse<ETDataExtensionRow> select(ETClient client, String dataExtension, String... filter) throws ETSdkException
client
- The ETClient objectdataExtension
- The data extensionfilter
- The filter to be used to select rows as variable arguments of StringETSdkException
public static ETResponse<ETDataExtensionRow> select(ETClient client, String dataExtension, Integer page, Integer pageSize, ETFilter filter) throws ETSdkException
client
- The ETClient objectdataExtension
- The data extensionpage
- The page numberpageSize
- The page sizefilter
- The ETFilter to be used to select rowsETSdkException
public static ETResponse<ETDataExtensionRow> select(ETClient client, String dataExtension, Integer page, Integer pageSize, String... filter) throws ETSdkException
client
- The ETClient objectdataExtension
- The data extensionpage
- The page numberpageSize
- The page sizefilter
- The filter to be used to select rows as variable arguments of StringETSdkException
@Deprecated public static ETResponse<ETDataExtensionRow> select(ETClient client, String dataExtension, ETFilter filter, String... columns) throws ETSdkException
filter
argument.ETSdkException
@Deprecated public static ETResponse<ETDataExtensionRow> select(ETClient client, String dataExtension, ETFilter filter, Integer page, Integer pageSize, String... columns) throws ETSdkException
filter
argument.ETSdkException
@Deprecated public static ETResponse<ETDataExtensionRow> select(ETClient client, String dataExtension, String filter, Integer page, Integer pageSize, String... columns) throws ETSdkException
filter
argument.ETSdkException
public ETResponse<ETDataExtensionRow> select(ETFilter filter) throws ETSdkException
filter
- The ETFilter to be used to select rowsETSdkException
public ETResponse<ETDataExtensionRow> select(String... filter) throws ETSdkException
filter
- The filter to be used to select rows as variable arguments of StringETSdkException
public ETResponse<ETDataExtensionRow> select(Integer page, Integer pageSize, ETFilter filter) throws ETSdkException
page
- The page numberpageSize
- The page sizefilter
- The ETFilter to be used to select rowsETSdkException
public ETResponse<ETDataExtensionRow> select(Integer page, Integer pageSize, String... filter) throws ETSdkException
page
- The page numberpageSize
- The page sizefilter
- The filter to be used to select rows as variable arguments of StringETSdkException
@Deprecated public ETResponse<ETDataExtensionRow> select(ETFilter filter, String... columns) throws ETSdkException
filter
argument.ETSdkException
@Deprecated public ETResponse<ETDataExtensionRow> select(ETFilter filter, Integer page, Integer pageSize, String... columns) throws ETSdkException
filter
argument.ETSdkException
@Deprecated public ETResponse<ETDataExtensionRow> select(String filter, Integer page, Integer pageSize, String... columns) throws ETSdkException
filter
argument.ETSdkException
public ETResponse<ETDataExtensionRow> insert(ETDataExtensionRow... rows) throws ETSdkException
rows
- The filter to be used to insert rows as variable arguments of ETDataExtensionRowETSdkException
public ETResponse<ETDataExtensionRow> insert(List<ETDataExtensionRow> rows) throws ETSdkException
rows
- The filter to be used to insert rows as List of ETDataExtensionRowETSdkException
public ETResponse<ETDataExtensionRow> update(ETDataExtensionRow... rows) throws ETSdkException
rows
- The filter to be used to update rows as variable arguments of ETDataExtensionRowETSdkException
public ETResponse<ETDataExtensionRow> update(List<ETDataExtensionRow> rows) throws ETSdkException
rows
- The filter to be used to update rows as List of ETDataExtensionRowETSdkException
public ETResponse<ETDataExtensionRow> delete(ETDataExtensionRow... rows) throws ETSdkException
rows
- The filter to be used to delete rows as variable arguments of ETDataExtensionRowETSdkException
public ETResponse<ETDataExtensionRow> delete(List<ETDataExtensionRow> rows) throws ETSdkException
rows
- The filter to be used to delete rows as List of ETDataExtensionRowETSdkException
public ETResponse<ETDataExtensionRow> update(String filter, String... values) throws ETSdkException
filter
- The filter to be used to update rowsvalues
- The values as variable arguments of String which is used to do the updateETSdkException
public ETResponse<ETDataExtensionRow> delete(String filter) throws ETSdkException
filter
- The filter to be used to delete rowsETSdkException
public void hydrate() throws ETSdkException
ETSdkException
public static List<ETDataExtensionColumn> retrieveColumns(ETClient client, String key) throws ETSdkException
client
- The ETClient objectkey
- The keyETSdkException
public List<ETDataExtensionColumn> retrieveColumns() throws ETSdkException
ETSdkException
Copyright © 2017. All rights reserved.