io.cdap.plugin.hubspot.common

Class SourceHubspotConfig

java.lang.Object

io.cdap.cdap.api.Config

io.cdap.cdap.api.plugin.PluginConfig

io.cdap.plugin.common.ReferencePluginConfig

io.cdap.plugin.hubspot.common.BaseHubspotConfig

io.cdap.plugin.hubspot.common.SourceHubspotConfig

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

HubspotStreamingSourceConfig

public class SourceHubspotConfig
extends BaseHubspotConfig

Provides source configuration for accessing Hubspot API.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	END_DATE
String	endDate
String	filters
static String	FILTERS
static String	REPORT_CATEGORY
static String	REPORT_CONTENT
static String	REPORT_OBJECT
static String	REPORT_TYPE
String	reportCategory
String	reportContent
String	reportObject
String	reportType
static String	START_DATE
String	startDate
static String	TIME_PERIOD
String	timePeriod

Fields inherited from class io.cdap.plugin.hubspot.common.BaseHubspotConfig

API_SERVER_URL, apiServerUrl, AUTHORIZATION_TOKEN, authToken, DEFAULT_API_SERVER_URL, OBJECT_TYPE, objectType

Fields inherited from class io.cdap.plugin.common.ReferencePluginConfig

referenceName

Constructor Summary

Constructors

Constructor and Description
SourceHubspotConfig(String referenceName)
SourceHubspotConfig(String referenceName, String apiServerUrl, String objectType, String authToken, String filters, String startDate, String endDate, String reportType, String reportContent, String reportCategory, String reportObject, String timePeriod) Constructor for SourceHubspotConfig object.

Method Summary

Modifier and Type	Method and Description
List<String>	getFilters() Returns the list of string.
ReportEndpoint	getReportEndpoint() Returns the ReportEndpoint.
ReportEndpoint	getReportEndpoint(String reportCategory)
ReportType	getReportType()
io.cdap.cdap.api.data.schema.Schema	getSchema() Returns the Schema.
TimePeriod	getTimePeriod()
void	validate(io.cdap.cdap.etl.api.FailureCollector failureCollector) Validates SourceHubspotConfig instance.

Methods inherited from class io.cdap.plugin.hubspot.common.BaseHubspotConfig

getApiServerUrl, getObjectType

Methods inherited from class io.cdap.cdap.api.plugin.PluginConfig

containsMacro, getProperties

Methods inherited from class java.lang.Object

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

Field Detail

TIME_PERIOD

public static final String TIME_PERIOD

See Also:

Constant Field Values

REPORT_TYPE

public static final String REPORT_TYPE

See Also:

Constant Field Values

REPORT_CONTENT

public static final String REPORT_CONTENT

See Also:

Constant Field Values

REPORT_CATEGORY

public static final String REPORT_CATEGORY

See Also:

Constant Field Values

START_DATE

public static final String START_DATE

See Also:

Constant Field Values

END_DATE

public static final String END_DATE

See Also:

Constant Field Values

FILTERS

public static final String FILTERS

See Also:

Constant Field Values

REPORT_OBJECT

public static final String REPORT_OBJECT

See Also:

Constant Field Values

filters

@Nullable
public String filters

startDate

@Nullable
public String startDate

endDate

@Nullable
public String endDate

reportType

@Nullable
public String reportType

reportContent

@Nullable
public String reportContent

reportCategory

@Nullable
public String reportCategory

reportObject

@Nullable
public String reportObject

timePeriod

@Nullable
public String timePeriod

Constructor Detail

SourceHubspotConfig

public SourceHubspotConfig(String referenceName)

SourceHubspotConfig

public SourceHubspotConfig(String referenceName,
                           String apiServerUrl,
                           String objectType,
                           String authToken,
                           String filters,
                           String startDate,
                           String endDate,
                           String reportType,
                           String reportContent,
                           String reportCategory,
                           String reportObject,
                           String timePeriod)

Constructor for SourceHubspotConfig object.

Parameters:

referenceName - the reference name

apiServerUrl - the api server url of hubspot

objectType - the object type of hubspot

authToken - the hubspot private app access token

filters - the filters for Analytics object type

startDate - the start date for Analytics object type

endDate - the end date for Analytics object type

reportType - the report type for Analytics object type

reportContent - the report content

reportCategory - the report category

reportObject - the report object

timePeriod - the time period for Analytics object type

Method Detail

validate

public void validate(io.cdap.cdap.etl.api.FailureCollector failureCollector)

Validates SourceHubspotConfig instance.

getSchema

public io.cdap.cdap.api.data.schema.Schema getSchema()

Returns the Schema.

Returns:

the Schema

getReportEndpoint

@Nullable
public ReportEndpoint getReportEndpoint()

Returns the ReportEndpoint.

Returns:

the ReportEndpoint

getReportEndpoint

@Nullable
public ReportEndpoint getReportEndpoint(String reportCategory)

getReportType

@Nullable
public ReportType getReportType()

getTimePeriod

@Nullable
public TimePeriod getTimePeriod()

getFilters

@Nullable
public List<String> getFilters()

Returns the list of string.

Returns:

the list of string