com.exacttarget.fuelsdk

Class ETDataExtract

java.lang.Object

com.exacttarget.fuelsdk.ETDataExtract

public class ETDataExtract
extends Object

An ETDataExtract object can perform data extract activity for data extension and tracking data in the Salesforce Marketing Cloud.

Field Summary

Fields

Modifier and Type	Field and Description
HashMap<String,String>	extractType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ExtractResponseMsg	extractDataExtension() Sends a data extension extract request.
ExtractResponseMsg	extractDataExtension(String deCustomerKey, String outputFileName, boolean hasColumnHeaders) Sends a data extension extract request.
ExtractResponseMsg	extractTrackingData() Sends an extract request for tracking data.
String	getAsyncID()
String	getDECustomerKey()
Date	getEndDate()
String	getOutputFileName()
Date	getStartDate()
boolean	isExtractBounces()
boolean	isExtractClicks()
boolean	isExtractConversions()
boolean	isExtractOpens()
boolean	isExtractSendJobs()
boolean	isExtractSends()
boolean	isExtractSurveyResponses()
boolean	isExtractUnsubs()
boolean	isHasColumnHeaders()
boolean	isIncludeTestSends()
void	setDECustomerKey(String DECustomerKey)
void	setEndDate(Date EndDate)
void	setExtractBounces(boolean ExtractBounces)
void	setExtractClicks(boolean ExtractClicks)
void	setExtractConversions(boolean ExtractConversions)
void	setExtractOpens(boolean ExtractOpens)
void	setExtractSendJobs(boolean ExtractSendJobs)
void	setExtractSends(boolean ExtractSends)
void	setExtractSurveyResponses(boolean ExtractSurveyResponses)
void	setExtractUnsubs(boolean ExtractUnsubs)
void	setHasColumnHeaders(boolean HasColumnHeaders)
void	setIncludeTestSends(boolean IncludeTestSends)
void	setOutputFileName(String outputFileName)
void	setStartDate(Date StartDate)

Methods inherited from class java.lang.Object

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

Field Detail

extractType

public HashMap<String,String> extractType

Constructor Detail

ETDataExtract

public ETDataExtract(ETClient client)

Class constructor, Initializes a new instance of the class.

Parameters:

client - the ETCleint object

Method Detail

extractDataExtension

public ExtractResponseMsg extractDataExtension(String deCustomerKey,
                                               String outputFileName,
                                               boolean hasColumnHeaders)
                                        throws Exception

Sends a data extension extract request.

Parameters:

deCustomerKey - the customer key of the data extension

outputFileName - the output file name

hasColumnHeaders - true if the output file should contain column headers, false otherwise

Returns:

ExtractResponseMsg object which holds the status, request ID, etc

Throws:

Exception

extractDataExtension

public ExtractResponseMsg extractDataExtension()
                                        throws Exception

Sends a data extension extract request.

Returns:

ExtractResponseMsg object which holds the status, request ID, etc

Throws:

Exception

extractTrackingData

public ExtractResponseMsg extractTrackingData()
                                       throws Exception

Sends an extract request for tracking data.

Returns:

ExtractResponseMsg object which holds the status, request ID, etc

Throws:

Exception

getOutputFileName

public String getOutputFileName()

Returns:

the outputFileName

setOutputFileName

public void setOutputFileName(String outputFileName)

Parameters:

outputFileName - the outputFileName to set

setStartDate

public void setStartDate(Date StartDate)

Parameters:

StartDate - the StartDate to set

setEndDate

public void setEndDate(Date EndDate)

Parameters:

EndDate - the EndDate to set

getDECustomerKey

public String getDECustomerKey()

Returns:

the DECustomerKey

setDECustomerKey

public void setDECustomerKey(String DECustomerKey)

Parameters:

DECustomerKey - the DECustomerKey to set

isExtractBounces

public boolean isExtractBounces()

Returns:

the ExtractBounces

setExtractBounces

public void setExtractBounces(boolean ExtractBounces)

Parameters:

ExtractBounces - the ExtractBounces to set

isExtractClicks

public boolean isExtractClicks()

Returns:

the ExtractClicks

setExtractClicks

public void setExtractClicks(boolean ExtractClicks)

Parameters:

ExtractClicks - the ExtractClicks to set

isExtractConversions

public boolean isExtractConversions()

Returns:

the ExtractConversions

setExtractConversions

public void setExtractConversions(boolean ExtractConversions)

Parameters:

ExtractConversions - the ExtractConversions to set

isExtractOpens

public boolean isExtractOpens()

Returns:

the ExtractOpens

setExtractOpens

public void setExtractOpens(boolean ExtractOpens)

Parameters:

ExtractOpens - the ExtractOpens to set

isExtractSends

public boolean isExtractSends()

Returns:

the ExtractSends

setExtractSends

public void setExtractSends(boolean ExtractSends)

Parameters:

ExtractSends - the ExtractSends to set

isExtractSendJobs

public boolean isExtractSendJobs()

Returns:

the ExtractSendJobs

setExtractSendJobs

public void setExtractSendJobs(boolean ExtractSendJobs)

Parameters:

ExtractSendJobs - the ExtractSendJobs to set

isExtractSurveyResponses

public boolean isExtractSurveyResponses()

Returns:

the ExtractSurveyResponses

setExtractSurveyResponses

public void setExtractSurveyResponses(boolean ExtractSurveyResponses)

Parameters:

ExtractSurveyResponses - the ExtractSurveyResponses to set

isIncludeTestSends

public boolean isIncludeTestSends()

Returns:

the IncludeTestSends

setIncludeTestSends

public void setIncludeTestSends(boolean IncludeTestSends)

Parameters:

IncludeTestSends - the IncludeTestSends to set

isExtractUnsubs

public boolean isExtractUnsubs()

Returns:

the ExtractUnsubs

setExtractUnsubs

public void setExtractUnsubs(boolean ExtractUnsubs)

Parameters:

ExtractUnsubs - the ExtractUnsubs to set

getStartDate

public Date getStartDate()

Returns:

the StartDate

getEndDate

public Date getEndDate()

Returns:

the EndDate

getAsyncID

public String getAsyncID()

Returns:

the _AsyncID

isHasColumnHeaders

public boolean isHasColumnHeaders()

Returns:

the HasColumnHeaders

setHasColumnHeaders

public void setHasColumnHeaders(boolean HasColumnHeaders)

Parameters:

HasColumnHeaders - the HasColumnHeaders to set