Class/Object

it.agilelab.bigdata.nifi.client.api

ProvenanceApi

Related Docs: object ProvenanceApi | package api

Permalink

class ProvenanceApi extends AnyRef

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProvenanceApi
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ProvenanceApi(baseUrl: String)(implicit serializer: SttpSerializer)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. def deleteLineage(id: String, clusterNodeId: Option[String] = None): ApiRequestT[LineageEntity]

    Permalink

    Expected answers: code 200 : LineageEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : LineageEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    id

    The id of the lineage query.

    clusterNodeId

    The id of the node where this query exists if clustered.

  7. def deleteProvenance(id: String, clusterNodeId: Option[String] = None): ApiRequestT[ProvenanceEntity]

    Permalink

    Expected answers: code 200 : ProvenanceEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : ProvenanceEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    id

    The id of the provenance query.

    clusterNodeId

    The id of the node where this query exists if clustered.

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  12. def getLineage(id: String, clusterNodeId: Option[String] = None): ApiRequestT[LineageEntity]

    Permalink

    Expected answers: code 200 : LineageEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : LineageEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    id

    The id of the lineage query.

    clusterNodeId

    The id of the node where this query exists if clustered.

  13. def getProvenance(id: String, clusterNodeId: Option[String] = None, summarize: Option[Boolean] = None, incrementalResults: Option[Boolean] = None): ApiRequestT[ProvenanceEntity]

    Permalink

    Expected answers: code 200 : ProvenanceEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : ProvenanceEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    id

    The id of the provenance query.

    clusterNodeId

    The id of the node where this query exists if clustered.

    summarize

    Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.

    incrementalResults

    Whether or not to summarize provenance events returned. This property is false by default.

  14. def getSearchOptions(): ApiRequestT[ProvenanceOptionsEntity]

    Permalink

    Expected answers: code 200 : ProvenanceOptionsEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid.

    Expected answers: code 200 : ProvenanceOptionsEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

  15. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  17. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  20. def submitLineageRequest(body: LineageEntity): ApiRequestT[LineageEntity]

    Permalink

    Lineage queries may be long running so this endpoint submits a request.

    Lineage queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the lineage request should be deleted by the client who originally submitted it.

    Expected answers: code 200 : LineageEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 404 : (The specified resource could not be found.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    body

    The lineage query details.

  21. def submitProvenanceRequest(body: ProvenanceEntity): ApiRequestT[ProvenanceEntity]

    Permalink

    Provenance queries may be long running so this endpoint submits a request.

    Provenance queries may be long running so this endpoint submits a request. The response will include the current state of the query. If the request is not completed the URI in the response can be used at a later time to get the updated state of the query. Once the query has completed the provenance request should be deleted by the client who originally submitted it.

    Expected answers: code 200 : ProvenanceEntity (successful operation) code 400 : (NiFi was unable to complete the request because it was invalid. The request should not be retried without modification.) code 401 : (Client could not be authenticated.) code 403 : (Client is not authorized to make this request.) code 409 : (The request was valid but NiFi was not in the appropriate state to process it. Retrying the same request later may be successful.)

    body

    The provenance query details.

  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  24. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped