GetHubSpot
Description
Retrieves JSON data from a private HubSpot application. This processor is intended to be run on the Primary Node only.
Tags
hubspot
Properties
In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Object Type * | object-type |
| The HubSpot Object Type requested | |
| Access Token * | access-token | Access Token to authenticate requests | ||
| Result Limit | result-limit | The maximum number of results to request for each invocation of the Processor Supports Expression Language, using Environment variables. | ||
| Incremental Loading * | is-incremental | true |
| The processor can incrementally load the queried objects so that each object is queried exactly once. For each query, the processor queries objects within a time window where the objects were modified between the previous run time and the current time (optionally adjusted by the Incremental Delay property). |
| Incremental Delay * | incremental-delay | 30 sec | The ending timestamp of the time window will be adjusted earlier by the amount configured in this property. For example, with a property value of 10 seconds, an ending timestamp of 12:30:45 would be changed to 12:30:35. Set this property to avoid missing objects when the clock of your local machines and HubSpot servers' clock are not in sync and to protect against HubSpot's mechanism that changes last updated timestamps after object creation. Supports Expression Language, using Environment variables. This property is only considered if:
| |
| Incremental Initial Start Time | incremental-initial-start-time | This property specifies the start time that the processor applies when running the first request. The expected format is a UTC date-time such as '2011-12-03T10:15:30Z' Supports Expression Language, using Environment variables. This property is only considered if:
| ||
| Web Client Service Provider * | web-client-service-provider | Controller Service: WebClientServiceProvider Implementations: StandardWebClientServiceProvider | Controller service for HTTP client operations |
Dynamic Properties
This component does not support dynamic properties.
Relationships
| Name | Description |
|---|---|
| success | For FlowFiles created as a result of a successful HTTP request. |
Reads Attributes
This processor does not read attributes.
Writes Attributes
| Name | Description |
|---|---|
| mime.type | Sets the MIME type to application/json |
State Management
| Scope | Description |
|---|---|
| CLUSTER | In case of incremental loading, the start and end timestamps of the last query time window are stored in the state. When the 'Result Limit' property is set, the paging cursor is saved after executing a request. Only the objects after the paging cursor will be retrieved. The maximum number of retrieved objects can be set in the 'Result Limit' property. |
Restricted
This component is not restricted.
Input Requirement
This component does not allow an incoming relationship.
System Resource Considerations
This component does not specify system resource considerations.