Skip to content

Latest commit

 

History

History
101 lines (65 loc) · 4.19 KB

ExtensionsApi.md

File metadata and controls

101 lines (65 loc) · 4.19 KB

{{classname}}

All URIs are relative to /

Method HTTP request Description
GetExtensions Get /extensions Get all extensions
GetExtensionsProvidingServiceAPI Get /extensions/provided-service-api Get extensions providing service API
GetTags Get /extensions/tags Get extension tags

GetExtensions

ExtensionMetadataContainer GetExtensions(ctx, optional) Get all extensions

Gets the metadata for all extensions that match the filter params and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *ExtensionsApiGetExtensionsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ExtensionsApiGetExtensionsOpts struct

Name Type Description Notes
bundleType optional.string The type of bundles to return
extensionType optional.string The type of extensions to return
tag optional.Interface of []string The tags to filter on, will be used in an OR statement

Return type

ExtensionMetadataContainer

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetExtensionsProvidingServiceAPI

ExtensionMetadataContainer GetExtensionsProvidingServiceAPI(ctx, className, groupId, artifactId, version) Get extensions providing service API

Gets the metadata for extensions that provide the specified API and are part of bundles located in buckets the current user is authorized for. If the user is not authorized to any buckets, an empty result set will be returned. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
className string The name of the service API class
groupId string The groupId of the bundle containing the service API class
artifactId string The artifactId of the bundle containing the service API class
version string The version of the bundle containing the service API class

Return type

ExtensionMetadataContainer

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTags

[]TagCount GetTags(ctx, ) Get extension tags

Gets all the extension tags known to this NiFi Registry instance, along with the number of extensions that have the given tag. NOTE: This endpoint is subject to change as NiFi Registry and its REST API evolve.

Required Parameters

This endpoint does not need any parameter.

Return type

[]TagCount

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]