Class/Object

it.agilelab.bigdata.nifi.client.api

PoliciesApi

Related Docs: object PoliciesApi | package api

Permalink

class PoliciesApi extends AnyRef

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

Instance Constructors

  1. new PoliciesApi(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 createAccessPolicy(body: AccessPolicyEntity): ApiRequestT[AccessPolicyEntity]

    Permalink

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

    Expected answers: code 200 : AccessPolicyEntity (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 access policy configuration details.

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

    Permalink
    Definition Classes
    AnyRef

  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  9. def finalize(): Unit

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

  10. def getAccessPolicy(id: String): ApiRequestT[AccessPolicyEntity]

    Permalink

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

    Expected answers: code 200 : AccessPolicyEntity (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 access policy id.

  11. def getAccessPolicyForResource(action: String, resource: String): ApiRequestT[AccessPolicyEntity]

    Permalink

    Will return the effective policy if no component specific policy exists for the specified action and resource.

    Will return the effective policy if no component specific policy exists for the specified action and resource. Must have Read permissions to the policy with the desired action and resource. Permissions for the policy that is returned will be indicated in the response. This means the client could be authorized to get the policy for a given component but the effective policy may be inherited from an ancestor Process Group. If the client does not have permissions to that policy, the response will not include the policy and the permissions in the response will be marked accordingly. If the client does not have permissions to the policy of the desired action and resource a 403 response will be returned.

    Expected answers: code 200 : AccessPolicyEntity (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.)

    action

    The request action.

    resource

    The resource of the policy.

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

    Permalink
    Definition Classes
    AnyRef → Any

  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  18. def removeAccessPolicy(id: String, version: Option[String] = None, clientId: Option[String] = None, disconnectedNodeAcknowledged: Option[Boolean] = None): ApiRequestT[AccessPolicyEntity]

    Permalink

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

    Expected answers: code 200 : AccessPolicyEntity (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 access policy id.

    version

    The revision is used to verify the client is working with the latest version of the flow.

    clientId

    If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

    disconnectedNodeAcknowledged

    Acknowledges that this node is disconnected to allow for mutable requests to proceed.

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

    Permalink
    Definition Classes
    AnyRef

  20. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  21. def updateAccessPolicy(id: String, body: AccessPolicyEntity): ApiRequestT[AccessPolicyEntity]

    Permalink

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

    Expected answers: code 200 : AccessPolicyEntity (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 access policy id.

    body

    The access policy configuration details.

  22. final def wait(): Unit

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped