nifi

package module
v1.12.0-snapshot.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 10, 2020 License: Apache-2.0 Imports: 23 Imported by: 0

README ¶

Go API client for nifi

The Rest Api provides programmatic access to command and control a NiFi instance in real time. Start and stop processors, monitor queues, query provenance data, and more. Each endpoint below includes a description, definitions of the expected input and output, potential response codes, and the authorizations required to invoke each service.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.12.0-SNAPSHOT
  • Package version: 1.11.4
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://nifi.apache.org

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

Put the package under your project folder and add the following in import:

import "./nifi"

Documentation for API Endpoints

All URIs are relative to http://localhost/nifi-api

Class Method HTTP request Description
AccessApi CreateAccessToken Post /access/token Creates a token for accessing the REST API via username/password
AccessApi CreateAccessTokenFromTicket Post /access/kerberos Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation
AccessApi CreateDownloadToken Post /access/download-token Creates a single use access token for downloading FlowFile content.
AccessApi CreateUiExtensionToken Post /access/ui-extension-token Creates a single use access token for accessing a NiFi UI extension.
AccessApi GetAccessStatus Get /access Gets the status the client's access
AccessApi GetLoginConfig Get /access/config Retrieves the access configuration for this NiFi
AccessApi KnoxCallback Get /access/knox/callback Redirect/callback URI for processing the result of the Apache Knox login sequence.
AccessApi KnoxLogout Get /access/knox/logout Performs a logout in the Apache Knox.
AccessApi KnoxRequest Get /access/knox/request Initiates a request to authenticate through Apache Knox.
AccessApi LogOut Delete /access/logout Performs a logout for other providers that have been issued a JWT.
AccessApi OidcCallback Get /access/oidc/callback Redirect/callback URI for processing the result of the OpenId Connect login sequence.
AccessApi OidcExchange Post /access/oidc/exchange Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider.
AccessApi OidcLogout Get /access/oidc/logout Performs a logout in the OpenId Provider.
AccessApi OidcRequest Get /access/oidc/request Initiates a request to authenticate through the configured OpenId Connect provider.
ConnectionsApi DeleteConnection Delete /connections/{id} Deletes a connection
ConnectionsApi GetConnection Get /connections/{id} Gets a connection
ConnectionsApi UpdateConnection Put /connections/{id} Updates a connection
ControllerApi CreateBulletin Post /controller/bulletin Creates a new bulletin
ControllerApi CreateControllerService Post /controller/controller-services Creates a new controller service
ControllerApi CreateRegistryClient Post /controller/registry-clients Creates a new registry client
ControllerApi CreateReportingTask Post /controller/reporting-tasks Creates a new reporting task
ControllerApi DeleteHistory Delete /controller/history Purges history
ControllerApi DeleteNode Delete /controller/cluster/nodes/{id} Removes a node from the cluster
ControllerApi DeleteRegistryClient Delete /controller/registry-clients/{id} Deletes a registry client
ControllerApi GetCluster Get /controller/cluster Gets the contents of the cluster
ControllerApi GetControllerConfig Get /controller/config Retrieves the configuration for this NiFi Controller
ControllerApi GetNode Get /controller/cluster/nodes/{id} Gets a node in the cluster
ControllerApi GetRegistryClient Get /controller/registry-clients/{id} Gets a registry client
ControllerApi GetRegistryClients Get /controller/registry-clients Gets the listing of available registry clients
ControllerApi UpdateControllerConfig Put /controller/config Retrieves the configuration for this NiFi
ControllerApi UpdateNode Put /controller/cluster/nodes/{id} Updates a node in the cluster
ControllerApi UpdateRegistryClient Put /controller/registry-clients/{id} Updates a registry client
ControllerServicesApi ClearState Post /controller-services/{id}/state/clear-requests Clears the state for a controller service
ControllerServicesApi GetControllerService Get /controller-services/{id} Gets a controller service
ControllerServicesApi GetControllerServiceReferences Get /controller-services/{id}/references Gets a controller service
ControllerServicesApi GetPropertyDescriptor Get /controller-services/{id}/descriptors Gets a controller service property descriptor
ControllerServicesApi GetState Get /controller-services/{id}/state Gets the state for a controller service
ControllerServicesApi RemoveControllerService Delete /controller-services/{id} Deletes a controller service
ControllerServicesApi UpdateControllerService Put /controller-services/{id} Updates a controller service
ControllerServicesApi UpdateControllerServiceReferences Put /controller-services/{id}/references Updates a controller services references
ControllerServicesApi UpdateRunStatus Put /controller-services/{id}/run-status Updates run status of a controller service
CountersApi GetCounters Get /counters Gets the current counters for this NiFi
CountersApi UpdateCounter Put /counters/{id} Updates the specified counter. This will reset the counter value to 0
DataTransferApi CommitInputPortTransaction Delete /data-transfer/input-ports/{portId}/transactions/{transactionId} Commit or cancel the specified transaction
DataTransferApi CommitOutputPortTransaction Delete /data-transfer/output-ports/{portId}/transactions/{transactionId} Commit or cancel the specified transaction
DataTransferApi CreatePortTransaction Post /data-transfer/{portType}/{portId}/transactions Create a transaction to the specified output port or input port
DataTransferApi ExtendInputPortTransactionTTL Put /data-transfer/input-ports/{portId}/transactions/{transactionId} Extend transaction TTL
DataTransferApi ExtendOutputPortTransactionTTL Put /data-transfer/output-ports/{portId}/transactions/{transactionId} Extend transaction TTL
DataTransferApi ReceiveFlowFiles Post /data-transfer/input-ports/{portId}/transactions/{transactionId}/flow-files Transfer flow files to the input port
DataTransferApi TransferFlowFiles Get /data-transfer/output-ports/{portId}/transactions/{transactionId}/flow-files Transfer flow files from the output port
FlowApi ActivateControllerServices Put /flow/process-groups/{id}/controller-services Enable or disable Controller Services in the specified Process Group.
FlowApi GenerateClientId Get /flow/client-id Generates a client id.
FlowApi GetAboutInfo Get /flow/about Retrieves details about this NiFi to put in the About dialog
FlowApi GetAction Get /flow/history/{id} Gets an action
FlowApi GetBanners Get /flow/banners Retrieves the banners for this NiFi
FlowApi GetBuckets Get /flow/registries/{id}/buckets Gets the buckets from the specified registry for the current user
FlowApi GetBulletinBoard Get /flow/bulletin-board Gets current bulletins
FlowApi GetBulletins Get /flow/controller/bulletins Retrieves Controller level bulletins
FlowApi GetClusterSummary Get /flow/cluster/summary The cluster summary for this NiFi
FlowApi GetComponentHistory Get /flow/history/components/{componentId} Gets configuration history for a component
FlowApi GetConnectionStatistics Get /flow/connections/{id}/statistics Gets statistics for a connection
FlowApi GetConnectionStatus Get /flow/connections/{id}/status Gets status for a connection
FlowApi GetConnectionStatusHistory Get /flow/connections/{id}/status/history Gets the status history for a connection
FlowApi GetControllerServiceTypes Get /flow/controller-service-types Retrieves the types of controller services that this NiFi supports
FlowApi GetControllerServicesFromController Get /flow/controller/controller-services Gets controller services for reporting tasks
FlowApi GetControllerServicesFromGroup Get /flow/process-groups/{id}/controller-services Gets all controller services
FlowApi GetControllerStatus Get /flow/status Gets the current status of this NiFi
FlowApi GetCurrentUser Get /flow/current-user Retrieves the user identity of the user making the request
FlowApi GetFlow Get /flow/process-groups/{id} Gets a process group
FlowApi GetFlowConfig Get /flow/config Retrieves the configuration for this NiFi flow
FlowApi GetFlowMetrics Get /flow/metrics/{producer} Gets all metrics for the flow from a particular node
FlowApi GetFlows Get /flow/registries/{registry-id}/buckets/{bucket-id}/flows Gets the flows from the specified registry and bucket for the current user
FlowApi GetInputPortStatus Get /flow/input-ports/{id}/status Gets status for an input port
FlowApi GetOutputPortStatus Get /flow/output-ports/{id}/status Gets status for an output port
FlowApi GetParameterContexts Get /flow/parameter-contexts Gets all Parameter Contexts
FlowApi GetPrioritizers Get /flow/prioritizers Retrieves the types of prioritizers that this NiFi supports
FlowApi GetProcessGroupStatus Get /flow/process-groups/{id}/status Gets the status for a process group
FlowApi GetProcessGroupStatusHistory Get /flow/process-groups/{id}/status/history Gets status history for a remote process group
FlowApi GetProcessorStatus Get /flow/processors/{id}/status Gets status for a processor
FlowApi GetProcessorStatusHistory Get /flow/processors/{id}/status/history Gets status history for a processor
FlowApi GetProcessorTypes Get /flow/processor-types Retrieves the types of processors that this NiFi supports
FlowApi GetRegistries Get /flow/registries Gets the listing of available registries
FlowApi GetRemoteProcessGroupStatus Get /flow/remote-process-groups/{id}/status Gets status for a remote process group
FlowApi GetRemoteProcessGroupStatusHistory Get /flow/remote-process-groups/{id}/status/history Gets the status history
FlowApi GetReportingTaskTypes Get /flow/reporting-task-types Retrieves the types of reporting tasks that this NiFi supports
FlowApi GetReportingTasks Get /flow/reporting-tasks Gets all reporting tasks
FlowApi GetTemplates Get /flow/templates Gets all templates
FlowApi GetVersions Get /flow/registries/{registry-id}/buckets/{bucket-id}/flows/{flow-id}/versions Gets the flow versions from the specified registry and bucket for the specified flow for the current user
FlowApi QueryHistory Get /flow/history Gets configuration history
FlowApi ScheduleComponents Put /flow/process-groups/{id} Schedule or unschedule components in the specified Process Group.
FlowApi SearchCluster Get /flow/cluster/search-results Searches the cluster for a node with the specified address
FlowApi SearchFlow Get /flow/search-results Performs a search against this NiFi using the specified search term
FlowfileQueuesApi CreateDropRequest Post /flowfile-queues/{id}/drop-requests Creates a request to drop the contents of the queue in this connection.
FlowfileQueuesApi CreateFlowFileListing Post /flowfile-queues/{id}/listing-requests Lists the contents of the queue in this connection.
FlowfileQueuesApi DeleteListingRequest Delete /flowfile-queues/{id}/listing-requests/{listing-request-id} Cancels and/or removes a request to list the contents of this connection.
FlowfileQueuesApi DownloadFlowFileContent Get /flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content Gets the content for a FlowFile in a Connection.
FlowfileQueuesApi GetDropRequest Get /flowfile-queues/{id}/drop-requests/{drop-request-id} Gets the current status of a drop request for the specified connection.
FlowfileQueuesApi GetFlowFile Get /flowfile-queues/{id}/flowfiles/{flowfile-uuid} Gets a FlowFile from a Connection.
FlowfileQueuesApi GetListingRequest Get /flowfile-queues/{id}/listing-requests/{listing-request-id} Gets the current status of a listing request for the specified connection.
FlowfileQueuesApi RemoveDropRequest Delete /flowfile-queues/{id}/drop-requests/{drop-request-id} Cancels and/or removes a request to drop the contents of this connection.
FunnelApi GetFunnel Get /funnels/{id} Gets a funnel
FunnelApi RemoveFunnel Delete /funnels/{id} Deletes a funnel
FunnelApi UpdateFunnel Put /funnels/{id} Updates a funnel
InputPortsApi GetInputPort Get /input-ports/{id} Gets an input port
InputPortsApi RemoveInputPort Delete /input-ports/{id} Deletes an input port
InputPortsApi UpdateInputPort Put /input-ports/{id} Updates an input port
InputPortsApi UpdateRunStatus Put /input-ports/{id}/run-status Updates run status of an input-port
LabelsApi GetLabel Get /labels/{id} Gets a label
LabelsApi RemoveLabel Delete /labels/{id} Deletes a label
LabelsApi UpdateLabel Put /labels/{id} Updates a label
OutputPortsApi GetOutputPort Get /output-ports/{id} Gets an output port
OutputPortsApi RemoveOutputPort Delete /output-ports/{id} Deletes an output port
OutputPortsApi UpdateOutputPort Put /output-ports/{id} Updates an output port
OutputPortsApi UpdateRunStatus Put /output-ports/{id}/run-status Updates run status of an output-port
ParameterContextsApi CreateParameterContext Post /parameter-contexts Create a Parameter Context
ParameterContextsApi DeleteParameterContext Delete /parameter-contexts/{id} Deletes the Parameter Context with the given ID
ParameterContextsApi DeleteUpdateRequest Delete /parameter-contexts/{contextId}/update-requests/{requestId} Deletes the Update Request with the given ID
ParameterContextsApi DeleteValidationRequest Delete /parameter-contexts/{contextId}/validation-requests/{id} Deletes the Validation Request with the given ID
ParameterContextsApi GetParameterContext Get /parameter-contexts/{id} Returns the Parameter Context with the given ID
ParameterContextsApi GetParameterContextUpdate Get /parameter-contexts/{contextId}/update-requests/{requestId} Returns the Update Request with the given ID
ParameterContextsApi GetValidationRequest Get /parameter-contexts/{contextId}/validation-requests/{id} Returns the Validation Request with the given ID
ParameterContextsApi SubmitParameterContextUpdate Post /parameter-contexts/{contextId}/update-requests Initiate the Update Request of a Parameter Context
ParameterContextsApi SubmitValidationRequest Post /parameter-contexts/{contextId}/validation-requests Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated
ParameterContextsApi UpdateParameterContext Put /parameter-contexts/{id} Modifies a Parameter Context
PoliciesApi CreateAccessPolicy Post /policies Creates an access policy
PoliciesApi GetAccessPolicy Get /policies/{id} Gets an access policy
PoliciesApi GetAccessPolicyForResource Get /policies/{action}/{resource} Gets an access policy for the specified action and resource
PoliciesApi RemoveAccessPolicy Delete /policies/{id} Deletes an access policy
PoliciesApi UpdateAccessPolicy Put /policies/{id} Updates a access policy
ProcessGroupsApi CopySnippet Post /process-groups/{id}/snippet-instance Copies a snippet and discards it.
ProcessGroupsApi CreateConnection Post /process-groups/{id}/connections Creates a connection
ProcessGroupsApi CreateControllerService Post /process-groups/{id}/controller-services Creates a new controller service
ProcessGroupsApi CreateFunnel Post /process-groups/{id}/funnels Creates a funnel
ProcessGroupsApi CreateInputPort Post /process-groups/{id}/input-ports Creates an input port
ProcessGroupsApi CreateLabel Post /process-groups/{id}/labels Creates a label
ProcessGroupsApi CreateOutputPort Post /process-groups/{id}/output-ports Creates an output port
ProcessGroupsApi CreateProcessGroup Post /process-groups/{id}/process-groups Creates a process group
ProcessGroupsApi CreateProcessor Post /process-groups/{id}/processors Creates a new processor
ProcessGroupsApi CreateRemoteProcessGroup Post /process-groups/{id}/remote-process-groups Creates a new process group
ProcessGroupsApi CreateTemplate Post /process-groups/{id}/templates Creates a template and discards the specified snippet.
ProcessGroupsApi DeleteReplaceProcessGroupRequest Delete /process-groups/replace-requests/{id} Deletes the Replace Request with the given ID
ProcessGroupsApi DeleteVariableRegistryUpdateRequest Delete /process-groups/{groupId}/variable-registry/update-requests/{updateId} Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled.
ProcessGroupsApi ExportProcessGroup Get /process-groups/{id}/download Gets a process group for download
ProcessGroupsApi GetConnections Get /process-groups/{id}/connections Gets all connections
ProcessGroupsApi GetFunnels Get /process-groups/{id}/funnels Gets all funnels
ProcessGroupsApi GetInputPorts Get /process-groups/{id}/input-ports Gets all input ports
ProcessGroupsApi GetLabels Get /process-groups/{id}/labels Gets all labels
ProcessGroupsApi GetLocalModifications Get /process-groups/{id}/local-modifications Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry
ProcessGroupsApi GetOutputPorts Get /process-groups/{id}/output-ports Gets all output ports
ProcessGroupsApi GetProcessGroup Get /process-groups/{id} Gets a process group
ProcessGroupsApi GetProcessGroups Get /process-groups/{id}/process-groups Gets all process groups
ProcessGroupsApi GetProcessors Get /process-groups/{id}/processors Gets all processors
ProcessGroupsApi GetRemoteProcessGroups Get /process-groups/{id}/remote-process-groups Gets all remote process groups
ProcessGroupsApi GetReplaceProcessGroupRequest Get /process-groups/replace-requests/{id} Returns the Replace Request with the given ID
ProcessGroupsApi GetVariableRegistry Get /process-groups/{id}/variable-registry Gets a process group's variable registry
ProcessGroupsApi GetVariableRegistryUpdateRequest Get /process-groups/{groupId}/variable-registry/update-requests/{updateId} Gets a process group's variable registry
ProcessGroupsApi ImportTemplate Post /process-groups/{id}/templates/import Imports a template
ProcessGroupsApi InitiateReplaceProcessGroup Post /process-groups/{id}/replace-requests Initiate the Replace Request of a Process Group with the given ID
ProcessGroupsApi InstantiateTemplate Post /process-groups/{id}/template-instance Instantiates a template
ProcessGroupsApi RemoveProcessGroup Delete /process-groups/{id} Deletes a process group
ProcessGroupsApi ReplaceProcessGroup Put /process-groups/{id}/flow-contents Replace Process Group contents with the given ID with the specified Process Group contents
ProcessGroupsApi SubmitUpdateVariableRegistryRequest Post /process-groups/{id}/variable-registry/update-requests Submits a request to update a process group's variable registry
ProcessGroupsApi UpdateProcessGroup Put /process-groups/{id} Updates a process group
ProcessGroupsApi UpdateVariableRegistry Put /process-groups/{id}/variable-registry Updates the contents of a Process Group's variable Registry
ProcessGroupsApi UploadTemplate Post /process-groups/{id}/templates/upload Uploads a template
ProcessorsApi ClearState Post /processors/{id}/state/clear-requests Clears the state for a processor
ProcessorsApi DeleteProcessor Delete /processors/{id} Deletes a processor
ProcessorsApi GetProcessor Get /processors/{id} Gets a processor
ProcessorsApi GetProcessorDiagnostics Get /processors/{id}/diagnostics Gets diagnostics information about a processor
ProcessorsApi GetProcessorRunStatusDetails Post /processors/run-status-details/queries Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs
ProcessorsApi GetPropertyDescriptor Get /processors/{id}/descriptors Gets the descriptor for a processor property
ProcessorsApi GetState Get /processors/{id}/state Gets the state for a processor
ProcessorsApi TerminateProcessor Delete /processors/{id}/threads Terminates a processor, essentially "deleting" its threads and any active tasks
ProcessorsApi UpdateProcessor Put /processors/{id} Updates a processor
ProcessorsApi UpdateRunStatus Put /processors/{id}/run-status Updates run status of a processor
ProvenanceApi DeleteLineage Delete /provenance/lineage/{id} Deletes a lineage query
ProvenanceApi DeleteProvenance Delete /provenance/{id} Deletes a provenance query
ProvenanceApi GetLineage Get /provenance/lineage/{id} Gets a lineage query
ProvenanceApi GetProvenance Get /provenance/{id} Gets a provenance query
ProvenanceApi GetSearchOptions Get /provenance/search-options Gets the searchable attributes for provenance events
ProvenanceApi SubmitLineageRequest Post /provenance/lineage Submits a lineage query
ProvenanceApi SubmitProvenanceRequest Post /provenance Submits a provenance query
ProvenanceEventsApi GetInputContent Get /provenance-events/{id}/content/input Gets the input content for a provenance event
ProvenanceEventsApi GetOutputContent Get /provenance-events/{id}/content/output Gets the output content for a provenance event
ProvenanceEventsApi GetProvenanceEvent Get /provenance-events/{id} Gets a provenance event
ProvenanceEventsApi SubmitReplay Post /provenance-events/replays Replays content from a provenance event
RemoteProcessGroupsApi GetRemoteProcessGroup Get /remote-process-groups/{id} Gets a remote process group
RemoteProcessGroupsApi GetState Get /remote-process-groups/{id}/state Gets the state for a RemoteProcessGroup
RemoteProcessGroupsApi RemoveRemoteProcessGroup Delete /remote-process-groups/{id} Deletes a remote process group
RemoteProcessGroupsApi UpdateRemoteProcessGroup Put /remote-process-groups/{id} Updates a remote process group
RemoteProcessGroupsApi UpdateRemoteProcessGroupInputPort Put /remote-process-groups/{id}/input-ports/{port-id} Updates a remote port
RemoteProcessGroupsApi UpdateRemoteProcessGroupInputPortRunStatus Put /remote-process-groups/{id}/input-ports/{port-id}/run-status Updates run status of a remote port
RemoteProcessGroupsApi UpdateRemoteProcessGroupOutputPort Put /remote-process-groups/{id}/output-ports/{port-id} Updates a remote port
RemoteProcessGroupsApi UpdateRemoteProcessGroupOutputPortRunStatus Put /remote-process-groups/{id}/output-ports/{port-id}/run-status Updates run status of a remote port
RemoteProcessGroupsApi UpdateRemoteProcessGroupRunStatus Put /remote-process-groups/{id}/run-status Updates run status of a remote process group
ReportingTasksApi ClearState Post /reporting-tasks/{id}/state/clear-requests Clears the state for a reporting task
ReportingTasksApi GetPropertyDescriptor Get /reporting-tasks/{id}/descriptors Gets a reporting task property descriptor
ReportingTasksApi GetReportingTask Get /reporting-tasks/{id} Gets a reporting task
ReportingTasksApi GetState Get /reporting-tasks/{id}/state Gets the state for a reporting task
ReportingTasksApi RemoveReportingTask Delete /reporting-tasks/{id} Deletes a reporting task
ReportingTasksApi UpdateReportingTask Put /reporting-tasks/{id} Updates a reporting task
ReportingTasksApi UpdateRunStatus Put /reporting-tasks/{id}/run-status Updates run status of a reporting task
ResourcesApi GetResources Get /resources Gets the available resources that support access/authorization policies
SiteToSiteApi GetPeers Get /site-to-site/peers Returns the available Peers and its status of this NiFi
SiteToSiteApi GetSiteToSiteDetails Get /site-to-site Returns the details about this NiFi necessary to communicate via site to site
SnippetsApi CreateSnippet Post /snippets Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.
SnippetsApi DeleteSnippet Delete /snippets/{id} Deletes the components in a snippet and discards the snippet
SnippetsApi UpdateSnippet Put /snippets/{id} Move's the components in this Snippet into a new Process Group and discards the snippet
SystemDiagnosticsApi GetSystemDiagnostics Get /system-diagnostics Gets the diagnostics for the system NiFi is running on
TemplatesApi ExportTemplate Get /templates/{id}/download Exports a template
TemplatesApi RemoveTemplate Delete /templates/{id} Deletes a template
TenantsApi CreateUser Post /tenants/users Creates a user
TenantsApi CreateUserGroup Post /tenants/user-groups Creates a user group
TenantsApi GetUser Get /tenants/users/{id} Gets a user
TenantsApi GetUserGroup Get /tenants/user-groups/{id} Gets a user group
TenantsApi GetUserGroups Get /tenants/user-groups Gets all user groups
TenantsApi GetUsers Get /tenants/users Gets all users
TenantsApi RemoveUser Delete /tenants/users/{id} Deletes a user
TenantsApi RemoveUserGroup Delete /tenants/user-groups/{id} Deletes a user group
TenantsApi SearchTenants Get /tenants/search-results Searches for a tenant with the specified identity
TenantsApi UpdateUser Put /tenants/users/{id} Updates a user
TenantsApi UpdateUserGroup Put /tenants/user-groups/{id} Updates a user group
VersionsApi CreateVersionControlRequest Post /versions/active-requests Create a version control request
VersionsApi DeleteRevertRequest Delete /versions/revert-requests/{id} Deletes the Revert Request with the given ID
VersionsApi DeleteUpdateRequest Delete /versions/update-requests/{id} Deletes the Update Request with the given ID
VersionsApi DeleteVersionControlRequest Delete /versions/active-requests/{id} Deletes the version control request with the given ID
VersionsApi ExportFlowVersion Get /versions/process-groups/{id}/download Gets the latest version of a Process Group for download
VersionsApi GetRevertRequest Get /versions/revert-requests/{id} Returns the Revert Request with the given ID
VersionsApi GetUpdateRequest Get /versions/update-requests/{id} Returns the Update Request with the given ID
VersionsApi GetVersionInformation Get /versions/process-groups/{id} Gets the Version Control information for a process group
VersionsApi InitiateRevertFlowVersion Post /versions/revert-requests/process-groups/{id} Initiate the Revert Request of a Process Group with the given ID
VersionsApi InitiateVersionControlUpdate Post /versions/update-requests/process-groups/{id} Initiate the Update Request of a Process Group with the given ID
VersionsApi SaveToFlowRegistry Post /versions/process-groups/{id} Save the Process Group with the given ID
VersionsApi StopVersionControl Delete /versions/process-groups/{id} Stops version controlling the Process Group with the given ID
VersionsApi UpdateFlowVersion Put /versions/process-groups/{id} Update the version of a Process Group with the given ID
VersionsApi UpdateVersionControlRequest Put /versions/active-requests/{id} Updates the request with the given ID

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

dev@nifi.apache.org

Documentation ¶

Index ¶

Constants ¶

This section is empty.

Variables ¶

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶ 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶ 

type APIClient struct {
	AccessApi *AccessApiService

	ConnectionsApi *ConnectionsApiService

	ControllerApi *ControllerApiService

	ControllerServicesApi *ControllerServicesApiService

	CountersApi *CountersApiService

	DataTransferApi *DataTransferApiService

	FlowApi *FlowApiService

	FlowfileQueuesApi *FlowfileQueuesApiService

	FunnelApi *FunnelApiService

	InputPortsApi *InputPortsApiService

	LabelsApi *LabelsApiService

	OutputPortsApi *OutputPortsApiService

	ParameterContextsApi *ParameterContextsApiService

	PoliciesApi *PoliciesApiService

	ProcessGroupsApi *ProcessGroupsApiService

	ProcessorsApi *ProcessorsApiService

	ProvenanceApi *ProvenanceApiService

	ProvenanceEventsApi *ProvenanceEventsApiService

	RemoteProcessGroupsApi *RemoteProcessGroupsApiService

	ReportingTasksApi *ReportingTasksApiService

	ResourcesApi *ResourcesApiService

	SiteToSiteApi *SiteToSiteApiService

	SnippetsApi *SnippetsApiService

	SystemDiagnosticsApi *SystemDiagnosticsApiService

	TemplatesApi *TemplatesApiService

	TenantsApi *TenantsApiService

	VersionsApi *VersionsApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the NiFi Rest Api API v1.12.0-SNAPSHOT In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶ 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶ 

func (c *APIClient) ChangeBasePath(path string)

ChangeBasePath changes base path to allow switching to mocks

func (*APIClient) GetConfig ¶ 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey ¶ 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶ 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse ¶ 

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResonse object.

func NewAPIResponseWithError ¶ 

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type AboutDto ¶ 

type AboutDto struct {
	// The title to be used on the page and in the about dialog.
	Title string `json:"title,omitempty"`
	// The version of this NiFi.
	Version string `json:"version,omitempty"`
	// The URI for the NiFi.
	Uri string `json:"uri,omitempty"`
	// The URL for the content viewer if configured.
	ContentViewerUrl string `json:"contentViewerUrl,omitempty"`
	// The timezone of the NiFi instance.
	Timezone string `json:"timezone,omitempty"`
	// Build tag
	BuildTag string `json:"buildTag,omitempty"`
	// Build revision or commit hash
	BuildRevision string `json:"buildRevision,omitempty"`
	// Build branch
	BuildBranch string `json:"buildBranch,omitempty"`
	// Build timestamp
	BuildTimestamp string `json:"buildTimestamp,omitempty"`
}

AboutDto struct for AboutDto

type AboutEntity ¶ 

type AboutEntity struct {
	About AboutDto `json:"about,omitempty"`
}

AboutEntity struct for AboutEntity

type AccessApiCreateAccessTokenOpts ¶ 

type AccessApiCreateAccessTokenOpts struct {
	Username optional.String
	Password optional.String
}

AccessApiCreateAccessTokenOpts Optional parameters for the method 'CreateAccessToken'

type AccessApiService ¶ 

type AccessApiService service

AccessApiService AccessApi service

func (*AccessApiService) CreateAccessToken ¶ 

func (a *AccessApiService) CreateAccessToken(ctx _context.Context, localVarOptionals *AccessApiCreateAccessTokenOpts) (string, *_nethttp.Response, error)

CreateAccessToken Creates a token for accessing the REST API via username/password The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer <token>'.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AccessApiCreateAccessTokenOpts - Optional Parameters:
  • @param "Username" (optional.String) -
  • @param "Password" (optional.String) -

@return string

func (*AccessApiService) CreateAccessTokenFromTicket ¶ 

func (a *AccessApiService) CreateAccessTokenFromTicket(ctx _context.Context) (string, *_nethttp.Response, error)

CreateAccessTokenFromTicket Creates a token for accessing the REST API via Kerberos ticket exchange / SPNEGO negotiation The token returned is formatted as a JSON Web Token (JWT). The token is base64 encoded and comprised of three parts. The header, the body, and the signature. The expiration of the token is a contained within the body. The token can be used in the Authorization header in the format 'Authorization: Bearer <token>'.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return string

func (*AccessApiService) CreateDownloadToken ¶ 

func (a *AccessApiService) CreateDownloadToken(ctx _context.Context) (string, *_nethttp.Response, error)

CreateDownloadToken Creates a single use access token for downloading FlowFile content. The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return string

func (*AccessApiService) CreateUiExtensionToken ¶ 

func (a *AccessApiService) CreateUiExtensionToken(ctx _context.Context) (string, *_nethttp.Response, error)

CreateUiExtensionToken Creates a single use access token for accessing a NiFi UI extension. The token returned is a base64 encoded string. It is valid for a single request up to five minutes from being issued. It is used as a query parameter name 'access_token'.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return string

func (*AccessApiService) GetAccessStatus ¶ 

func (a *AccessApiService) GetAccessStatus(ctx _context.Context) (AccessStatusEntity, *_nethttp.Response, error)

GetAccessStatus Gets the status the client's access Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return AccessStatusEntity

func (*AccessApiService) GetLoginConfig ¶ 

func (a *AccessApiService) GetLoginConfig(ctx _context.Context) (AccessConfigurationEntity, *_nethttp.Response, error)

GetLoginConfig Retrieves the access configuration for this NiFi

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return AccessConfigurationEntity

func (*AccessApiService) KnoxCallback ¶ 

func (a *AccessApiService) KnoxCallback(ctx _context.Context) (*_nethttp.Response, error)

KnoxCallback Redirect/callback URI for processing the result of the Apache Knox login sequence. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*AccessApiService) KnoxLogout ¶ 

func (a *AccessApiService) KnoxLogout(ctx _context.Context) (*_nethttp.Response, error)

KnoxLogout Performs a logout in the Apache Knox. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*AccessApiService) KnoxRequest ¶ 

func (a *AccessApiService) KnoxRequest(ctx _context.Context) (*_nethttp.Response, error)

KnoxRequest Initiates a request to authenticate through Apache Knox. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*AccessApiService) LogOut ¶ 

func (a *AccessApiService) LogOut(ctx _context.Context) (*_nethttp.Response, error)

LogOut Performs a logout for other providers that have been issued a JWT. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*AccessApiService) OidcCallback ¶ 

func (a *AccessApiService) OidcCallback(ctx _context.Context) (*_nethttp.Response, error)

OidcCallback Redirect/callback URI for processing the result of the OpenId Connect login sequence. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*AccessApiService) OidcExchange ¶ 

func (a *AccessApiService) OidcExchange(ctx _context.Context) (string, *_nethttp.Response, error)

OidcExchange Retrieves a JWT following a successful login sequence using the configured OpenId Connect provider. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return string

func (*AccessApiService) OidcLogout ¶ 

func (a *AccessApiService) OidcLogout(ctx _context.Context) (*_nethttp.Response, error)

OidcLogout Performs a logout in the OpenId Provider. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

func (*AccessApiService) OidcRequest ¶ 

func (a *AccessApiService) OidcRequest(ctx _context.Context) (*_nethttp.Response, error)

OidcRequest Initiates a request to authenticate through the configured OpenId Connect provider. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

type AccessConfigurationDto ¶ 

type AccessConfigurationDto struct {
	// Indicates whether or not this NiFi supports user login.
	SupportsLogin bool `json:"supportsLogin,omitempty"`
}

AccessConfigurationDto struct for AccessConfigurationDto

type AccessConfigurationEntity ¶ 

type AccessConfigurationEntity struct {
	Config AccessConfigurationDto `json:"config,omitempty"`
}

AccessConfigurationEntity struct for AccessConfigurationEntity

type AccessPolicyDto ¶ 

type AccessPolicyDto struct {
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The ID of the corresponding component that is under version control
	VersionedComponentId string `json:"versionedComponentId,omitempty"`
	// The id of parent process group of this component if applicable.
	ParentGroupId string      `json:"parentGroupId,omitempty"`
	Position      PositionDto `json:"position,omitempty"`
	// The resource for this access policy.
	Resource string `json:"resource,omitempty"`
	// The action associated with this access policy.
	Action             string                   `json:"action,omitempty"`
	ComponentReference ComponentReferenceEntity `json:"componentReference,omitempty"`
	// Whether this policy is configurable.
	Configurable bool `json:"configurable,omitempty"`
	// The set of user IDs associated with this access policy.
	Users []TenantEntity `json:"users,omitempty"`
	// The set of user group IDs associated with this access policy.
	UserGroups []TenantEntity `json:"userGroups,omitempty"`
}

AccessPolicyDto struct for AccessPolicyDto

type AccessPolicyEntity ¶ 

type AccessPolicyEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The URI for futures requests to the component.
	Uri         string         `json:"uri,omitempty"`
	Position    PositionDto    `json:"position,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
	// The bulletins for this component.
	Bulletins []BulletinEntity `json:"bulletins,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool `json:"disconnectedNodeAcknowledged,omitempty"`
	// When this content was generated.
	Generated string          `json:"generated,omitempty"`
	Component AccessPolicyDto `json:"component,omitempty"`
}

AccessPolicyEntity struct for AccessPolicyEntity

type AccessPolicySummaryDto ¶ 

type AccessPolicySummaryDto struct {
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The ID of the corresponding component that is under version control
	VersionedComponentId string `json:"versionedComponentId,omitempty"`
	// The id of parent process group of this component if applicable.
	ParentGroupId string      `json:"parentGroupId,omitempty"`
	Position      PositionDto `json:"position,omitempty"`
	// The resource for this access policy.
	Resource string `json:"resource,omitempty"`
	// The action associated with this access policy.
	Action             string                   `json:"action,omitempty"`
	ComponentReference ComponentReferenceEntity `json:"componentReference,omitempty"`
	// Whether this policy is configurable.
	Configurable bool `json:"configurable,omitempty"`
}

AccessPolicySummaryDto struct for AccessPolicySummaryDto

type AccessPolicySummaryEntity ¶ 

type AccessPolicySummaryEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The URI for futures requests to the component.
	Uri         string         `json:"uri,omitempty"`
	Position    PositionDto    `json:"position,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
	// The bulletins for this component.
	Bulletins []BulletinEntity `json:"bulletins,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool                   `json:"disconnectedNodeAcknowledged,omitempty"`
	Component                    AccessPolicySummaryDto `json:"component,omitempty"`
}

AccessPolicySummaryEntity struct for AccessPolicySummaryEntity

type AccessStatusDto ¶ 

type AccessStatusDto struct {
	// The user identity.
	Identity string `json:"identity,omitempty"`
	// The user access status.
	Status string `json:"status,omitempty"`
	// Additional details about the user access status.
	Message string `json:"message,omitempty"`
}

AccessStatusDto struct for AccessStatusDto

type AccessStatusEntity ¶ 

type AccessStatusEntity struct {
	AccessStatus AccessStatusDto `json:"accessStatus,omitempty"`
}

AccessStatusEntity struct for AccessStatusEntity

type ActionDto ¶ 

type ActionDto struct {
	// The action id.
	Id int32 `json:"id,omitempty"`
	// The identity of the user that performed the action.
	UserIdentity string `json:"userIdentity,omitempty"`
	// The timestamp of the action.
	Timestamp string `json:"timestamp,omitempty"`
	// The id of the source component.
	SourceId string `json:"sourceId,omitempty"`
	// The name of the source component.
	SourceName string `json:"sourceName,omitempty"`
	// The type of the source component.
	SourceType       string                 `json:"sourceType,omitempty"`
	ComponentDetails map[string]interface{} `json:"componentDetails,omitempty"`
	// The operation that was performed.
	Operation     string                 `json:"operation,omitempty"`
	ActionDetails map[string]interface{} `json:"actionDetails,omitempty"`
}

ActionDto struct for ActionDto

type ActionEntity ¶ 

type ActionEntity struct {
	Id int32 `json:"id,omitempty"`
	// The timestamp of the action.
	Timestamp string `json:"timestamp,omitempty"`
	SourceId  string `json:"sourceId,omitempty"`
	// Indicates whether the user can read a given resource.
	CanRead bool      `json:"canRead,omitempty"`
	Action  ActionDto `json:"action,omitempty"`
}

ActionEntity struct for ActionEntity

type ActivateControllerServicesEntity ¶ 

type ActivateControllerServicesEntity struct {
	// The id of the ProcessGroup
	Id string `json:"id,omitempty"`
	// The desired state of the descendant components
	State string `json:"state,omitempty"`
	// Optional services to schedule. If not specified, all authorized descendant controller services will be used.
	Components map[string]RevisionDto `json:"components,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool `json:"disconnectedNodeAcknowledged,omitempty"`
}

ActivateControllerServicesEntity struct for ActivateControllerServicesEntity

type AffectedComponentDto ¶ 

type AffectedComponentDto struct {
	// The UUID of the Process Group that this component is in
	ProcessGroupId string `json:"processGroupId,omitempty"`
	// The UUID of this component
	Id string `json:"id,omitempty"`
	// The type of this component
	ReferenceType string `json:"referenceType,omitempty"`
	// The name of this component.
	Name string `json:"name,omitempty"`
	// The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state.
	State string `json:"state,omitempty"`
	// The number of active threads for the referencing component.
	ActiveThreadCount int32 `json:"activeThreadCount,omitempty"`
	// The validation errors for the component.
	ValidationErrors []string `json:"validationErrors,omitempty"`
}

AffectedComponentDto struct for AffectedComponentDto

type AffectedComponentEntity ¶ 

type AffectedComponentEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The URI for futures requests to the component.
	Uri         string         `json:"uri,omitempty"`
	Position    PositionDto    `json:"position,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
	// The bulletins for this component.
	Bulletins []BulletinEntity `json:"bulletins,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool                 `json:"disconnectedNodeAcknowledged,omitempty"`
	Component                    AffectedComponentDto `json:"component,omitempty"`
	ProcessGroup                 ProcessGroupNameDto  `json:"processGroup,omitempty"`
	// The type of component referenced
	ReferenceType string `json:"referenceType,omitempty"`
}

AffectedComponentEntity struct for AffectedComponentEntity

type AllowableValueDto ¶ 

type AllowableValueDto struct {
	// A human readable value that is allowed for the property descriptor.
	DisplayName string `json:"displayName,omitempty"`
	// A value that is allowed for the property descriptor.
	Value string `json:"value,omitempty"`
	// A description for this allowable value.
	Description string `json:"description,omitempty"`
}

AllowableValueDto struct for AllowableValueDto

type AllowableValueEntity ¶ 

type AllowableValueEntity struct {
	AllowableValue AllowableValueDto `json:"allowableValue,omitempty"`
	// Indicates whether the user can read a given resource.
	CanRead bool `json:"canRead,omitempty"`
}

AllowableValueEntity struct for AllowableValueEntity

type AttributeDto ¶ 

type AttributeDto struct {
	// The attribute name.
	Name string `json:"name,omitempty"`
	// The attribute value.
	Value string `json:"value,omitempty"`
	// The value of the attribute before the event took place.
	PreviousValue string `json:"previousValue,omitempty"`
}

AttributeDto struct for AttributeDto

type BannerDto ¶ 

type BannerDto struct {
	// The header text.
	HeaderText string `json:"headerText,omitempty"`
	// The footer text.
	FooterText string `json:"footerText,omitempty"`
}

BannerDto struct for BannerDto

type BannerEntity ¶ 

type BannerEntity struct {
	Banners BannerDto `json:"banners,omitempty"`
}

BannerEntity struct for BannerEntity

type BasicAuth ¶ 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BatchSettingsDto ¶ 

type BatchSettingsDto struct {
	// Preferred number of flow files to include in a transaction.
	Count int32 `json:"count,omitempty"`
	// Preferred number of bytes to include in a transaction.
	Size string `json:"size,omitempty"`
	// Preferred amount of time that a transaction should span.
	Duration string `json:"duration,omitempty"`
}

BatchSettingsDto struct for BatchSettingsDto

type BatchSize ¶ 

type BatchSize struct {
	// Preferred number of flow files to include in a transaction.
	Count int32 `json:"count,omitempty"`
	// Preferred number of bytes to include in a transaction.
	Size string `json:"size,omitempty"`
	// Preferred amount of time that a transaction should span.
	Duration string `json:"duration,omitempty"`
}

BatchSize struct for BatchSize

type Bucket ¶ 

type Bucket struct {
	Link JaxbLink `json:"link,omitempty"`
	// An ID to uniquely identify this object.
	Identifier string `json:"identifier,omitempty"`
	// The name of the bucket.
	Name string `json:"name"`
	// The timestamp of when the bucket was first created. This is set by the server at creation time.
	CreatedTimestamp int64 `json:"createdTimestamp,omitempty"`
	// A description of the bucket.
	Description string `json:"description,omitempty"`
	// Indicates if this bucket allows the same version of an extension bundle to be redeployed and thus overwrite the existing artifact. By default this is false.
	AllowBundleRedeploy bool `json:"allowBundleRedeploy,omitempty"`
	// Indicates if this bucket allows read access to unauthenticated anonymous users
	AllowPublicRead bool        `json:"allowPublicRead,omitempty"`
	Permissions     Permissions `json:"permissions,omitempty"`
}

Bucket struct for Bucket

type BucketDto ¶ 

type BucketDto struct {
	// The bucket identifier
	Id string `json:"id,omitempty"`
	// The bucket name
	Name string `json:"name,omitempty"`
	// The bucket description
	Description string `json:"description,omitempty"`
	// The created timestamp of this bucket
	Created int64 `json:"created,omitempty"`
}

BucketDto struct for BucketDto

type BucketEntity ¶ 

type BucketEntity struct {
	Id          string         `json:"id,omitempty"`
	Bucket      BucketDto      `json:"bucket,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
}

BucketEntity struct for BucketEntity

type BucketsEntity ¶ 

type BucketsEntity struct {
	Buckets []BucketEntity `json:"buckets,omitempty"`
}

BucketsEntity struct for BucketsEntity

type BulletinBoardDto ¶ 

type BulletinBoardDto struct {
	// The bulletins in the bulletin board, that matches the supplied request.
	Bulletins []BulletinEntity `json:"bulletins,omitempty"`
	// The timestamp when this report was generated.
	Generated string `json:"generated,omitempty"`
}

BulletinBoardDto struct for BulletinBoardDto

type BulletinBoardEntity ¶ 

type BulletinBoardEntity struct {
	BulletinBoard BulletinBoardDto `json:"bulletinBoard,omitempty"`
}

BulletinBoardEntity struct for BulletinBoardEntity

type BulletinDto ¶ 

type BulletinDto struct {
	// The id of the bulletin.
	Id int64 `json:"id,omitempty"`
	// If clustered, the address of the node from which the bulletin originated.
	NodeAddress string `json:"nodeAddress,omitempty"`
	// The category of this bulletin.
	Category string `json:"category,omitempty"`
	// The group id of the source component.
	GroupId string `json:"groupId,omitempty"`
	// The id of the source component.
	SourceId string `json:"sourceId,omitempty"`
	// The name of the source component.
	SourceName string `json:"sourceName,omitempty"`
	// The level of the bulletin.
	Level string `json:"level,omitempty"`
	// The bulletin message.
	Message string `json:"message,omitempty"`
	// When this bulletin was generated.
	Timestamp string `json:"timestamp,omitempty"`
}

BulletinDto struct for BulletinDto

type BulletinEntity ¶ 

type BulletinEntity struct {
	Id       int64  `json:"id,omitempty"`
	GroupId  string `json:"groupId,omitempty"`
	SourceId string `json:"sourceId,omitempty"`
	// When this bulletin was generated.
	Timestamp   string `json:"timestamp,omitempty"`
	NodeAddress string `json:"nodeAddress,omitempty"`
	// Indicates whether the user can read a given resource.
	CanRead  bool        `json:"canRead,omitempty"`
	Bulletin BulletinDto `json:"bulletin,omitempty"`
}

BulletinEntity struct for BulletinEntity

type Bundle ¶ 

type Bundle struct {
	// The group of the bundle
	Group string `json:"group,omitempty"`
	// The artifact of the bundle
	Artifact string `json:"artifact,omitempty"`
	// The version of the bundle
	Version string `json:"version,omitempty"`
}

Bundle struct for Bundle

type BundleDto ¶ 

type BundleDto struct {
	// The group of the bundle.
	Group string `json:"group,omitempty"`
	// The artifact of the bundle.
	Artifact string `json:"artifact,omitempty"`
	// The version of the bundle.
	Version string `json:"version,omitempty"`
}

BundleDto struct for BundleDto

type ClusteSummaryEntity ¶ 

type ClusteSummaryEntity struct {
	ClusterSummary ClusterSummaryDto `json:"clusterSummary,omitempty"`
}

ClusteSummaryEntity struct for ClusteSummaryEntity

type ClusterDto ¶ 

type ClusterDto struct {
	// The collection of nodes that are part of the cluster.
	Nodes []NodeDto `json:"nodes,omitempty"`
	// The timestamp the report was generated.
	Generated string `json:"generated,omitempty"`
}

ClusterDto struct for ClusterDto

type ClusterEntity ¶ 

type ClusterEntity struct {
	Cluster ClusterDto `json:"cluster,omitempty"`
}

ClusterEntity struct for ClusterEntity

type ClusterSearchResultsEntity ¶ 

type ClusterSearchResultsEntity struct {
	NodeResults []NodeSearchResultDto `json:"nodeResults,omitempty"`
}

ClusterSearchResultsEntity struct for ClusterSearchResultsEntity

type ClusterSummaryDto ¶ 

type ClusterSummaryDto struct {
	// When clustered, reports the number of nodes connected vs the number of nodes in the cluster.
	ConnectedNodes string `json:"connectedNodes,omitempty"`
	// The number of nodes that are currently connected to the cluster
	ConnectedNodeCount int32 `json:"connectedNodeCount,omitempty"`
	// The number of nodes in the cluster, regardless of whether or not they are connected
	TotalNodeCount int32 `json:"totalNodeCount,omitempty"`
	// Whether this NiFi instance is clustered.
	Clustered bool `json:"clustered,omitempty"`
	// Whether this NiFi instance is connected to a cluster.
	ConnectedToCluster bool `json:"connectedToCluster,omitempty"`
}

ClusterSummaryDto struct for ClusterSummaryDto

type ComponentDifferenceDto ¶ 

type ComponentDifferenceDto struct {
	// The type of component
	ComponentType string `json:"componentType,omitempty"`
	// The ID of the component
	ComponentId string `json:"componentId,omitempty"`
	// The name of the component
	ComponentName string `json:"componentName,omitempty"`
	// The ID of the Process Group that the component belongs to
	ProcessGroupId string `json:"processGroupId,omitempty"`
	// The differences in the component between the two flows
	Differences []DifferenceDto `json:"differences,omitempty"`
}

ComponentDifferenceDto struct for ComponentDifferenceDto

type ComponentHistoryDto ¶ 

type ComponentHistoryDto struct {
	// The component id.
	ComponentId string `json:"componentId,omitempty"`
	// The history for the properties of the component.
	PropertyHistory map[string]PropertyHistoryDto `json:"propertyHistory,omitempty"`
}

ComponentHistoryDto struct for ComponentHistoryDto

type ComponentHistoryEntity ¶ 

type ComponentHistoryEntity struct {
	ComponentHistory ComponentHistoryDto `json:"componentHistory,omitempty"`
}

ComponentHistoryEntity struct for ComponentHistoryEntity

type ComponentReferenceDto ¶ 

type ComponentReferenceDto struct {
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The ID of the corresponding component that is under version control
	VersionedComponentId string `json:"versionedComponentId,omitempty"`
	// The id of parent process group of this component if applicable.
	ParentGroupId string      `json:"parentGroupId,omitempty"`
	Position      PositionDto `json:"position,omitempty"`
	// The name of the component.
	Name string `json:"name,omitempty"`
}

ComponentReferenceDto struct for ComponentReferenceDto

type ComponentReferenceEntity ¶ 

type ComponentReferenceEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The URI for futures requests to the component.
	Uri         string         `json:"uri,omitempty"`
	Position    PositionDto    `json:"position,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
	// The bulletins for this component.
	Bulletins []BulletinEntity `json:"bulletins,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool `json:"disconnectedNodeAcknowledged,omitempty"`
	// The id of parent process group of this component if applicable.
	ParentGroupId string                `json:"parentGroupId,omitempty"`
	Component     ComponentReferenceDto `json:"component,omitempty"`
}

ComponentReferenceEntity struct for ComponentReferenceEntity

type ComponentRestrictionPermissionDto ¶ 

type ComponentRestrictionPermissionDto struct {
	RequiredPermission RequiredPermissionDto `json:"requiredPermission,omitempty"`
	Permissions        PermissionsDto        `json:"permissions,omitempty"`
}

ComponentRestrictionPermissionDto struct for ComponentRestrictionPermissionDto

type ComponentSearchResultDto ¶ 

type ComponentSearchResultDto struct {
	// The id of the component that matched the search.
	Id string `json:"id,omitempty"`
	// The group id of the component that matched the search.
	GroupId        string               `json:"groupId,omitempty"`
	ParentGroup    SearchResultGroupDto `json:"parentGroup,omitempty"`
	VersionedGroup SearchResultGroupDto `json:"versionedGroup,omitempty"`
	// The name of the component that matched the search.
	Name string `json:"name,omitempty"`
	// What matched the search from the component.
	Matches []string `json:"matches,omitempty"`
}

ComponentSearchResultDto struct for ComponentSearchResultDto

type ComponentStateDto ¶ 

type ComponentStateDto struct {
	// The component identifier.
	ComponentId string `json:"componentId,omitempty"`
	// Description of the state this component persists.
	StateDescription string      `json:"stateDescription,omitempty"`
	ClusterState     StateMapDto `json:"clusterState,omitempty"`
	LocalState       StateMapDto `json:"localState,omitempty"`
}

ComponentStateDto struct for ComponentStateDto

type ComponentStateEntity ¶ 

type ComponentStateEntity struct {
	ComponentState ComponentStateDto `json:"componentState,omitempty"`
}

ComponentStateEntity struct for ComponentStateEntity

type ComponentValidationResultDto ¶ 

type ComponentValidationResultDto struct {
	// The UUID of the Process Group that this component is in
	ProcessGroupId string `json:"processGroupId,omitempty"`
	// The UUID of this component
	Id string `json:"id,omitempty"`
	// The type of this component
	ReferenceType string `json:"referenceType,omitempty"`
	// The name of this component.
	Name string `json:"name,omitempty"`
	// The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state.
	State string `json:"state,omitempty"`
	// The number of active threads for the referencing component.
	ActiveThreadCount int32 `json:"activeThreadCount,omitempty"`
	// The validation errors for the component.
	ValidationErrors []string `json:"validationErrors,omitempty"`
	// Whether or not the component is currently valid
	CurrentlyValid bool `json:"currentlyValid,omitempty"`
	// Whether or not the component will be valid if the Parameter Context is changed
	ResultsValid bool `json:"resultsValid,omitempty"`
	// The validation errors that will apply to the component if the Parameter Context is changed
	ResultantValidationErrors []string `json:"resultantValidationErrors,omitempty"`
}

ComponentValidationResultDto struct for ComponentValidationResultDto

type ComponentValidationResultEntity ¶ 

type ComponentValidationResultEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The URI for futures requests to the component.
	Uri         string         `json:"uri,omitempty"`
	Position    PositionDto    `json:"position,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
	// The bulletins for this component.
	Bulletins []BulletinEntity `json:"bulletins,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool                         `json:"disconnectedNodeAcknowledged,omitempty"`
	Component                    ComponentValidationResultDto `json:"component,omitempty"`
}

ComponentValidationResultEntity struct for ComponentValidationResultEntity

type ComponentValidationResultsEntity ¶ 

type ComponentValidationResultsEntity struct {
	// A List of ComponentValidationResultEntity, one for each component that is validated
	ValidationResults []ComponentValidationResultEntity `json:"validationResults,omitempty"`
}

ComponentValidationResultsEntity struct for ComponentValidationResultsEntity

type Configuration ¶ 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	Debug         bool              `json:"debug,omitempty"`
	Servers       []ServerConfiguration
	HTTPClient    *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration ¶ 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader ¶ 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerUrl ¶ 

func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error)

ServerUrl returns URL based on server settings

type ConnectableComponent ¶ 

type ConnectableComponent struct {
	// The id of the connectable component.
	Id string `json:"id"`
	// The type of component the connectable is.
	Type string `json:"type"`
	// The id of the group that the connectable component resides in
	GroupId string `json:"groupId"`
	// The name of the connectable component
	Name string `json:"name,omitempty"`
	// The comments for the connectable component.
	Comments string `json:"comments,omitempty"`
}

ConnectableComponent struct for ConnectableComponent

type ConnectableDto ¶ 

type ConnectableDto struct {
	// The id of the connectable component.
	Id string `json:"id"`
	// The ID of the corresponding component that is under version control
	VersionedComponentId string `json:"versionedComponentId,omitempty"`
	// The type of component the connectable is.
	Type string `json:"type"`
	// The id of the group that the connectable component resides in
	GroupId string `json:"groupId"`
	// The name of the connectable component
	Name string `json:"name,omitempty"`
	// Reflects the current state of the connectable component.
	Running bool `json:"running,omitempty"`
	// If the connectable component represents a remote port, indicates if the target is configured to transmit.
	Transmitting bool `json:"transmitting,omitempty"`
	// If the connectable component represents a remote port, indicates if the target exists.
	Exists bool `json:"exists,omitempty"`
	// The comments for the connectable component.
	Comments string `json:"comments,omitempty"`
}

ConnectableDto struct for ConnectableDto

type ConnectionDto ¶ 

type ConnectionDto struct {
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The ID of the corresponding component that is under version control
	VersionedComponentId string `json:"versionedComponentId,omitempty"`
	// The id of parent process group of this component if applicable.
	ParentGroupId string         `json:"parentGroupId,omitempty"`
	Position      PositionDto    `json:"position,omitempty"`
	Source        ConnectableDto `json:"source,omitempty"`
	Destination   ConnectableDto `json:"destination,omitempty"`
	// The name of the connection.
	Name string `json:"name,omitempty"`
	// The index of the bend point where to place the connection label.
	LabelIndex int32 `json:"labelIndex,omitempty"`
	// The z index of the connection.
	GetzIndex int64 `json:"getzIndex,omitempty"`
	// The selected relationship that comprise the connection.
	SelectedRelationships []string `json:"selectedRelationships,omitempty"`
	// The relationships that the source of the connection currently supports.
	AvailableRelationships []string `json:"availableRelationships,omitempty"`
	// The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue.
	BackPressureObjectThreshold int64 `json:"backPressureObjectThreshold,omitempty"`
	// The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue.
	BackPressureDataSizeThreshold string `json:"backPressureDataSizeThreshold,omitempty"`
	// The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it.
	FlowFileExpiration string `json:"flowFileExpiration,omitempty"`
	// The comparators used to prioritize the queue.
	Prioritizers []string `json:"prioritizers,omitempty"`
	// The bend points on the connection.
	Bends []PositionDto `json:"bends,omitempty"`
	// How to load balance the data in this Connection across the nodes in the cluster.
	LoadBalanceStrategy string `json:"loadBalanceStrategy,omitempty"`
	// The FlowFile Attribute to use for determining which node a FlowFile will go to if the Load Balancing Strategy is set to PARTITION_BY_ATTRIBUTE
	LoadBalancePartitionAttribute string `json:"loadBalancePartitionAttribute,omitempty"`
	// Whether or not data should be compressed when being transferred between nodes in the cluster.
	LoadBalanceCompression string `json:"loadBalanceCompression,omitempty"`
	// The current status of the Connection's Load Balancing Activities. Status can indicate that Load Balancing is not configured for the connection, that Load Balancing is configured but inactive (not currently transferring data to another node), or that Load Balancing is configured and actively transferring data to another node.
	LoadBalanceStatus string `json:"loadBalanceStatus,omitempty"`
}

ConnectionDto struct for ConnectionDto

type ConnectionEntity ¶ 

type ConnectionEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The URI for futures requests to the component.
	Uri         string         `json:"uri,omitempty"`
	Position    PositionDto    `json:"position,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
	// The bulletins for this component.
	Bulletins []BulletinEntity `json:"bulletins,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool                `json:"disconnectedNodeAcknowledged,omitempty"`
	Component                    ConnectionDto       `json:"component,omitempty"`
	Status                       ConnectionStatusDto `json:"status,omitempty"`
	// The bend points on the connection.
	Bends []PositionDto `json:"bends,omitempty"`
	// The index of the bend point where to place the connection label.
	LabelIndex int32 `json:"labelIndex,omitempty"`
	// The z index of the connection.
	GetzIndex int64 `json:"getzIndex,omitempty"`
	// The identifier of the source of this connection.
	SourceId string `json:"sourceId,omitempty"`
	// The identifier of the group of the source of this connection.
	SourceGroupId string `json:"sourceGroupId,omitempty"`
	// The type of component the source connectable is.
	SourceType string `json:"sourceType"`
	// The identifier of the destination of this connection.
	DestinationId string `json:"destinationId,omitempty"`
	// The identifier of the group of the destination of this connection.
	DestinationGroupId string `json:"destinationGroupId,omitempty"`
	// The type of component the destination connectable is.
	DestinationType string `json:"destinationType"`
}

ConnectionEntity struct for ConnectionEntity

type ConnectionStatisticsDto ¶ 

type ConnectionStatisticsDto struct {
	// The ID of the connection
	Id string `json:"id,omitempty"`
	// The timestamp of when the stats were last refreshed
	StatsLastRefreshed string                          `json:"statsLastRefreshed,omitempty"`
	AggregateSnapshot  ConnectionStatisticsSnapshotDto `json:"aggregateSnapshot,omitempty"`
	// A list of status snapshots for each node
	NodeSnapshots []NodeConnectionStatisticsSnapshotDto `json:"nodeSnapshots,omitempty"`
}

ConnectionStatisticsDto struct for ConnectionStatisticsDto

type ConnectionStatisticsEntity ¶ 

type ConnectionStatisticsEntity struct {
	ConnectionStatistics ConnectionStatisticsDto `json:"connectionStatistics,omitempty"`
	// Indicates whether the user can read a given resource.
	CanRead bool `json:"canRead,omitempty"`
}

ConnectionStatisticsEntity struct for ConnectionStatisticsEntity

type ConnectionStatisticsSnapshotDto ¶ 

type ConnectionStatisticsSnapshotDto struct {
	// The id of the connection.
	Id string `json:"id,omitempty"`
	// The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count.
	PredictedMillisUntilCountBackpressure int64 `json:"predictedMillisUntilCountBackpressure,omitempty"`
	// The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue.
	PredictedMillisUntilBytesBackpressure int64 `json:"predictedMillisUntilBytesBackpressure,omitempty"`
	// The predicted number of queued objects at the next configured interval.
	PredictedCountAtNextInterval int32 `json:"predictedCountAtNextInterval,omitempty"`
	// The predicted total number of bytes in the queue at the next configured interval.
	PredictedBytesAtNextInterval int64 `json:"predictedBytesAtNextInterval,omitempty"`
	// The predicted percentage of queued objects at the next configured interval.
	PredictedPercentCount int32 `json:"predictedPercentCount,omitempty"`
	// The predicted percentage of bytes in the queue against current threshold at the next configured interval.
	PredictedPercentBytes int32 `json:"predictedPercentBytes,omitempty"`
	// The prediction interval in seconds
	PredictionIntervalMillis int64 `json:"predictionIntervalMillis,omitempty"`
}

ConnectionStatisticsSnapshotDto struct for ConnectionStatisticsSnapshotDto

type ConnectionStatusDto ¶ 

type ConnectionStatusDto struct {
	// The ID of the connection
	Id string `json:"id,omitempty"`
	// The ID of the Process Group that the connection belongs to
	GroupId string `json:"groupId,omitempty"`
	// The name of the connection
	Name string `json:"name,omitempty"`
	// The timestamp of when the stats were last refreshed
	StatsLastRefreshed string `json:"statsLastRefreshed,omitempty"`
	// The ID of the source component
	SourceId string `json:"sourceId,omitempty"`
	// The name of the source component
	SourceName string `json:"sourceName,omitempty"`
	// The ID of the destination component
	DestinationId string `json:"destinationId,omitempty"`
	// The name of the destination component
	DestinationName   string                      `json:"destinationName,omitempty"`
	AggregateSnapshot ConnectionStatusSnapshotDto `json:"aggregateSnapshot,omitempty"`
	// A list of status snapshots for each node
	NodeSnapshots []NodeConnectionStatusSnapshotDto `json:"nodeSnapshots,omitempty"`
}

ConnectionStatusDto struct for ConnectionStatusDto

type ConnectionStatusEntity ¶ 

type ConnectionStatusEntity struct {
	ConnectionStatus ConnectionStatusDto `json:"connectionStatus,omitempty"`
	// Indicates whether the user can read a given resource.
	CanRead bool `json:"canRead,omitempty"`
}

ConnectionStatusEntity struct for ConnectionStatusEntity

type ConnectionStatusPredictionsSnapshotDto ¶ 

type ConnectionStatusPredictionsSnapshotDto struct {
	// The predicted number of milliseconds before the connection will have backpressure applied, based on the queued count.
	PredictedMillisUntilCountBackpressure int64 `json:"predictedMillisUntilCountBackpressure,omitempty"`
	// The predicted number of milliseconds before the connection will have backpressure applied, based on the total number of bytes in the queue.
	PredictedMillisUntilBytesBackpressure int64 `json:"predictedMillisUntilBytesBackpressure,omitempty"`
	// The configured interval (in seconds) for predicting connection queue count and size (and percent usage).
	PredictionIntervalSeconds int32 `json:"predictionIntervalSeconds,omitempty"`
	// The predicted number of queued objects at the next configured interval.
	PredictedCountAtNextInterval int32 `json:"predictedCountAtNextInterval,omitempty"`
	// The predicted total number of bytes in the queue at the next configured interval.
	PredictedBytesAtNextInterval int64 `json:"predictedBytesAtNextInterval,omitempty"`
	// Predicted connection percent use regarding queued flow files count and backpressure threshold if configured.
	PredictedPercentCount int32 `json:"predictedPercentCount,omitempty"`
	// Predicted connection percent use regarding queued flow files size and backpressure threshold if configured.
	PredictedPercentBytes int32 `json:"predictedPercentBytes,omitempty"`
}

ConnectionStatusPredictionsSnapshotDto struct for ConnectionStatusPredictionsSnapshotDto

type ConnectionStatusSnapshotDto ¶ 

type ConnectionStatusSnapshotDto struct {
	// The id of the connection.
	Id string `json:"id,omitempty"`
	// The id of the process group the connection belongs to.
	GroupId string `json:"groupId,omitempty"`
	// The name of the connection.
	Name string `json:"name,omitempty"`
	// The id of the source of the connection.
	SourceId string `json:"sourceId,omitempty"`
	// The name of the source of the connection.
	SourceName string `json:"sourceName,omitempty"`
	// The id of the destination of the connection.
	DestinationId string `json:"destinationId,omitempty"`
	// The name of the destination of the connection.
	DestinationName string                                 `json:"destinationName,omitempty"`
	Predictions     ConnectionStatusPredictionsSnapshotDto `json:"predictions,omitempty"`
	// The number of FlowFiles that have come into the connection in the last 5 minutes.
	FlowFilesIn int32 `json:"flowFilesIn,omitempty"`
	// The size of the FlowFiles that have come into the connection in the last 5 minutes.
	BytesIn int64 `json:"bytesIn,omitempty"`
	// The input count/size for the connection in the last 5 minutes, pretty printed.
	Input string `json:"input,omitempty"`
	// The number of FlowFiles that have left the connection in the last 5 minutes.
	FlowFilesOut int32 `json:"flowFilesOut,omitempty"`
	// The number of bytes that have left the connection in the last 5 minutes.
	BytesOut int64 `json:"bytesOut,omitempty"`
	// The output count/sie for the connection in the last 5 minutes, pretty printed.
	Output string `json:"output,omitempty"`
	// The number of FlowFiles that are currently queued in the connection.
	FlowFilesQueued int32 `json:"flowFilesQueued,omitempty"`
	// The size of the FlowFiles that are currently queued in the connection.
	BytesQueued int64 `json:"bytesQueued,omitempty"`
	// The total count and size of queued flowfiles formatted.
	Queued string `json:"queued,omitempty"`
	// The total size of flowfiles that are queued formatted.
	QueuedSize string `json:"queuedSize,omitempty"`
	// The number of flowfiles that are queued, pretty printed.
	QueuedCount string `json:"queuedCount,omitempty"`
	// Connection percent use regarding queued flow files count and backpressure threshold if configured.
	PercentUseCount int32 `json:"percentUseCount,omitempty"`
	// Connection percent use regarding queued flow files size and backpressure threshold if configured.
	PercentUseBytes int32 `json:"percentUseBytes,omitempty"`
}

ConnectionStatusSnapshotDto struct for ConnectionStatusSnapshotDto

type ConnectionStatusSnapshotEntity ¶ 

type ConnectionStatusSnapshotEntity struct {
	// The id of the connection.
	Id                       string                      `json:"id,omitempty"`
	ConnectionStatusSnapshot ConnectionStatusSnapshotDto `json:"connectionStatusSnapshot,omitempty"`
	// Indicates whether the user can read a given resource.
	CanRead bool `json:"canRead,omitempty"`
}

ConnectionStatusSnapshotEntity struct for ConnectionStatusSnapshotEntity

type ConnectionsApiDeleteConnectionOpts ¶ 

type ConnectionsApiDeleteConnectionOpts struct {
	Version                      optional.String
	ClientId                     optional.String
	DisconnectedNodeAcknowledged optional.Bool
}

ConnectionsApiDeleteConnectionOpts Optional parameters for the method 'DeleteConnection'

type ConnectionsApiService ¶ 

type ConnectionsApiService service

ConnectionsApiService ConnectionsApi service

func (*ConnectionsApiService) DeleteConnection ¶ 

func (a *ConnectionsApiService) DeleteConnection(ctx _context.Context, id string, localVarOptionals *ConnectionsApiDeleteConnectionOpts) (ConnectionEntity, *_nethttp.Response, error)

DeleteConnection Deletes a connection

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The connection id.
  • @param optional nil or *ConnectionsApiDeleteConnectionOpts - Optional Parameters:
  • @param "Version" (optional.String) - The revision is used to verify the client is working with the latest version of the flow.
  • @param "ClientId" (optional.String) - If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

@return ConnectionEntity

func (*ConnectionsApiService) GetConnection ¶ 

func (a *ConnectionsApiService) GetConnection(ctx _context.Context, id string) (ConnectionEntity, *_nethttp.Response, error)

GetConnection Gets a connection

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The connection id.

@return ConnectionEntity

func (*ConnectionsApiService) UpdateConnection ¶ 

func (a *ConnectionsApiService) UpdateConnection(ctx _context.Context, id string, body ConnectionEntity) (ConnectionEntity, *_nethttp.Response, error)

UpdateConnection Updates a connection

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The connection id.
  • @param body The connection configuration details.

@return ConnectionEntity

type ConnectionsEntity ¶ 

type ConnectionsEntity struct {
	Connections []ConnectionEntity `json:"connections,omitempty"`
}

ConnectionsEntity struct for ConnectionsEntity

type ControllerApiDeleteRegistryClientOpts ¶ 

type ControllerApiDeleteRegistryClientOpts struct {
	Version                      optional.String
	ClientId                     optional.String
	DisconnectedNodeAcknowledged optional.Bool
}

ControllerApiDeleteRegistryClientOpts Optional parameters for the method 'DeleteRegistryClient'

type ControllerApiService ¶ 

type ControllerApiService service

ControllerApiService ControllerApi service

func (*ControllerApiService) CreateBulletin ¶ 

func (a *ControllerApiService) CreateBulletin(ctx _context.Context, body BulletinEntity) (BulletinEntity, *_nethttp.Response, error)

CreateBulletin Creates a new bulletin

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The reporting task configuration details.

@return BulletinEntity

func (*ControllerApiService) CreateControllerService ¶ 

func (a *ControllerApiService) CreateControllerService(ctx _context.Context, body ControllerServiceEntity) (ControllerServiceEntity, *_nethttp.Response, error)

CreateControllerService Creates a new controller service

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The controller service configuration details.

@return ControllerServiceEntity

func (*ControllerApiService) CreateRegistryClient ¶ 

func (a *ControllerApiService) CreateRegistryClient(ctx _context.Context, body RegistryClientEntity) (RegistryClientEntity, *_nethttp.Response, error)

CreateRegistryClient Creates a new registry client

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The registry configuration details.

@return RegistryClientEntity

func (*ControllerApiService) CreateReportingTask ¶ 

func (a *ControllerApiService) CreateReportingTask(ctx _context.Context, body ReportingTaskEntity) (ReportingTaskEntity, *_nethttp.Response, error)

CreateReportingTask Creates a new reporting task

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The reporting task configuration details.

@return ReportingTaskEntity

func (*ControllerApiService) DeleteHistory ¶ 

func (a *ControllerApiService) DeleteHistory(ctx _context.Context, endDate string) (HistoryEntity, *_nethttp.Response, error)

DeleteHistory Purges history

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param endDate Purge actions before this date/time.

@return HistoryEntity

func (*ControllerApiService) DeleteNode ¶ 

func (a *ControllerApiService) DeleteNode(ctx _context.Context, id string) (NodeEntity, *_nethttp.Response, error)

DeleteNode Removes a node from the cluster

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The node id.

@return NodeEntity

func (*ControllerApiService) DeleteRegistryClient ¶ 

func (a *ControllerApiService) DeleteRegistryClient(ctx _context.Context, id string, localVarOptionals *ControllerApiDeleteRegistryClientOpts) (RegistryClientEntity, *_nethttp.Response, error)

DeleteRegistryClient Deletes a registry client

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The registry id.
  • @param optional nil or *ControllerApiDeleteRegistryClientOpts - Optional Parameters:
  • @param "Version" (optional.String) - The revision is used to verify the client is working with the latest version of the flow.
  • @param "ClientId" (optional.String) - If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

@return RegistryClientEntity

func (*ControllerApiService) GetCluster ¶ 

func (a *ControllerApiService) GetCluster(ctx _context.Context) (ClusterEntity, *_nethttp.Response, error)

GetCluster Gets the contents of the cluster Returns the contents of the cluster including all nodes and their status.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ClusterEntity

func (*ControllerApiService) GetControllerConfig ¶ 

func (a *ControllerApiService) GetControllerConfig(ctx _context.Context) (ControllerConfigurationEntity, *_nethttp.Response, error)

GetControllerConfig Retrieves the configuration for this NiFi Controller

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ControllerConfigurationEntity

func (*ControllerApiService) GetNode ¶ 

func (a *ControllerApiService) GetNode(ctx _context.Context, id string) (NodeEntity, *_nethttp.Response, error)

GetNode Gets a node in the cluster

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The node id.

@return NodeEntity

func (*ControllerApiService) GetRegistryClient ¶ 

func (a *ControllerApiService) GetRegistryClient(ctx _context.Context, id string) (RegistryClientEntity, *_nethttp.Response, error)

GetRegistryClient Gets a registry client

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The registry id.

@return RegistryClientEntity

func (*ControllerApiService) GetRegistryClients ¶ 

func (a *ControllerApiService) GetRegistryClients(ctx _context.Context) (RegistryClientsEntity, *_nethttp.Response, error)

GetRegistryClients Gets the listing of available registry clients

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return RegistryClientsEntity

func (*ControllerApiService) UpdateControllerConfig ¶ 

func (a *ControllerApiService) UpdateControllerConfig(ctx _context.Context, body ControllerConfigurationEntity) (ControllerConfigurationEntity, *_nethttp.Response, error)

UpdateControllerConfig Retrieves the configuration for this NiFi

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The controller configuration.

@return ControllerConfigurationEntity

func (*ControllerApiService) UpdateNode ¶ 

func (a *ControllerApiService) UpdateNode(ctx _context.Context, id string, body NodeEntity) (NodeEntity, *_nethttp.Response, error)

UpdateNode Updates a node in the cluster

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The node id.
  • @param body The node configuration. The only configuration that will be honored at this endpoint is the status.

@return NodeEntity

func (*ControllerApiService) UpdateRegistryClient ¶ 

func (a *ControllerApiService) UpdateRegistryClient(ctx _context.Context, id string, body RegistryClientEntity) (RegistryClientEntity, *_nethttp.Response, error)

UpdateRegistryClient Updates a registry client

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The registry id.
  • @param body The registry configuration details.

@return RegistryClientEntity

type ControllerBulletinsEntity ¶ 

type ControllerBulletinsEntity struct {
	// System level bulletins to be reported to the user.
	Bulletins []BulletinEntity `json:"bulletins,omitempty"`
	// Controller service bulletins to be reported to the user.
	ControllerServiceBulletins []BulletinEntity `json:"controllerServiceBulletins,omitempty"`
	// Reporting task bulletins to be reported to the user.
	ReportingTaskBulletins []BulletinEntity `json:"reportingTaskBulletins,omitempty"`
}

ControllerBulletinsEntity struct for ControllerBulletinsEntity

type ControllerConfigurationDto ¶ 

type ControllerConfigurationDto struct {
	// The maximum number of timer driven threads the NiFi has available.
	MaxTimerDrivenThreadCount int32 `json:"maxTimerDrivenThreadCount,omitempty"`
	// The maximum number of event driven threads the NiFi has available.
	MaxEventDrivenThreadCount int32 `json:"maxEventDrivenThreadCount,omitempty"`
}

ControllerConfigurationDto struct for ControllerConfigurationDto

type ControllerConfigurationEntity ¶ 

type ControllerConfigurationEntity struct {
	Revision    RevisionDto    `json:"revision,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool                       `json:"disconnectedNodeAcknowledged,omitempty"`
	Component                    ControllerConfigurationDto `json:"component,omitempty"`
}

ControllerConfigurationEntity struct for ControllerConfigurationEntity

type ControllerDto ¶ 

type ControllerDto struct {
	// The id of the NiFi.
	Id string `json:"id,omitempty"`
	// The name of the NiFi.
	Name string `json:"name,omitempty"`
	// The comments for the NiFi.
	Comments string `json:"comments,omitempty"`
	// The number of running components in the NiFi.
	RunningCount int32 `json:"runningCount,omitempty"`
	// The number of stopped components in the NiFi.
	StoppedCount int32 `json:"stoppedCount,omitempty"`
	// The number of invalid components in the NiFi.
	InvalidCount int32 `json:"invalidCount,omitempty"`
	// The number of disabled components in the NiFi.
	DisabledCount int32 `json:"disabledCount,omitempty"`
	// The number of active remote ports contained in the NiFi.
	ActiveRemotePortCount int32 `json:"activeRemotePortCount,omitempty"`
	// The number of inactive remote ports contained in the NiFi.
	InactiveRemotePortCount int32 `json:"inactiveRemotePortCount,omitempty"`
	// The number of input ports contained in the NiFi.
	InputPortCount int32 `json:"inputPortCount,omitempty"`
	// The number of output ports in the NiFi.
	OutputPortCount int32 `json:"outputPortCount,omitempty"`
	// The Socket Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null.
	RemoteSiteListeningPort int32 `json:"remoteSiteListeningPort,omitempty"`
	// The HTTP(S) Port on which this instance is listening for Remote Transfers of Flow Files. If this instance is not configured to receive Flow Files from remote instances, this will be null.
	RemoteSiteHttpListeningPort int32 `json:"remoteSiteHttpListeningPort,omitempty"`
	// Indicates whether or not Site-to-Site communications with this instance is secure (2-way authentication).
	SiteToSiteSecure bool `json:"siteToSiteSecure,omitempty"`
	// If clustered, the id of the Cluster Manager, otherwise the id of the NiFi.
	InstanceId string `json:"instanceId,omitempty"`
	// The input ports available to send data to for the NiFi.
	InputPorts []PortDto `json:"inputPorts,omitempty"`
	// The output ports available to received data from the NiFi.
	OutputPorts []PortDto `json:"outputPorts,omitempty"`
}

ControllerDto struct for ControllerDto

type ControllerEntity ¶ 

type ControllerEntity struct {
	Controller ControllerDto `json:"controller,omitempty"`
}

ControllerEntity struct for ControllerEntity

type ControllerServiceApi ¶ 

type ControllerServiceApi struct {
	// The fully qualified name of the service interface.
	Type   string `json:"type,omitempty"`
	Bundle Bundle `json:"bundle,omitempty"`
}

ControllerServiceApi struct for ControllerServiceApi

type ControllerServiceApiDto ¶ 

type ControllerServiceApiDto struct {
	// The fully qualified name of the service interface.
	Type   string    `json:"type,omitempty"`
	Bundle BundleDto `json:"bundle,omitempty"`
}

ControllerServiceApiDto struct for ControllerServiceApiDto

type ControllerServiceDto ¶ 

type ControllerServiceDto struct {
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The ID of the corresponding component that is under version control
	VersionedComponentId string `json:"versionedComponentId,omitempty"`
	// The id of parent process group of this component if applicable.
	ParentGroupId string      `json:"parentGroupId,omitempty"`
	Position      PositionDto `json:"position,omitempty"`
	// The name of the controller service.
	Name string `json:"name,omitempty"`
	// The type of the controller service.
	Type   string    `json:"type,omitempty"`
	Bundle BundleDto `json:"bundle,omitempty"`
	// Lists the APIs this Controller Service implements.
	ControllerServiceApis []ControllerServiceApiDto `json:"controllerServiceApis,omitempty"`
	// The comments for the controller service.
	Comments string `json:"comments,omitempty"`
	// The state of the controller service.
	State string `json:"state,omitempty"`
	// Whether the controller service persists state.
	PersistsState bool `json:"persistsState,omitempty"`
	// Whether the controller service requires elevated privileges.
	Restricted bool `json:"restricted,omitempty"`
	// Whether the ontroller service has been deprecated.
	Deprecated bool `json:"deprecated,omitempty"`
	// Whether the controller service has multiple versions available.
	MultipleVersionsAvailable bool `json:"multipleVersionsAvailable,omitempty"`
	// The properties of the controller service.
	Properties map[string]string `json:"properties,omitempty"`
	// The descriptors for the controller service properties.
	Descriptors map[string]PropertyDescriptorDto `json:"descriptors,omitempty"`
	// The URL for the controller services custom configuration UI if applicable.
	CustomUiUrl string `json:"customUiUrl,omitempty"`
	// The annotation for the controller service. This is how the custom UI relays configuration to the controller service.
	AnnotationData string `json:"annotationData,omitempty"`
	// All components referencing this controller service.
	ReferencingComponents []ControllerServiceReferencingComponentEntity `json:"referencingComponents,omitempty"`
	// The validation errors from the controller service. These validation errors represent the problems with the controller service that must be resolved before it can be enabled.
	ValidationErrors []string `json:"validationErrors,omitempty"`
	// Indicates whether the ControllerService is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the ControllerService is valid)
	ValidationStatus string `json:"validationStatus,omitempty"`
	// Whether the underlying extension is missing.
	ExtensionMissing bool `json:"extensionMissing,omitempty"`
}

ControllerServiceDto struct for ControllerServiceDto

type ControllerServiceEntity ¶ 

type ControllerServiceEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The URI for futures requests to the component.
	Uri         string         `json:"uri,omitempty"`
	Position    PositionDto    `json:"position,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
	// The bulletins for this component.
	Bulletins []BulletinEntity `json:"bulletins,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool `json:"disconnectedNodeAcknowledged,omitempty"`
	// The id of parent process group of this ControllerService.
	ParentGroupId      string                     `json:"parentGroupId,omitempty"`
	Component          ControllerServiceDto       `json:"component,omitempty"`
	OperatePermissions PermissionsDto             `json:"operatePermissions,omitempty"`
	Status             ControllerServiceStatusDto `json:"status,omitempty"`
}

ControllerServiceEntity struct for ControllerServiceEntity

type ControllerServiceReferencingComponentDto ¶ 

type ControllerServiceReferencingComponentDto struct {
	// The group id for the component referencing a controller service. If this component is another controller service or a reporting task, this field is blank.
	GroupId string `json:"groupId,omitempty"`
	// The id of the component referencing a controller service.
	Id string `json:"id,omitempty"`
	// The name of the component referencing a controller service.
	Name string `json:"name,omitempty"`
	// The type of the component referencing a controller service in simple Java class name format without package name.
	Type string `json:"type,omitempty"`
	// The scheduled state of a processor or reporting task referencing a controller service. If this component is another controller service, this field represents the controller service state.
	State string `json:"state,omitempty"`
	// The properties for the component.
	Properties map[string]string `json:"properties,omitempty"`
	// The descriptors for the component properties.
	Descriptors map[string]PropertyDescriptorDto `json:"descriptors,omitempty"`
	// The validation errors for the component.
	ValidationErrors []string `json:"validationErrors,omitempty"`
	// The type of reference this is.
	ReferenceType string `json:"referenceType,omitempty"`
	// The number of active threads for the referencing component.
	ActiveThreadCount int32 `json:"activeThreadCount,omitempty"`
	// If the referencing component represents a controller service, this indicates whether it has already been represented in this hierarchy.
	ReferenceCycle bool `json:"referenceCycle,omitempty"`
	// If the referencing component represents a controller service, these are the components that reference it.
	ReferencingComponents []ControllerServiceReferencingComponentEntity `json:"referencingComponents,omitempty"`
}

ControllerServiceReferencingComponentDto struct for ControllerServiceReferencingComponentDto

type ControllerServiceReferencingComponentEntity ¶ 

type ControllerServiceReferencingComponentEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The URI for futures requests to the component.
	Uri         string         `json:"uri,omitempty"`
	Position    PositionDto    `json:"position,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
	// The bulletins for this component.
	Bulletins []BulletinEntity `json:"bulletins,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool                                     `json:"disconnectedNodeAcknowledged,omitempty"`
	Component                    ControllerServiceReferencingComponentDto `json:"component,omitempty"`
	OperatePermissions           PermissionsDto                           `json:"operatePermissions,omitempty"`
}

ControllerServiceReferencingComponentEntity struct for ControllerServiceReferencingComponentEntity

type ControllerServiceReferencingComponentsEntity ¶ 

type ControllerServiceReferencingComponentsEntity struct {
	ControllerServiceReferencingComponents []ControllerServiceReferencingComponentEntity `json:"controllerServiceReferencingComponents,omitempty"`
}

ControllerServiceReferencingComponentsEntity struct for ControllerServiceReferencingComponentsEntity

type ControllerServiceRunStatusEntity ¶ 

type ControllerServiceRunStatusEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The run status of the ControllerService.
	State string `json:"state,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool `json:"disconnectedNodeAcknowledged,omitempty"`
}

ControllerServiceRunStatusEntity struct for ControllerServiceRunStatusEntity

type ControllerServiceStatusDto ¶ 

type ControllerServiceStatusDto struct {
	// The run status of this ControllerService
	RunStatus string `json:"runStatus,omitempty"`
	// Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)
	ValidationStatus string `json:"validationStatus,omitempty"`
	// The number of active threads for the component.
	ActiveThreadCount int32 `json:"activeThreadCount,omitempty"`
}

ControllerServiceStatusDto struct for ControllerServiceStatusDto

type ControllerServiceTypesEntity ¶ 

type ControllerServiceTypesEntity struct {
	ControllerServiceTypes []DocumentedTypeDto `json:"controllerServiceTypes,omitempty"`
}

ControllerServiceTypesEntity struct for ControllerServiceTypesEntity

type ControllerServicesApiRemoveControllerServiceOpts ¶ 

type ControllerServicesApiRemoveControllerServiceOpts struct {
	Version                      optional.String
	ClientId                     optional.String
	DisconnectedNodeAcknowledged optional.Bool
}

ControllerServicesApiRemoveControllerServiceOpts Optional parameters for the method 'RemoveControllerService'

type ControllerServicesApiService ¶ 

type ControllerServicesApiService service

ControllerServicesApiService ControllerServicesApi service

func (*ControllerServicesApiService) ClearState ¶ 

func (a *ControllerServicesApiService) ClearState(ctx _context.Context, id string) (ComponentStateEntity, *_nethttp.Response, error)

ClearState Clears the state for a controller service

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The controller service id.

@return ComponentStateEntity

func (*ControllerServicesApiService) GetControllerService ¶ 

func (a *ControllerServicesApiService) GetControllerService(ctx _context.Context, id string) (ControllerServiceEntity, *_nethttp.Response, error)

GetControllerService Gets a controller service

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The controller service id.

@return ControllerServiceEntity

func (*ControllerServicesApiService) GetControllerServiceReferences ¶ 

func (a *ControllerServicesApiService) GetControllerServiceReferences(ctx _context.Context, id string) (ControllerServiceReferencingComponentsEntity, *_nethttp.Response, error)

GetControllerServiceReferences Gets a controller service

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The controller service id.

@return ControllerServiceReferencingComponentsEntity

func (*ControllerServicesApiService) GetPropertyDescriptor ¶ 

func (a *ControllerServicesApiService) GetPropertyDescriptor(ctx _context.Context, id string, propertyName string) (PropertyDescriptorEntity, *_nethttp.Response, error)

GetPropertyDescriptor Gets a controller service property descriptor

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The controller service id.
  • @param propertyName The property name to return the descriptor for.

@return PropertyDescriptorEntity

func (*ControllerServicesApiService) GetState ¶ 

func (a *ControllerServicesApiService) GetState(ctx _context.Context, id string) (ComponentStateEntity, *_nethttp.Response, error)

GetState Gets the state for a controller service

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The controller service id.

@return ComponentStateEntity

func (*ControllerServicesApiService) RemoveControllerService ¶ 

func (a *ControllerServicesApiService) RemoveControllerService(ctx _context.Context, id string, localVarOptionals *ControllerServicesApiRemoveControllerServiceOpts) (ControllerServiceEntity, *_nethttp.Response, error)

RemoveControllerService Deletes a controller service

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The controller service id.
  • @param optional nil or *ControllerServicesApiRemoveControllerServiceOpts - Optional Parameters:
  • @param "Version" (optional.String) - The revision is used to verify the client is working with the latest version of the flow.
  • @param "ClientId" (optional.String) - If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

@return ControllerServiceEntity

func (*ControllerServicesApiService) UpdateControllerService ¶ 

func (a *ControllerServicesApiService) UpdateControllerService(ctx _context.Context, id string, body ControllerServiceEntity) (ControllerServiceEntity, *_nethttp.Response, error)

UpdateControllerService Updates a controller service

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The controller service id.
  • @param body The controller service configuration details.

@return ControllerServiceEntity

func (*ControllerServicesApiService) UpdateControllerServiceReferences ¶ 

func (a *ControllerServicesApiService) UpdateControllerServiceReferences(ctx _context.Context, id string, body UpdateControllerServiceReferenceRequestEntity) (ControllerServiceReferencingComponentsEntity, *_nethttp.Response, error)

UpdateControllerServiceReferences Updates a controller services references

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The controller service id.
  • @param body The controller service request update request.

@return ControllerServiceReferencingComponentsEntity

func (*ControllerServicesApiService) UpdateRunStatus ¶ 

func (a *ControllerServicesApiService) UpdateRunStatus(ctx _context.Context, id string, body ControllerServiceRunStatusEntity) (ControllerServiceEntity, *_nethttp.Response, error)

UpdateRunStatus Updates run status of a controller service

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The controller service id.
  • @param body The controller service run status.

@return ControllerServiceEntity

type ControllerServicesEntity ¶ 

type ControllerServicesEntity struct {
	// The current time on the system.
	CurrentTime        string                    `json:"currentTime,omitempty"`
	ControllerServices []ControllerServiceEntity `json:"controllerServices,omitempty"`
}

ControllerServicesEntity struct for ControllerServicesEntity

type ControllerStatusDto ¶ 

type ControllerStatusDto struct {
	// The number of active threads in the NiFi.
	ActiveThreadCount int32 `json:"activeThreadCount,omitempty"`
	// The number of terminated threads in the NiFi.
	TerminatedThreadCount int32 `json:"terminatedThreadCount,omitempty"`
	// The number of flowfiles queued in the NiFi.
	Queued string `json:"queued,omitempty"`
	// The number of FlowFiles queued across the entire flow
	FlowFilesQueued int32 `json:"flowFilesQueued,omitempty"`
	// The size of the FlowFiles queued across the entire flow
	BytesQueued int64 `json:"bytesQueued,omitempty"`
	// The number of running components in the NiFi.
	RunningCount int32 `json:"runningCount,omitempty"`
	// The number of stopped components in the NiFi.
	StoppedCount int32 `json:"stoppedCount,omitempty"`
	// The number of invalid components in the NiFi.
	InvalidCount int32 `json:"invalidCount,omitempty"`
	// The number of disabled components in the NiFi.
	DisabledCount int32 `json:"disabledCount,omitempty"`
	// The number of active remote ports in the NiFi.
	ActiveRemotePortCount int32 `json:"activeRemotePortCount,omitempty"`
	// The number of inactive remote ports in the NiFi.
	InactiveRemotePortCount int32 `json:"inactiveRemotePortCount,omitempty"`
	// The number of up to date versioned process groups in the NiFi.
	UpToDateCount int32 `json:"upToDateCount,omitempty"`
	// The number of locally modified versioned process groups in the NiFi.
	LocallyModifiedCount int32 `json:"locallyModifiedCount,omitempty"`
	// The number of stale versioned process groups in the NiFi.
	StaleCount int32 `json:"staleCount,omitempty"`
	// The number of locally modified and stale versioned process groups in the NiFi.
	LocallyModifiedAndStaleCount int32 `json:"locallyModifiedAndStaleCount,omitempty"`
	// The number of versioned process groups in the NiFi that are unable to sync to a registry.
	SyncFailureCount int32 `json:"syncFailureCount,omitempty"`
}

ControllerStatusDto struct for ControllerStatusDto

type ControllerStatusEntity ¶ 

type ControllerStatusEntity struct {
	ControllerStatus ControllerStatusDto `json:"controllerStatus,omitempty"`
}

ControllerStatusEntity struct for ControllerStatusEntity

type CopySnippetRequestEntity ¶ 

type CopySnippetRequestEntity struct {
	// The identifier of the snippet.
	SnippetId string `json:"snippetId,omitempty"`
	// The x coordinate of the origin of the bounding box where the new components will be placed.
	OriginX float64 `json:"originX,omitempty"`
	// The y coordinate of the origin of the bounding box where the new components will be placed.
	OriginY float64 `json:"originY,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool `json:"disconnectedNodeAcknowledged,omitempty"`
}

CopySnippetRequestEntity struct for CopySnippetRequestEntity

type CounterDto ¶ 

type CounterDto struct {
	// The id of the counter.
	Id string `json:"id,omitempty"`
	// The context of the counter.
	Context string `json:"context,omitempty"`
	// The name of the counter.
	Name string `json:"name,omitempty"`
	// The value count.
	ValueCount int64 `json:"valueCount,omitempty"`
	// The value of the counter.
	Value string `json:"value,omitempty"`
}

CounterDto struct for CounterDto

type CounterEntity ¶ 

type CounterEntity struct {
	Counter CounterDto `json:"counter,omitempty"`
}

CounterEntity struct for CounterEntity

type CountersApiGetCountersOpts ¶ 

type CountersApiGetCountersOpts struct {
	Nodewise      optional.Bool
	ClusterNodeId optional.String
}

CountersApiGetCountersOpts Optional parameters for the method 'GetCounters'

type CountersApiService ¶ 

type CountersApiService service

CountersApiService CountersApi service

func (*CountersApiService) GetCounters ¶ 

func (a *CountersApiService) GetCounters(ctx _context.Context, localVarOptionals *CountersApiGetCountersOpts) (CountersEntity, *_nethttp.Response, error)

GetCounters Gets the current counters for this NiFi Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *CountersApiGetCountersOpts - Optional Parameters:
  • @param "Nodewise" (optional.Bool) - Whether or not to include the breakdown per node. Optional, defaults to false
  • @param "ClusterNodeId" (optional.String) - The id of the node where to get the status.

@return CountersEntity

func (*CountersApiService) UpdateCounter ¶ 

func (a *CountersApiService) UpdateCounter(ctx _context.Context, id string) (CounterEntity, *_nethttp.Response, error)

UpdateCounter Updates the specified counter. This will reset the counter value to 0 Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the counter.

@return CounterEntity

type CountersDto ¶ 

type CountersDto struct {
	AggregateSnapshot CountersSnapshotDto `json:"aggregateSnapshot,omitempty"`
	// A Counters snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.
	NodeSnapshots []NodeCountersSnapshotDto `json:"nodeSnapshots,omitempty"`
}

CountersDto struct for CountersDto

type CountersEntity ¶ 

type CountersEntity struct {
	Counters CountersDto `json:"counters,omitempty"`
}

CountersEntity struct for CountersEntity

type CountersSnapshotDto ¶ 

type CountersSnapshotDto struct {
	// The timestamp when the report was generated.
	Generated string `json:"generated,omitempty"`
	// All counters in the NiFi.
	Counters []CounterDto `json:"counters,omitempty"`
}

CountersSnapshotDto struct for CountersSnapshotDto

type CreateActiveRequestEntity ¶ 

type CreateActiveRequestEntity struct {
	// The Process Group ID that this active request will update
	ProcessGroupId string `json:"processGroupId,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool `json:"disconnectedNodeAcknowledged,omitempty"`
}

CreateActiveRequestEntity struct for CreateActiveRequestEntity

type CreateTemplateRequestEntity ¶ 

type CreateTemplateRequestEntity struct {
	// The name of the template.
	Name string `json:"name,omitempty"`
	// The description of the template.
	Description string `json:"description,omitempty"`
	// The identifier of the snippet.
	SnippetId string `json:"snippetId,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool `json:"disconnectedNodeAcknowledged,omitempty"`
}

CreateTemplateRequestEntity struct for CreateTemplateRequestEntity

type CurrentUserEntity ¶ 

type CurrentUserEntity struct {
	// The user identity being serialized.
	Identity string `json:"identity,omitempty"`
	// Whether the current user is anonymous.
	Anonymous                       bool           `json:"anonymous,omitempty"`
	ProvenancePermissions           PermissionsDto `json:"provenancePermissions,omitempty"`
	CountersPermissions             PermissionsDto `json:"countersPermissions,omitempty"`
	TenantsPermissions              PermissionsDto `json:"tenantsPermissions,omitempty"`
	ControllerPermissions           PermissionsDto `json:"controllerPermissions,omitempty"`
	PoliciesPermissions             PermissionsDto `json:"policiesPermissions,omitempty"`
	SystemPermissions               PermissionsDto `json:"systemPermissions,omitempty"`
	ParameterContextPermissions     PermissionsDto `json:"parameterContextPermissions,omitempty"`
	RestrictedComponentsPermissions PermissionsDto `json:"restrictedComponentsPermissions,omitempty"`
	// Permissions for specific component restrictions.
	ComponentRestrictionPermissions []ComponentRestrictionPermissionDto `json:"componentRestrictionPermissions,omitempty"`
	// Whether the current user can version flows.
	CanVersionFlows bool `json:"canVersionFlows,omitempty"`
}

CurrentUserEntity struct for CurrentUserEntity

type DataTransferApiService ¶ 

type DataTransferApiService service

DataTransferApiService DataTransferApi service

func (*DataTransferApiService) CommitInputPortTransaction ¶ 

func (a *DataTransferApiService) CommitInputPortTransaction(ctx _context.Context, responseCode int32, portId string, transactionId string) (TransactionResultEntity, *_nethttp.Response, error)

CommitInputPortTransaction Commit or cancel the specified transaction

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param responseCode The response code. Available values are BAD_CHECKSUM(19), CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).
  • @param portId The input port id.
  • @param transactionId The transaction id.

@return TransactionResultEntity

func (*DataTransferApiService) CommitOutputPortTransaction ¶ 

func (a *DataTransferApiService) CommitOutputPortTransaction(ctx _context.Context, responseCode int32, checksum string, portId string, transactionId string) (TransactionResultEntity, *_nethttp.Response, error)

CommitOutputPortTransaction Commit or cancel the specified transaction

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param responseCode The response code. Available values are CONFIRM_TRANSACTION(12) or CANCEL_TRANSACTION(15).
  • @param checksum A checksum calculated at client side using CRC32 to check flow file content integrity. It must match with the value calculated at server side.
  • @param portId The output port id.
  • @param transactionId The transaction id.

@return TransactionResultEntity

func (*DataTransferApiService) CreatePortTransaction ¶ 

func (a *DataTransferApiService) CreatePortTransaction(ctx _context.Context, portType string, portId string) (TransactionResultEntity, *_nethttp.Response, error)

CreatePortTransaction Create a transaction to the specified output port or input port

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param portType The port type.
  • @param portId

@return TransactionResultEntity

func (*DataTransferApiService) ExtendInputPortTransactionTTL ¶ 

func (a *DataTransferApiService) ExtendInputPortTransactionTTL(ctx _context.Context, portId string, transactionId string) (TransactionResultEntity, *_nethttp.Response, error)

ExtendInputPortTransactionTTL Extend transaction TTL

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param portId
  • @param transactionId

@return TransactionResultEntity

func (*DataTransferApiService) ExtendOutputPortTransactionTTL ¶ 

func (a *DataTransferApiService) ExtendOutputPortTransactionTTL(ctx _context.Context, portId string, transactionId string) (TransactionResultEntity, *_nethttp.Response, error)

ExtendOutputPortTransactionTTL Extend transaction TTL

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param portId
  • @param transactionId

@return TransactionResultEntity

func (*DataTransferApiService) ReceiveFlowFiles ¶ 

func (a *DataTransferApiService) ReceiveFlowFiles(ctx _context.Context, portId string, transactionId string) (string, *_nethttp.Response, error)

ReceiveFlowFiles Transfer flow files to the input port

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param portId The input port id.
  • @param transactionId

@return string

func (*DataTransferApiService) TransferFlowFiles ¶ 

func (a *DataTransferApiService) TransferFlowFiles(ctx _context.Context, portId string, transactionId string) (map[string]interface{}, *_nethttp.Response, error)

TransferFlowFiles Transfer flow files from the output port

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param portId The output port id.
  • @param transactionId

@return map[string]interface{}

type DifferenceDto ¶ 

type DifferenceDto struct {
	// The type of difference
	DifferenceType string `json:"differenceType,omitempty"`
	// Description of the difference
	Difference string `json:"difference,omitempty"`
}

DifferenceDto struct for DifferenceDto

type DimensionsDto ¶ 

type DimensionsDto struct {
	// The width of the label in pixels when at a 1:1 scale.
	Width float64 `json:"width,omitempty"`
	// The height of the label in pixels when at a 1:1 scale.
	Height float64 `json:"height,omitempty"`
}

DimensionsDto struct for DimensionsDto

type DocumentedTypeDto ¶ 

type DocumentedTypeDto struct {
	// The fully qualified name of the type.
	Type   string    `json:"type,omitempty"`
	Bundle BundleDto `json:"bundle,omitempty"`
	// If this type represents a ControllerService, this lists the APIs it implements.
	ControllerServiceApis []ControllerServiceApiDto `json:"controllerServiceApis,omitempty"`
	// The description of the type.
	Description string `json:"description,omitempty"`
	// Whether this type is restricted.
	Restricted bool `json:"restricted,omitempty"`
	// The optional description of why the usage of this component is restricted.
	UsageRestriction string `json:"usageRestriction,omitempty"`
	// An optional collection of explicit restrictions. If specified, these explicit restrictions will be enfored.
	ExplicitRestrictions []ExplicitRestrictionDto `json:"explicitRestrictions,omitempty"`
	// The description of why the usage of this component is restricted.
	DeprecationReason string `json:"deprecationReason,omitempty"`
	// The tags associated with this type.
	Tags []string `json:"tags,omitempty"`
}

DocumentedTypeDto struct for DocumentedTypeDto

type DropRequestDto ¶ 

type DropRequestDto struct {
	// The id for this drop request.
	Id string `json:"id,omitempty"`
	// The URI for future requests to this drop request.
	Uri string `json:"uri,omitempty"`
	// The timestamp when the query was submitted.
	SubmissionTime string `json:"submissionTime,omitempty"`
	// The last time this drop request was updated.
	LastUpdated string `json:"lastUpdated,omitempty"`
	// The current percent complete.
	PercentCompleted int32 `json:"percentCompleted,omitempty"`
	// Whether the query has finished.
	Finished bool `json:"finished,omitempty"`
	// The reason, if any, that this drop request failed.
	FailureReason string `json:"failureReason,omitempty"`
	// The number of flow files currently queued.
	CurrentCount int32 `json:"currentCount,omitempty"`
	// The size of flow files currently queued in bytes.
	CurrentSize int64 `json:"currentSize,omitempty"`
	// The count and size of flow files currently queued.
	Current string `json:"current,omitempty"`
	// The number of flow files to be dropped as a result of this request.
	OriginalCount int32 `json:"originalCount,omitempty"`
	// The size of flow files to be dropped as a result of this request in bytes.
	OriginalSize int64 `json:"originalSize,omitempty"`
	// The count and size of flow files to be dropped as a result of this request.
	Original string `json:"original,omitempty"`
	// The number of flow files that have been dropped thus far.
	DroppedCount int32 `json:"droppedCount,omitempty"`
	// The size of flow files that have been dropped thus far in bytes.
	DroppedSize int64 `json:"droppedSize,omitempty"`
	// The count and size of flow files that have been dropped thus far.
	Dropped string `json:"dropped,omitempty"`
	// The current state of the drop request.
	State string `json:"state,omitempty"`
}

DropRequestDto struct for DropRequestDto

type DropRequestEntity ¶ 

type DropRequestEntity struct {
	DropRequest DropRequestDto `json:"dropRequest,omitempty"`
}

DropRequestEntity struct for DropRequestEntity

type ExplicitRestrictionDto ¶ 

type ExplicitRestrictionDto struct {
	RequiredPermission RequiredPermissionDto `json:"requiredPermission,omitempty"`
	// The description of why the usage of this component is restricted for this required permission.
	Explanation string `json:"explanation,omitempty"`
}

ExplicitRestrictionDto struct for ExplicitRestrictionDto

type ExternalControllerServiceReference ¶ 

type ExternalControllerServiceReference struct {
	// The identifier of the controller service
	Identifier string `json:"identifier,omitempty"`
	// The name of the controller service
	Name string `json:"name,omitempty"`
}

ExternalControllerServiceReference struct for ExternalControllerServiceReference

type FlowApiGetBulletinBoardOpts ¶ 

type FlowApiGetBulletinBoardOpts struct {
	After      optional.String
	SourceName optional.String
	Message    optional.String
	SourceId   optional.String
	GroupId    optional.String
	Limit      optional.String
}

FlowApiGetBulletinBoardOpts Optional parameters for the method 'GetBulletinBoard'

type FlowApiGetConnectionStatisticsOpts ¶ 

type FlowApiGetConnectionStatisticsOpts struct {
	Nodewise      optional.Bool
	ClusterNodeId optional.String
}

FlowApiGetConnectionStatisticsOpts Optional parameters for the method 'GetConnectionStatistics'

type FlowApiGetConnectionStatusOpts ¶ 

type FlowApiGetConnectionStatusOpts struct {
	Nodewise      optional.Bool
	ClusterNodeId optional.String
}

FlowApiGetConnectionStatusOpts Optional parameters for the method 'GetConnectionStatus'

type FlowApiGetControllerServiceTypesOpts ¶ 

type FlowApiGetControllerServiceTypesOpts struct {
	ServiceType           optional.String
	ServiceBundleGroup    optional.String
	ServiceBundleArtifact optional.String
	ServiceBundleVersion  optional.String
	BundleGroupFilter     optional.String
	BundleArtifactFilter  optional.String
	TypeFilter            optional.String
}

FlowApiGetControllerServiceTypesOpts Optional parameters for the method 'GetControllerServiceTypes'

type FlowApiGetControllerServicesFromGroupOpts ¶ 

type FlowApiGetControllerServicesFromGroupOpts struct {
	IncludeAncestorGroups   optional.Bool
	IncludeDescendantGroups optional.Bool
}

FlowApiGetControllerServicesFromGroupOpts Optional parameters for the method 'GetControllerServicesFromGroup'

type FlowApiGetInputPortStatusOpts ¶ 

type FlowApiGetInputPortStatusOpts struct {
	Nodewise      optional.Bool
	ClusterNodeId optional.String
}

FlowApiGetInputPortStatusOpts Optional parameters for the method 'GetInputPortStatus'

type FlowApiGetOutputPortStatusOpts ¶ 

type FlowApiGetOutputPortStatusOpts struct {
	Nodewise      optional.Bool
	ClusterNodeId optional.String
}

FlowApiGetOutputPortStatusOpts Optional parameters for the method 'GetOutputPortStatus'

type FlowApiGetProcessGroupStatusOpts ¶ 

type FlowApiGetProcessGroupStatusOpts struct {
	Recursive     optional.Bool
	Nodewise      optional.Bool
	ClusterNodeId optional.String
}

FlowApiGetProcessGroupStatusOpts Optional parameters for the method 'GetProcessGroupStatus'

type FlowApiGetProcessorStatusOpts ¶ 

type FlowApiGetProcessorStatusOpts struct {
	Nodewise      optional.Bool
	ClusterNodeId optional.String
}

FlowApiGetProcessorStatusOpts Optional parameters for the method 'GetProcessorStatus'

type FlowApiGetProcessorTypesOpts ¶ 

type FlowApiGetProcessorTypesOpts struct {
	BundleGroupFilter    optional.String
	BundleArtifactFilter optional.String
	Type_                optional.String
}

FlowApiGetProcessorTypesOpts Optional parameters for the method 'GetProcessorTypes'

type FlowApiGetRemoteProcessGroupStatusOpts ¶ 

type FlowApiGetRemoteProcessGroupStatusOpts struct {
	Nodewise      optional.Bool
	ClusterNodeId optional.String
}

FlowApiGetRemoteProcessGroupStatusOpts Optional parameters for the method 'GetRemoteProcessGroupStatus'

type FlowApiGetReportingTaskTypesOpts ¶ 

type FlowApiGetReportingTaskTypesOpts struct {
	BundleGroupFilter    optional.String
	BundleArtifactFilter optional.String
	Type_                optional.String
}

FlowApiGetReportingTaskTypesOpts Optional parameters for the method 'GetReportingTaskTypes'

type FlowApiQueryHistoryOpts ¶ 

type FlowApiQueryHistoryOpts struct {
	SortColumn   optional.String
	SortOrder    optional.String
	StartDate    optional.String
	EndDate      optional.String
	UserIdentity optional.String
	SourceId     optional.String
}

FlowApiQueryHistoryOpts Optional parameters for the method 'QueryHistory'

type FlowApiSearchFlowOpts ¶ 

type FlowApiSearchFlowOpts struct {
	Q optional.String
	A optional.String
}

FlowApiSearchFlowOpts Optional parameters for the method 'SearchFlow'

type FlowApiService ¶ 

type FlowApiService service

FlowApiService FlowApi service

func (*FlowApiService) ActivateControllerServices ¶ 

func (a *FlowApiService) ActivateControllerServices(ctx _context.Context, id string, body ActivateControllerServicesEntity) (ActivateControllerServicesEntity, *_nethttp.Response, error)

ActivateControllerServices Enable or disable Controller Services in the specified Process Group.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param body The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.

@return ActivateControllerServicesEntity

func (*FlowApiService) GenerateClientId ¶ 

func (a *FlowApiService) GenerateClientId(ctx _context.Context) (string, *_nethttp.Response, error)

GenerateClientId Generates a client id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return string

func (*FlowApiService) GetAboutInfo ¶ 

func (a *FlowApiService) GetAboutInfo(ctx _context.Context) (AboutEntity, *_nethttp.Response, error)

GetAboutInfo Retrieves details about this NiFi to put in the About dialog

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return AboutEntity

func (*FlowApiService) GetAction ¶ 

func (a *FlowApiService) GetAction(ctx _context.Context, id string) (ActionEntity, *_nethttp.Response, error)

GetAction Gets an action Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The action id.

@return ActionEntity

func (*FlowApiService) GetBanners ¶ 

func (a *FlowApiService) GetBanners(ctx _context.Context) (BannerEntity, *_nethttp.Response, error)

GetBanners Retrieves the banners for this NiFi

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return BannerEntity

func (*FlowApiService) GetBuckets ¶ 

func (a *FlowApiService) GetBuckets(ctx _context.Context, id string) (BucketsEntity, *_nethttp.Response, error)

GetBuckets Gets the buckets from the specified registry for the current user

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The registry id.

@return BucketsEntity

func (*FlowApiService) GetBulletinBoard ¶ 

func (a *FlowApiService) GetBulletinBoard(ctx _context.Context, localVarOptionals *FlowApiGetBulletinBoardOpts) (BulletinBoardEntity, *_nethttp.Response, error)

GetBulletinBoard Gets current bulletins

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *FlowApiGetBulletinBoardOpts - Optional Parameters:
  • @param "After" (optional.String) - Includes bulletins with an id after this value.
  • @param "SourceName" (optional.String) - Includes bulletins originating from this sources whose name match this regular expression.
  • @param "Message" (optional.String) - Includes bulletins whose message that match this regular expression.
  • @param "SourceId" (optional.String) - Includes bulletins originating from this sources whose id match this regular expression.
  • @param "GroupId" (optional.String) - Includes bulletins originating from this sources whose group id match this regular expression.
  • @param "Limit" (optional.String) - The number of bulletins to limit the response to.

@return BulletinBoardEntity

func (*FlowApiService) GetBulletins ¶ 

func (a *FlowApiService) GetBulletins(ctx _context.Context) (ControllerBulletinsEntity, *_nethttp.Response, error)

GetBulletins Retrieves Controller level bulletins

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ControllerBulletinsEntity

func (*FlowApiService) GetClusterSummary ¶ 

func (a *FlowApiService) GetClusterSummary(ctx _context.Context) (ClusteSummaryEntity, *_nethttp.Response, error)

GetClusterSummary The cluster summary for this NiFi

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ClusteSummaryEntity

func (*FlowApiService) GetComponentHistory ¶ 

func (a *FlowApiService) GetComponentHistory(ctx _context.Context, componentId string) (ComponentHistoryEntity, *_nethttp.Response, error)

GetComponentHistory Gets configuration history for a component Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param componentId The component id.

@return ComponentHistoryEntity

func (*FlowApiService) GetConnectionStatistics ¶ 

func (a *FlowApiService) GetConnectionStatistics(ctx _context.Context, id string, localVarOptionals *FlowApiGetConnectionStatisticsOpts) (ConnectionStatisticsEntity, *_nethttp.Response, error)

GetConnectionStatistics Gets statistics for a connection

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The connection id.
  • @param optional nil or *FlowApiGetConnectionStatisticsOpts - Optional Parameters:
  • @param "Nodewise" (optional.Bool) - Whether or not to include the breakdown per node. Optional, defaults to false
  • @param "ClusterNodeId" (optional.String) - The id of the node where to get the statistics.

@return ConnectionStatisticsEntity

func (*FlowApiService) GetConnectionStatus ¶ 

func (a *FlowApiService) GetConnectionStatus(ctx _context.Context, id string, localVarOptionals *FlowApiGetConnectionStatusOpts) (ConnectionStatusEntity, *_nethttp.Response, error)

GetConnectionStatus Gets status for a connection

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The connection id.
  • @param optional nil or *FlowApiGetConnectionStatusOpts - Optional Parameters:
  • @param "Nodewise" (optional.Bool) - Whether or not to include the breakdown per node. Optional, defaults to false
  • @param "ClusterNodeId" (optional.String) - The id of the node where to get the status.

@return ConnectionStatusEntity

func (*FlowApiService) GetConnectionStatusHistory ¶ 

func (a *FlowApiService) GetConnectionStatusHistory(ctx _context.Context, id string) (StatusHistoryEntity, *_nethttp.Response, error)

GetConnectionStatusHistory Gets the status history for a connection

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The connection id.

@return StatusHistoryEntity

func (*FlowApiService) GetControllerServiceTypes ¶ 

func (a *FlowApiService) GetControllerServiceTypes(ctx _context.Context, localVarOptionals *FlowApiGetControllerServiceTypesOpts) (ControllerServiceTypesEntity, *_nethttp.Response, error)

GetControllerServiceTypes Retrieves the types of controller services that this NiFi supports Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *FlowApiGetControllerServiceTypesOpts - Optional Parameters:
  • @param "ServiceType" (optional.String) - If specified, will only return controller services that are compatible with this type of service.
  • @param "ServiceBundleGroup" (optional.String) - If serviceType specified, is the bundle group of the serviceType.
  • @param "ServiceBundleArtifact" (optional.String) - If serviceType specified, is the bundle artifact of the serviceType.
  • @param "ServiceBundleVersion" (optional.String) - If serviceType specified, is the bundle version of the serviceType.
  • @param "BundleGroupFilter" (optional.String) - If specified, will only return types that are a member of this bundle group.
  • @param "BundleArtifactFilter" (optional.String) - If specified, will only return types that are a member of this bundle artifact.
  • @param "TypeFilter" (optional.String) - If specified, will only return types whose fully qualified classname matches.

@return ControllerServiceTypesEntity

func (*FlowApiService) GetControllerServicesFromController ¶ 

func (a *FlowApiService) GetControllerServicesFromController(ctx _context.Context) (ControllerServicesEntity, *_nethttp.Response, error)

GetControllerServicesFromController Gets controller services for reporting tasks

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ControllerServicesEntity

func (*FlowApiService) GetControllerServicesFromGroup ¶ 

func (a *FlowApiService) GetControllerServicesFromGroup(ctx _context.Context, id string, localVarOptionals *FlowApiGetControllerServicesFromGroupOpts) (ControllerServicesEntity, *_nethttp.Response, error)

GetControllerServicesFromGroup Gets all controller services

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param optional nil or *FlowApiGetControllerServicesFromGroupOpts - Optional Parameters:
  • @param "IncludeAncestorGroups" (optional.Bool) - Whether or not to include parent/ancestory process groups
  • @param "IncludeDescendantGroups" (optional.Bool) - Whether or not to include descendant process groups

@return ControllerServicesEntity

func (*FlowApiService) GetControllerStatus ¶ 

func (a *FlowApiService) GetControllerStatus(ctx _context.Context) (ControllerStatusEntity, *_nethttp.Response, error)

GetControllerStatus Gets the current status of this NiFi

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ControllerStatusEntity

func (*FlowApiService) GetCurrentUser ¶ 

func (a *FlowApiService) GetCurrentUser(ctx _context.Context) (CurrentUserEntity, *_nethttp.Response, error)

GetCurrentUser Retrieves the user identity of the user making the request

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return CurrentUserEntity

func (*FlowApiService) GetFlow ¶ 

func (a *FlowApiService) GetFlow(ctx _context.Context, id string) (ProcessGroupFlowEntity, *_nethttp.Response, error)

GetFlow Gets a process group

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.

@return ProcessGroupFlowEntity

func (*FlowApiService) GetFlowConfig ¶ 

func (a *FlowApiService) GetFlowConfig(ctx _context.Context) (FlowConfigurationEntity, *_nethttp.Response, error)

GetFlowConfig Retrieves the configuration for this NiFi flow

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return FlowConfigurationEntity

func (*FlowApiService) GetFlowMetrics ¶ 

func (a *FlowApiService) GetFlowMetrics(ctx _context.Context, producer string) (map[string]interface{}, *_nethttp.Response, error)

GetFlowMetrics Gets all metrics for the flow from a particular node

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param producer The producer for flow file metrics. Each producer may have its own output format.

@return map[string]interface{}

func (*FlowApiService) GetFlows ¶ 

func (a *FlowApiService) GetFlows(ctx _context.Context, registryId string, bucketId string) (VersionedFlowsEntity, *_nethttp.Response, error)

GetFlows Gets the flows from the specified registry and bucket for the current user

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param registryId The registry id.
  • @param bucketId The bucket id.

@return VersionedFlowsEntity

func (*FlowApiService) GetInputPortStatus ¶ 

func (a *FlowApiService) GetInputPortStatus(ctx _context.Context, id string, localVarOptionals *FlowApiGetInputPortStatusOpts) (PortStatusEntity, *_nethttp.Response, error)

GetInputPortStatus Gets status for an input port

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The input port id.
  • @param optional nil or *FlowApiGetInputPortStatusOpts - Optional Parameters:
  • @param "Nodewise" (optional.Bool) - Whether or not to include the breakdown per node. Optional, defaults to false
  • @param "ClusterNodeId" (optional.String) - The id of the node where to get the status.

@return PortStatusEntity

func (*FlowApiService) GetOutputPortStatus ¶ 

func (a *FlowApiService) GetOutputPortStatus(ctx _context.Context, id string, localVarOptionals *FlowApiGetOutputPortStatusOpts) (PortStatusEntity, *_nethttp.Response, error)

GetOutputPortStatus Gets status for an output port

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The output port id.
  • @param optional nil or *FlowApiGetOutputPortStatusOpts - Optional Parameters:
  • @param "Nodewise" (optional.Bool) - Whether or not to include the breakdown per node. Optional, defaults to false
  • @param "ClusterNodeId" (optional.String) - The id of the node where to get the status.

@return PortStatusEntity

func (*FlowApiService) GetParameterContexts ¶ 

func (a *FlowApiService) GetParameterContexts(ctx _context.Context) (ParameterContextsEntity, *_nethttp.Response, error)

GetParameterContexts Gets all Parameter Contexts

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ParameterContextsEntity

func (*FlowApiService) GetPrioritizers ¶ 

func (a *FlowApiService) GetPrioritizers(ctx _context.Context) (PrioritizerTypesEntity, *_nethttp.Response, error)

GetPrioritizers Retrieves the types of prioritizers that this NiFi supports Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return PrioritizerTypesEntity

func (*FlowApiService) GetProcessGroupStatus ¶ 

func (a *FlowApiService) GetProcessGroupStatus(ctx _context.Context, id string, localVarOptionals *FlowApiGetProcessGroupStatusOpts) (ProcessGroupStatusEntity, *_nethttp.Response, error)

GetProcessGroupStatus Gets the status for a process group The status for a process group includes status for all descendent components. When invoked on the root group with recursive set to true, it will return the current status of every component in the flow.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param optional nil or *FlowApiGetProcessGroupStatusOpts - Optional Parameters:
  • @param "Recursive" (optional.Bool) - Whether all descendant groups and the status of their content will be included. Optional, defaults to false
  • @param "Nodewise" (optional.Bool) - Whether or not to include the breakdown per node. Optional, defaults to false
  • @param "ClusterNodeId" (optional.String) - The id of the node where to get the status.

@return ProcessGroupStatusEntity

func (*FlowApiService) GetProcessGroupStatusHistory ¶ 

func (a *FlowApiService) GetProcessGroupStatusHistory(ctx _context.Context, id string) (StatusHistoryEntity, *_nethttp.Response, error)

GetProcessGroupStatusHistory Gets status history for a remote process group

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.

@return StatusHistoryEntity

func (*FlowApiService) GetProcessorStatus ¶ 

func (a *FlowApiService) GetProcessorStatus(ctx _context.Context, id string, localVarOptionals *FlowApiGetProcessorStatusOpts) (ProcessorStatusEntity, *_nethttp.Response, error)

GetProcessorStatus Gets status for a processor

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The processor id.
  • @param optional nil or *FlowApiGetProcessorStatusOpts - Optional Parameters:
  • @param "Nodewise" (optional.Bool) - Whether or not to include the breakdown per node. Optional, defaults to false
  • @param "ClusterNodeId" (optional.String) - The id of the node where to get the status.

@return ProcessorStatusEntity

func (*FlowApiService) GetProcessorStatusHistory ¶ 

func (a *FlowApiService) GetProcessorStatusHistory(ctx _context.Context, id string) (StatusHistoryEntity, *_nethttp.Response, error)

GetProcessorStatusHistory Gets status history for a processor

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The processor id.

@return StatusHistoryEntity

func (*FlowApiService) GetProcessorTypes ¶ 

func (a *FlowApiService) GetProcessorTypes(ctx _context.Context, localVarOptionals *FlowApiGetProcessorTypesOpts) (ProcessorTypesEntity, *_nethttp.Response, error)

GetProcessorTypes Retrieves the types of processors that this NiFi supports Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *FlowApiGetProcessorTypesOpts - Optional Parameters:
  • @param "BundleGroupFilter" (optional.String) - If specified, will only return types that are a member of this bundle group.
  • @param "BundleArtifactFilter" (optional.String) - If specified, will only return types that are a member of this bundle artifact.
  • @param "Type_" (optional.String) - If specified, will only return types whose fully qualified classname matches.

@return ProcessorTypesEntity

func (*FlowApiService) GetRegistries ¶ 

func (a *FlowApiService) GetRegistries(ctx _context.Context) (RegistryClientsEntity, *_nethttp.Response, error)

GetRegistries Gets the listing of available registries

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return RegistryClientsEntity

func (*FlowApiService) GetRemoteProcessGroupStatus ¶ 

func (a *FlowApiService) GetRemoteProcessGroupStatus(ctx _context.Context, id string, localVarOptionals *FlowApiGetRemoteProcessGroupStatusOpts) (RemoteProcessGroupStatusEntity, *_nethttp.Response, error)

GetRemoteProcessGroupStatus Gets status for a remote process group

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The remote process group id.
  • @param optional nil or *FlowApiGetRemoteProcessGroupStatusOpts - Optional Parameters:
  • @param "Nodewise" (optional.Bool) - Whether or not to include the breakdown per node. Optional, defaults to false
  • @param "ClusterNodeId" (optional.String) - The id of the node where to get the status.

@return RemoteProcessGroupStatusEntity

func (*FlowApiService) GetRemoteProcessGroupStatusHistory ¶ 

func (a *FlowApiService) GetRemoteProcessGroupStatusHistory(ctx _context.Context, id string) (StatusHistoryEntity, *_nethttp.Response, error)

GetRemoteProcessGroupStatusHistory Gets the status history

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The remote process group id.

@return StatusHistoryEntity

func (*FlowApiService) GetReportingTaskTypes ¶ 

func (a *FlowApiService) GetReportingTaskTypes(ctx _context.Context, localVarOptionals *FlowApiGetReportingTaskTypesOpts) (ReportingTaskTypesEntity, *_nethttp.Response, error)

GetReportingTaskTypes Retrieves the types of reporting tasks that this NiFi supports Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *FlowApiGetReportingTaskTypesOpts - Optional Parameters:
  • @param "BundleGroupFilter" (optional.String) - If specified, will only return types that are a member of this bundle group.
  • @param "BundleArtifactFilter" (optional.String) - If specified, will only return types that are a member of this bundle artifact.
  • @param "Type_" (optional.String) - If specified, will only return types whose fully qualified classname matches.

@return ReportingTaskTypesEntity

func (*FlowApiService) GetReportingTasks ¶ 

func (a *FlowApiService) GetReportingTasks(ctx _context.Context) (ReportingTasksEntity, *_nethttp.Response, error)

GetReportingTasks Gets all reporting tasks

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ReportingTasksEntity

func (*FlowApiService) GetTemplates ¶ 

func (a *FlowApiService) GetTemplates(ctx _context.Context) (TemplatesEntity, *_nethttp.Response, error)

GetTemplates Gets all templates

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return TemplatesEntity

func (*FlowApiService) GetVersions ¶ 

func (a *FlowApiService) GetVersions(ctx _context.Context, registryId string, bucketId string, flowId string) (VersionedFlowSnapshotMetadataSetEntity, *_nethttp.Response, error)

GetVersions Gets the flow versions from the specified registry and bucket for the specified flow for the current user

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param registryId The registry id.
  • @param bucketId The bucket id.
  • @param flowId The flow id.

@return VersionedFlowSnapshotMetadataSetEntity

func (*FlowApiService) QueryHistory ¶ 

func (a *FlowApiService) QueryHistory(ctx _context.Context, offset string, count string, localVarOptionals *FlowApiQueryHistoryOpts) (HistoryEntity, *_nethttp.Response, error)

QueryHistory Gets configuration history Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param offset The offset into the result set.
  • @param count The number of actions to return.
  • @param optional nil or *FlowApiQueryHistoryOpts - Optional Parameters:
  • @param "SortColumn" (optional.String) - The field to sort on.
  • @param "SortOrder" (optional.String) - The direction to sort.
  • @param "StartDate" (optional.String) - Include actions after this date.
  • @param "EndDate" (optional.String) - Include actions before this date.
  • @param "UserIdentity" (optional.String) - Include actions performed by this user.
  • @param "SourceId" (optional.String) - Include actions on this component.

@return HistoryEntity

func (*FlowApiService) ScheduleComponents ¶ 

func (a *FlowApiService) ScheduleComponents(ctx _context.Context, id string, body ScheduleComponentsEntity) (ScheduleComponentsEntity, *_nethttp.Response, error)

ScheduleComponents Schedule or unschedule components in the specified Process Group.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param body The request to schedule or unschedule. If the comopnents in the request are not specified, all authorized components will be considered.

@return ScheduleComponentsEntity

func (*FlowApiService) SearchCluster ¶ 

func (a *FlowApiService) SearchCluster(ctx _context.Context, q string) (ClusterSearchResultsEntity, *_nethttp.Response, error)

SearchCluster Searches the cluster for a node with the specified address Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param q Node address to search for.

@return ClusterSearchResultsEntity

func (*FlowApiService) SearchFlow ¶ 

func (a *FlowApiService) SearchFlow(ctx _context.Context, localVarOptionals *FlowApiSearchFlowOpts) (SearchResultsEntity, *_nethttp.Response, error)

SearchFlow Performs a search against this NiFi using the specified search term Only search results from authorized components will be returned.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *FlowApiSearchFlowOpts - Optional Parameters:
  • @param "Q" (optional.String) -
  • @param "A" (optional.String) -

@return SearchResultsEntity

type FlowBreadcrumbDto ¶ 

type FlowBreadcrumbDto struct {
	// The id of the group.
	Id string `json:"id,omitempty"`
	// The id of the group.
	Name                      string                       `json:"name,omitempty"`
	VersionControlInformation VersionControlInformationDto `json:"versionControlInformation,omitempty"`
}

FlowBreadcrumbDto struct for FlowBreadcrumbDto

type FlowBreadcrumbEntity ¶ 

type FlowBreadcrumbEntity struct {
	// The id of this ancestor ProcessGroup.
	Id          string         `json:"id,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
	// The current state of the Process Group, as it relates to the Versioned Flow
	VersionedFlowState string                `json:"versionedFlowState,omitempty"`
	Breadcrumb         FlowBreadcrumbDto     `json:"breadcrumb,omitempty"`
	ParentBreadcrumb   *FlowBreadcrumbEntity `json:"parentBreadcrumb,omitempty"`
}

FlowBreadcrumbEntity struct for FlowBreadcrumbEntity

type FlowComparisonEntity ¶ 

type FlowComparisonEntity struct {
	// The list of differences for each component in the flow that is not the same between the two flows
	ComponentDifferences []ComponentDifferenceDto `json:"componentDifferences,omitempty"`
}

FlowComparisonEntity struct for FlowComparisonEntity

type FlowConfigurationDto ¶ 

type FlowConfigurationDto struct {
	// Whether this NiFi supports a managed authorizer. Managed authorizers can visualize users, groups, and policies in the UI.
	SupportsManagedAuthorizer bool `json:"supportsManagedAuthorizer,omitempty"`
	// Whether this NiFi supports a configurable authorizer.
	SupportsConfigurableAuthorizer bool `json:"supportsConfigurableAuthorizer,omitempty"`
	// Whether this NiFi supports configurable users and groups.
	SupportsConfigurableUsersAndGroups bool `json:"supportsConfigurableUsersAndGroups,omitempty"`
	// The interval in seconds between the automatic NiFi refresh requests.
	AutoRefreshIntervalSeconds int64 `json:"autoRefreshIntervalSeconds,omitempty"`
	// The current time on the system.
	CurrentTime string `json:"currentTime,omitempty"`
	// The time offset of the system.
	TimeOffset int32 `json:"timeOffset,omitempty"`
	// The default back pressure object threshold.
	DefaultBackPressureObjectThreshold int64 `json:"defaultBackPressureObjectThreshold,omitempty"`
	// The default back pressure data size threshold.
	DefaultBackPressureDataSizeThreshold string `json:"defaultBackPressureDataSizeThreshold,omitempty"`
}

FlowConfigurationDto struct for FlowConfigurationDto

type FlowConfigurationEntity ¶ 

type FlowConfigurationEntity struct {
	FlowConfiguration FlowConfigurationDto `json:"flowConfiguration,omitempty"`
}

FlowConfigurationEntity struct for FlowConfigurationEntity

type FlowDto ¶ 

type FlowDto struct {
	// The process groups in this flow.
	ProcessGroups []ProcessGroupEntity `json:"processGroups,omitempty"`
	// The remote process groups in this flow.
	RemoteProcessGroups []RemoteProcessGroupEntity `json:"remoteProcessGroups,omitempty"`
	// The processors in this flow.
	Processors []ProcessorEntity `json:"processors,omitempty"`
	// The input ports in this flow.
	InputPorts []PortEntity `json:"inputPorts,omitempty"`
	// The output ports in this flow.
	OutputPorts []PortEntity `json:"outputPorts,omitempty"`
	// The connections in this flow.
	Connections []ConnectionEntity `json:"connections,omitempty"`
	// The labels in this flow.
	Labels []LabelEntity `json:"labels,omitempty"`
	// The funnels in this flow.
	Funnels []FunnelEntity `json:"funnels,omitempty"`
}

FlowDto struct for FlowDto

type FlowEntity ¶ 

type FlowEntity struct {
	Flow FlowDto `json:"flow,omitempty"`
}

FlowEntity struct for FlowEntity

type FlowFileDto ¶ 

type FlowFileDto struct {
	// The URI that can be used to access this FlowFile.
	Uri string `json:"uri,omitempty"`
	// The FlowFile UUID.
	Uuid string `json:"uuid,omitempty"`
	// The FlowFile filename.
	Filename string `json:"filename,omitempty"`
	// The FlowFile's position in the queue.
	Position int32 `json:"position,omitempty"`
	// The FlowFile file size.
	Size int64 `json:"size,omitempty"`
	// How long this FlowFile has been enqueued.
	QueuedDuration int64 `json:"queuedDuration,omitempty"`
	// Duration since the FlowFile's greatest ancestor entered the flow.
	LineageDuration int64 `json:"lineageDuration,omitempty"`
	// How long in milliseconds until the FlowFile penalty expires.
	PenaltyExpiresIn int64 `json:"penaltyExpiresIn,omitempty"`
	// The id of the node where this FlowFile resides.
	ClusterNodeId string `json:"clusterNodeId,omitempty"`
	// The label for the node where this FlowFile resides.
	ClusterNodeAddress string `json:"clusterNodeAddress,omitempty"`
	// The FlowFile attributes.
	Attributes map[string]string `json:"attributes,omitempty"`
	// The section in which the content claim lives.
	ContentClaimSection string `json:"contentClaimSection,omitempty"`
	// The container in which the content claim lives.
	ContentClaimContainer string `json:"contentClaimContainer,omitempty"`
	// The identifier of the content claim.
	ContentClaimIdentifier string `json:"contentClaimIdentifier,omitempty"`
	// The offset into the content claim where the flowfile's content begins.
	ContentClaimOffset int64 `json:"contentClaimOffset,omitempty"`
	// The file size of the content claim formatted.
	ContentClaimFileSize string `json:"contentClaimFileSize,omitempty"`
	// The file size of the content claim in bytes.
	ContentClaimFileSizeBytes int64 `json:"contentClaimFileSizeBytes,omitempty"`
	// If the FlowFile is penalized.
	Penalized bool `json:"penalized,omitempty"`
}

FlowFileDto struct for FlowFileDto

type FlowFileEntity ¶ 

type FlowFileEntity struct {
	FlowFile FlowFileDto `json:"flowFile,omitempty"`
}

FlowFileEntity struct for FlowFileEntity

type FlowFileSummaryDto ¶ 

type FlowFileSummaryDto struct {
	// The URI that can be used to access this FlowFile.
	Uri string `json:"uri,omitempty"`
	// The FlowFile UUID.
	Uuid string `json:"uuid,omitempty"`
	// The FlowFile filename.
	Filename string `json:"filename,omitempty"`
	// The FlowFile's position in the queue.
	Position int32 `json:"position,omitempty"`
	// The FlowFile file size.
	Size int64 `json:"size,omitempty"`
	// How long this FlowFile has been enqueued.
	QueuedDuration int64 `json:"queuedDuration,omitempty"`
	// Duration since the FlowFile's greatest ancestor entered the flow.
	LineageDuration int64 `json:"lineageDuration,omitempty"`
	// How long in milliseconds until the FlowFile penalty expires.
	PenaltyExpiresIn int64 `json:"penaltyExpiresIn,omitempty"`
	// The id of the node where this FlowFile resides.
	ClusterNodeId string `json:"clusterNodeId,omitempty"`
	// The label for the node where this FlowFile resides.
	ClusterNodeAddress string `json:"clusterNodeAddress,omitempty"`
	// If the FlowFile is penalized.
	Penalized bool `json:"penalized,omitempty"`
}

FlowFileSummaryDto struct for FlowFileSummaryDto

type FlowSnippetDto ¶ 

type FlowSnippetDto struct {
	// The process groups in this flow snippet.
	ProcessGroups []ProcessGroupDto `json:"processGroups,omitempty"`
	// The remote process groups in this flow snippet.
	RemoteProcessGroups []RemoteProcessGroupDto `json:"remoteProcessGroups,omitempty"`
	// The processors in this flow snippet.
	Processors []ProcessorDto `json:"processors,omitempty"`
	// The input ports in this flow snippet.
	InputPorts []PortDto `json:"inputPorts,omitempty"`
	// The output ports in this flow snippet.
	OutputPorts []PortDto `json:"outputPorts,omitempty"`
	// The connections in this flow snippet.
	Connections []ConnectionDto `json:"connections,omitempty"`
	// The labels in this flow snippet.
	Labels []LabelDto `json:"labels,omitempty"`
	// The funnels in this flow snippet.
	Funnels []FunnelDto `json:"funnels,omitempty"`
	// The controller services in this flow snippet.
	ControllerServices []ControllerServiceDto `json:"controllerServices,omitempty"`
}

FlowSnippetDto struct for FlowSnippetDto

type FlowfileQueuesApiDownloadFlowFileContentOpts ¶ 

type FlowfileQueuesApiDownloadFlowFileContentOpts struct {
	ClientId      optional.String
	ClusterNodeId optional.String
}

FlowfileQueuesApiDownloadFlowFileContentOpts Optional parameters for the method 'DownloadFlowFileContent'

type FlowfileQueuesApiGetFlowFileOpts ¶ 

type FlowfileQueuesApiGetFlowFileOpts struct {
	ClusterNodeId optional.String
}

FlowfileQueuesApiGetFlowFileOpts Optional parameters for the method 'GetFlowFile'

type FlowfileQueuesApiService ¶ 

type FlowfileQueuesApiService service

FlowfileQueuesApiService FlowfileQueuesApi service

func (*FlowfileQueuesApiService) CreateDropRequest ¶ 

func (a *FlowfileQueuesApiService) CreateDropRequest(ctx _context.Context, id string) (DropRequestEntity, *_nethttp.Response, error)

CreateDropRequest Creates a request to drop the contents of the queue in this connection.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The connection id.

@return DropRequestEntity

func (*FlowfileQueuesApiService) CreateFlowFileListing ¶ 

func (a *FlowfileQueuesApiService) CreateFlowFileListing(ctx _context.Context, id string) (ListingRequestEntity, *_nethttp.Response, error)

CreateFlowFileListing Lists the contents of the queue in this connection.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The connection id.

@return ListingRequestEntity

func (*FlowfileQueuesApiService) DeleteListingRequest ¶ 

func (a *FlowfileQueuesApiService) DeleteListingRequest(ctx _context.Context, id string, listingRequestId string) (ListingRequestEntity, *_nethttp.Response, error)

DeleteListingRequest Cancels and/or removes a request to list the contents of this connection.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The connection id.
  • @param listingRequestId The listing request id.

@return ListingRequestEntity

func (*FlowfileQueuesApiService) DownloadFlowFileContent ¶ 

func (a *FlowfileQueuesApiService) DownloadFlowFileContent(ctx _context.Context, id string, flowfileUuid string, localVarOptionals *FlowfileQueuesApiDownloadFlowFileContentOpts) (map[string]interface{}, *_nethttp.Response, error)

DownloadFlowFileContent Gets the content for a FlowFile in a Connection.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The connection id.
  • @param flowfileUuid The flowfile uuid.
  • @param optional nil or *FlowfileQueuesApiDownloadFlowFileContentOpts - Optional Parameters:
  • @param "ClientId" (optional.String) - If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param "ClusterNodeId" (optional.String) - The id of the node where the content exists if clustered.

@return map[string]interface{}

func (*FlowfileQueuesApiService) GetDropRequest ¶ 

func (a *FlowfileQueuesApiService) GetDropRequest(ctx _context.Context, id string, dropRequestId string) (DropRequestEntity, *_nethttp.Response, error)

GetDropRequest Gets the current status of a drop request for the specified connection.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The connection id.
  • @param dropRequestId The drop request id.

@return DropRequestEntity

func (*FlowfileQueuesApiService) GetFlowFile ¶ 

func (a *FlowfileQueuesApiService) GetFlowFile(ctx _context.Context, id string, flowfileUuid string, localVarOptionals *FlowfileQueuesApiGetFlowFileOpts) (FlowFileEntity, *_nethttp.Response, error)

GetFlowFile Gets a FlowFile from a Connection.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The connection id.
  • @param flowfileUuid The flowfile uuid.
  • @param optional nil or *FlowfileQueuesApiGetFlowFileOpts - Optional Parameters:
  • @param "ClusterNodeId" (optional.String) - The id of the node where the content exists if clustered.

@return FlowFileEntity

func (*FlowfileQueuesApiService) GetListingRequest ¶ 

func (a *FlowfileQueuesApiService) GetListingRequest(ctx _context.Context, id string, listingRequestId string) (ListingRequestEntity, *_nethttp.Response, error)

GetListingRequest Gets the current status of a listing request for the specified connection.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The connection id.
  • @param listingRequestId The listing request id.

@return ListingRequestEntity

func (*FlowfileQueuesApiService) RemoveDropRequest ¶ 

func (a *FlowfileQueuesApiService) RemoveDropRequest(ctx _context.Context, id string, dropRequestId string) (DropRequestEntity, *_nethttp.Response, error)

RemoveDropRequest Cancels and/or removes a request to drop the contents of this connection.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The connection id.
  • @param dropRequestId The drop request id.

@return DropRequestEntity

type FunnelApiRemoveFunnelOpts ¶ 

type FunnelApiRemoveFunnelOpts struct {
	Version                      optional.String
	ClientId                     optional.String
	DisconnectedNodeAcknowledged optional.Bool
}

FunnelApiRemoveFunnelOpts Optional parameters for the method 'RemoveFunnel'

type FunnelApiService ¶ 

type FunnelApiService service

FunnelApiService FunnelApi service

func (*FunnelApiService) GetFunnel ¶ 

func (a *FunnelApiService) GetFunnel(ctx _context.Context, id string) (FunnelEntity, *_nethttp.Response, error)

GetFunnel Gets a funnel

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The funnel id.

@return FunnelEntity

func (*FunnelApiService) RemoveFunnel ¶ 

func (a *FunnelApiService) RemoveFunnel(ctx _context.Context, id string, localVarOptionals *FunnelApiRemoveFunnelOpts) (FunnelEntity, *_nethttp.Response, error)

RemoveFunnel Deletes a funnel

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The funnel id.
  • @param optional nil or *FunnelApiRemoveFunnelOpts - Optional Parameters:
  • @param "Version" (optional.String) - The revision is used to verify the client is working with the latest version of the flow.
  • @param "ClientId" (optional.String) - If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

@return FunnelEntity

func (*FunnelApiService) UpdateFunnel ¶ 

func (a *FunnelApiService) UpdateFunnel(ctx _context.Context, id string, body FunnelEntity) (FunnelEntity, *_nethttp.Response, error)

UpdateFunnel Updates a funnel

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The funnel id.
  • @param body The funnel configuration details.

@return FunnelEntity

type FunnelDto ¶ 

type FunnelDto struct {
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The ID of the corresponding component that is under version control
	VersionedComponentId string `json:"versionedComponentId,omitempty"`
	// The id of parent process group of this component if applicable.
	ParentGroupId string      `json:"parentGroupId,omitempty"`
	Position      PositionDto `json:"position,omitempty"`
}

FunnelDto struct for FunnelDto

type FunnelEntity ¶ 

type FunnelEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The URI for futures requests to the component.
	Uri         string         `json:"uri,omitempty"`
	Position    PositionDto    `json:"position,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
	// The bulletins for this component.
	Bulletins []BulletinEntity `json:"bulletins,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool      `json:"disconnectedNodeAcknowledged,omitempty"`
	Component                    FunnelDto `json:"component,omitempty"`
}

FunnelEntity struct for FunnelEntity

type FunnelsEntity ¶ 

type FunnelsEntity struct {
	Funnels []FunnelEntity `json:"funnels,omitempty"`
}

FunnelsEntity struct for FunnelsEntity

type GarbageCollectionDto ¶ 

type GarbageCollectionDto struct {
	// The name of the garbage collector.
	Name string `json:"name,omitempty"`
	// The number of times garbage collection has run.
	CollectionCount int64 `json:"collectionCount,omitempty"`
	// The total amount of time spent garbage collecting.
	CollectionTime string `json:"collectionTime,omitempty"`
	// The total number of milliseconds spent garbage collecting.
	CollectionMillis int64 `json:"collectionMillis,omitempty"`
}

GarbageCollectionDto struct for GarbageCollectionDto

type GenericOpenAPIError ¶ 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body ¶ 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error ¶ 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model ¶ 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type HistoryDto ¶ 

type HistoryDto struct {
	// The number of number of actions that matched the search criteria..
	Total int32 `json:"total,omitempty"`
	// The timestamp when the report was generated.
	LastRefreshed string `json:"lastRefreshed,omitempty"`
	// The actions.
	Actions []ActionEntity `json:"actions,omitempty"`
}

HistoryDto struct for HistoryDto

type HistoryEntity ¶ 

type HistoryEntity struct {
	History HistoryDto `json:"history,omitempty"`
}

HistoryEntity struct for HistoryEntity

type InputPortsApiRemoveInputPortOpts ¶ 

type InputPortsApiRemoveInputPortOpts struct {
	Version                      optional.String
	ClientId                     optional.String
	DisconnectedNodeAcknowledged optional.Bool
}

InputPortsApiRemoveInputPortOpts Optional parameters for the method 'RemoveInputPort'

type InputPortsApiService ¶ 

type InputPortsApiService service

InputPortsApiService InputPortsApi service

func (*InputPortsApiService) GetInputPort ¶ 

func (a *InputPortsApiService) GetInputPort(ctx _context.Context, id string) (PortEntity, *_nethttp.Response, error)

GetInputPort Gets an input port

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The input port id.

@return PortEntity

func (*InputPortsApiService) RemoveInputPort ¶ 

func (a *InputPortsApiService) RemoveInputPort(ctx _context.Context, id string, localVarOptionals *InputPortsApiRemoveInputPortOpts) (PortEntity, *_nethttp.Response, error)

RemoveInputPort Deletes an input port

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The input port id.
  • @param optional nil or *InputPortsApiRemoveInputPortOpts - Optional Parameters:
  • @param "Version" (optional.String) - The revision is used to verify the client is working with the latest version of the flow.
  • @param "ClientId" (optional.String) - If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

@return PortEntity

func (*InputPortsApiService) UpdateInputPort ¶ 

func (a *InputPortsApiService) UpdateInputPort(ctx _context.Context, id string, body PortEntity) (PortEntity, *_nethttp.Response, error)

UpdateInputPort Updates an input port

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The input port id.
  • @param body The input port configuration details.

@return PortEntity

func (*InputPortsApiService) UpdateRunStatus ¶ 

func (a *InputPortsApiService) UpdateRunStatus(ctx _context.Context, id string, body PortRunStatusEntity) (ProcessorEntity, *_nethttp.Response, error)

UpdateRunStatus Updates run status of an input-port

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The port id.
  • @param body The port run status.

@return ProcessorEntity

type InputPortsEntity ¶ 

type InputPortsEntity struct {
	InputPorts []PortEntity `json:"inputPorts,omitempty"`
}

InputPortsEntity struct for InputPortsEntity

type InstantiateTemplateRequestEntity ¶ 

type InstantiateTemplateRequestEntity struct {
	// The x coordinate of the origin of the bounding box where the new components will be placed.
	OriginX float64 `json:"originX,omitempty"`
	// The y coordinate of the origin of the bounding box where the new components will be placed.
	OriginY float64 `json:"originY,omitempty"`
	// The identifier of the template.
	TemplateId string `json:"templateId,omitempty"`
	// The encoding version of the flow snippet. If not specified, this is automatically populated by the node receiving the user request. If the snippet is specified, the version will be the latest. If the snippet is not specified, the version will come from the underlying template. These details need to be replicated throughout the cluster to ensure consistency.
	EncodingVersion string         `json:"encodingVersion,omitempty"`
	Snippet         FlowSnippetDto `json:"snippet,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool `json:"disconnectedNodeAcknowledged,omitempty"`
}

InstantiateTemplateRequestEntity struct for InstantiateTemplateRequestEntity 

type JaxbLink struct {
	// The href for the link
	Href string `json:"href,omitempty"`
	// The params for the link
	Params map[string]string `json:"params,omitempty"`
}

JaxbLink struct for JaxbLink

type LabelDto ¶ 

type LabelDto struct {
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The ID of the corresponding component that is under version control
	VersionedComponentId string `json:"versionedComponentId,omitempty"`
	// The id of parent process group of this component if applicable.
	ParentGroupId string      `json:"parentGroupId,omitempty"`
	Position      PositionDto `json:"position,omitempty"`
	// The text that appears in the label.
	Label string `json:"label,omitempty"`
	// The width of the label in pixels when at a 1:1 scale.
	Width float64 `json:"width,omitempty"`
	// The height of the label in pixels when at a 1:1 scale.
	Height float64 `json:"height,omitempty"`
	// The styles for this label (font-size : 12px, background-color : #eee, etc).
	Style map[string]string `json:"style,omitempty"`
}

LabelDto struct for LabelDto

type LabelEntity ¶ 

type LabelEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The URI for futures requests to the component.
	Uri         string         `json:"uri,omitempty"`
	Position    PositionDto    `json:"position,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
	// The bulletins for this component.
	Bulletins []BulletinEntity `json:"bulletins,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool          `json:"disconnectedNodeAcknowledged,omitempty"`
	Dimensions                   DimensionsDto `json:"dimensions,omitempty"`
	Component                    LabelDto      `json:"component,omitempty"`
}

LabelEntity struct for LabelEntity

type LabelsApiRemoveLabelOpts ¶ 

type LabelsApiRemoveLabelOpts struct {
	Version                      optional.String
	ClientId                     optional.String
	DisconnectedNodeAcknowledged optional.Bool
}

LabelsApiRemoveLabelOpts Optional parameters for the method 'RemoveLabel'

type LabelsApiService ¶ 

type LabelsApiService service

LabelsApiService LabelsApi service

func (*LabelsApiService) GetLabel ¶ 

func (a *LabelsApiService) GetLabel(ctx _context.Context, id string) (LabelEntity, *_nethttp.Response, error)

GetLabel Gets a label

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The label id.

@return LabelEntity

func (*LabelsApiService) RemoveLabel ¶ 

func (a *LabelsApiService) RemoveLabel(ctx _context.Context, id string, localVarOptionals *LabelsApiRemoveLabelOpts) (LabelEntity, *_nethttp.Response, error)

RemoveLabel Deletes a label

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The label id.
  • @param optional nil or *LabelsApiRemoveLabelOpts - Optional Parameters:
  • @param "Version" (optional.String) - The revision is used to verify the client is working with the latest version of the flow.
  • @param "ClientId" (optional.String) - If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

@return LabelEntity

func (*LabelsApiService) UpdateLabel ¶ 

func (a *LabelsApiService) UpdateLabel(ctx _context.Context, id string, body LabelEntity) (LabelEntity, *_nethttp.Response, error)

UpdateLabel Updates a label

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The label id.
  • @param body The label configuration details.

@return LabelEntity

type LabelsEntity ¶ 

type LabelsEntity struct {
	Labels []LabelEntity `json:"labels,omitempty"`
}

LabelsEntity struct for LabelsEntity

type LineageDto ¶ 

type LineageDto struct {
	// The id of this lineage query.
	Id string `json:"id,omitempty"`
	// The URI for this lineage query for later retrieval and deletion.
	Uri string `json:"uri,omitempty"`
	// When the lineage query was submitted.
	SubmissionTime string `json:"submissionTime,omitempty"`
	// When the lineage query will expire.
	Expiration string `json:"expiration,omitempty"`
	// The percent complete for the lineage query.
	PercentCompleted int32 `json:"percentCompleted,omitempty"`
	// Whether the lineage query has finished.
	Finished bool              `json:"finished,omitempty"`
	Request  LineageRequestDto `json:"request,omitempty"`
	Results  LineageResultsDto `json:"results,omitempty"`
}

LineageDto struct for LineageDto

type LineageEntity ¶ 

type LineageEntity struct {
	Lineage LineageDto `json:"lineage,omitempty"`
}

LineageEntity struct for LineageEntity

type LineageRequestDto ¶ 

type LineageRequestDto struct {
	// The event id that was used to generate this lineage, if applicable. The event id is allowed for any type of lineageRequestType. If the lineageRequestType is FLOWFILE and the flowfile uuid is also included in the request, the event id will be ignored.
	EventId int64 `json:"eventId,omitempty"`
	// The type of lineage request. PARENTS will return the lineage for the flowfiles that are parents of the specified event. CHILDREN will return the lineage for the flowfiles that are children of the specified event. FLOWFILE will return the lineage for the specified flowfile.
	LineageRequestType string `json:"lineageRequestType,omitempty"`
	// The flowfile uuid that was used to generate the lineage. The flowfile uuid is only allowed when the lineageRequestType is FLOWFILE and will take precedence over event id.
	Uuid string `json:"uuid,omitempty"`
	// The id of the node where this lineage originated if clustered.
	ClusterNodeId string `json:"clusterNodeId,omitempty"`
}

LineageRequestDto struct for LineageRequestDto

type LineageResultsDto ¶ 

type LineageResultsDto struct {
	// Any errors that occurred while generating the lineage.
	Errors []string `json:"errors,omitempty"`
	// The nodes in the lineage.
	Nodes []ProvenanceNodeDto `json:"nodes,omitempty"`
	// The links between the nodes in the lineage.
	Links []ProvenanceLinkDto `json:"links,omitempty"`
}

LineageResultsDto struct for LineageResultsDto

type ListingRequestDto ¶ 

type ListingRequestDto struct {
	// The id for this listing request.
	Id string `json:"id,omitempty"`
	// The URI for future requests to this listing request.
	Uri string `json:"uri,omitempty"`
	// The timestamp when the query was submitted.
	SubmissionTime string `json:"submissionTime,omitempty"`
	// The last time this listing request was updated.
	LastUpdated string `json:"lastUpdated,omitempty"`
	// The current percent complete.
	PercentCompleted int32 `json:"percentCompleted,omitempty"`
	// Whether the query has finished.
	Finished bool `json:"finished,omitempty"`
	// The reason, if any, that this listing request failed.
	FailureReason string `json:"failureReason,omitempty"`
	// The maximum number of FlowFileSummary objects to return
	MaxResults int32 `json:"maxResults,omitempty"`
	// The current state of the listing request.
	State     string       `json:"state,omitempty"`
	QueueSize QueueSizeDto `json:"queueSize,omitempty"`
	// The FlowFile summaries. The summaries will be populated once the request has completed.
	FlowFileSummaries []FlowFileSummaryDto `json:"flowFileSummaries,omitempty"`
	// Whether the source of the connection is running
	SourceRunning bool `json:"sourceRunning,omitempty"`
	// Whether the destination of the connection is running
	DestinationRunning bool `json:"destinationRunning,omitempty"`
}

ListingRequestDto struct for ListingRequestDto

type ListingRequestEntity ¶ 

type ListingRequestEntity struct {
	ListingRequest ListingRequestDto `json:"listingRequest,omitempty"`
}

ListingRequestEntity struct for ListingRequestEntity

type NodeConnectionStatisticsSnapshotDto ¶ 

type NodeConnectionStatisticsSnapshotDto struct {
	// The unique ID that identifies the node
	NodeId string `json:"nodeId,omitempty"`
	// The API address of the node
	Address string `json:"address,omitempty"`
	// The API port used to communicate with the node
	ApiPort            int32                           `json:"apiPort,omitempty"`
	StatisticsSnapshot ConnectionStatisticsSnapshotDto `json:"statisticsSnapshot,omitempty"`
}

NodeConnectionStatisticsSnapshotDto struct for NodeConnectionStatisticsSnapshotDto

type NodeConnectionStatusSnapshotDto ¶ 

type NodeConnectionStatusSnapshotDto struct {
	// The unique ID that identifies the node
	NodeId string `json:"nodeId,omitempty"`
	// The API address of the node
	Address string `json:"address,omitempty"`
	// The API port used to communicate with the node
	ApiPort        int32                       `json:"apiPort,omitempty"`
	StatusSnapshot ConnectionStatusSnapshotDto `json:"statusSnapshot,omitempty"`
}

NodeConnectionStatusSnapshotDto struct for NodeConnectionStatusSnapshotDto

type NodeCountersSnapshotDto ¶ 

type NodeCountersSnapshotDto struct {
	// The unique ID that identifies the node
	NodeId string `json:"nodeId,omitempty"`
	// The API address of the node
	Address string `json:"address,omitempty"`
	// The API port used to communicate with the node
	ApiPort  int32               `json:"apiPort,omitempty"`
	Snapshot CountersSnapshotDto `json:"snapshot,omitempty"`
}

NodeCountersSnapshotDto struct for NodeCountersSnapshotDto

type NodeDto ¶ 

type NodeDto struct {
	// The id of the node.
	NodeId string `json:"nodeId,omitempty"`
	// The node's host/ip address.
	Address string `json:"address,omitempty"`
	// The port the node is listening for API requests.
	ApiPort int32 `json:"apiPort,omitempty"`
	// The node's status.
	Status string `json:"status,omitempty"`
	// the time of the nodes's last heartbeat.
	Heartbeat string `json:"heartbeat,omitempty"`
	// The time of the node's last connection request.
	ConnectionRequested string `json:"connectionRequested,omitempty"`
	// The roles of this node.
	Roles []string `json:"roles,omitempty"`
	// The active threads for the NiFi on the node.
	ActiveThreadCount int32 `json:"activeThreadCount,omitempty"`
	// The queue the NiFi on the node.
	Queued string `json:"queued,omitempty"`
	// The node's events.
	Events []NodeEventDto `json:"events,omitempty"`
	// The time at which this Node was last refreshed.
	NodeStartTime string `json:"nodeStartTime,omitempty"`
}

NodeDto struct for NodeDto

type NodeEntity ¶ 

type NodeEntity struct {
	Node NodeDto `json:"node,omitempty"`
}

NodeEntity struct for NodeEntity

type NodeEventDto ¶ 

type NodeEventDto struct {
	// The timestamp of the node event.
	Timestamp string `json:"timestamp,omitempty"`
	// The category of the node event.
	Category string `json:"category,omitempty"`
	// The message in the node event.
	Message string `json:"message,omitempty"`
}

NodeEventDto struct for NodeEventDto

type NodePortStatusSnapshotDto ¶ 

type NodePortStatusSnapshotDto struct {
	// The unique ID that identifies the node
	NodeId string `json:"nodeId,omitempty"`
	// The API address of the node
	Address string `json:"address,omitempty"`
	// The API port used to communicate with the node
	ApiPort        int32                 `json:"apiPort,omitempty"`
	StatusSnapshot PortStatusSnapshotDto `json:"statusSnapshot,omitempty"`
}

NodePortStatusSnapshotDto struct for NodePortStatusSnapshotDto

type NodeProcessGroupStatusSnapshotDto ¶ 

type NodeProcessGroupStatusSnapshotDto struct {
	// The unique ID that identifies the node
	NodeId string `json:"nodeId,omitempty"`
	// The API address of the node
	Address string `json:"address,omitempty"`
	// The API port used to communicate with the node
	ApiPort        int32                         `json:"apiPort,omitempty"`
	StatusSnapshot ProcessGroupStatusSnapshotDto `json:"statusSnapshot,omitempty"`
}

NodeProcessGroupStatusSnapshotDto struct for NodeProcessGroupStatusSnapshotDto

type NodeProcessorStatusSnapshotDto ¶ 

type NodeProcessorStatusSnapshotDto struct {
	// The unique ID that identifies the node
	NodeId string `json:"nodeId,omitempty"`
	// The API address of the node
	Address string `json:"address,omitempty"`
	// The API port used to communicate with the node
	ApiPort        int32                      `json:"apiPort,omitempty"`
	StatusSnapshot ProcessorStatusSnapshotDto `json:"statusSnapshot,omitempty"`
}

NodeProcessorStatusSnapshotDto struct for NodeProcessorStatusSnapshotDto

type NodeRemoteProcessGroupStatusSnapshotDto ¶ 

type NodeRemoteProcessGroupStatusSnapshotDto struct {
	// The unique ID that identifies the node
	NodeId string `json:"nodeId,omitempty"`
	// The API address of the node
	Address string `json:"address,omitempty"`
	// The API port used to communicate with the node
	ApiPort        int32                               `json:"apiPort,omitempty"`
	StatusSnapshot RemoteProcessGroupStatusSnapshotDto `json:"statusSnapshot,omitempty"`
}

NodeRemoteProcessGroupStatusSnapshotDto struct for NodeRemoteProcessGroupStatusSnapshotDto

type NodeSearchResultDto ¶ 

type NodeSearchResultDto struct {
	// The id of the node that matched the search.
	Id string `json:"id,omitempty"`
	// The address of the node that matched the search.
	Address string `json:"address,omitempty"`
}

NodeSearchResultDto struct for NodeSearchResultDto

type NodeStatusSnapshotsDto ¶ 

type NodeStatusSnapshotsDto struct {
	// The id of the node.
	NodeId string `json:"nodeId,omitempty"`
	// The node's host/ip address.
	Address string `json:"address,omitempty"`
	// The port the node is listening for API requests.
	ApiPort int32 `json:"apiPort,omitempty"`
	// A list of StatusSnapshotDTO objects that provide the actual metric values for the component for this node.
	StatusSnapshots []StatusSnapshotDto `json:"statusSnapshots,omitempty"`
}

NodeStatusSnapshotsDto struct for NodeStatusSnapshotsDto

type NodeSystemDiagnosticsSnapshotDto ¶ 

type NodeSystemDiagnosticsSnapshotDto struct {
	// The unique ID that identifies the node
	NodeId string `json:"nodeId,omitempty"`
	// The API address of the node
	Address string `json:"address,omitempty"`
	// The API port used to communicate with the node
	ApiPort  int32                        `json:"apiPort,omitempty"`
	Snapshot SystemDiagnosticsSnapshotDto `json:"snapshot,omitempty"`
}

NodeSystemDiagnosticsSnapshotDto struct for NodeSystemDiagnosticsSnapshotDto

type OutputPortsApiRemoveOutputPortOpts ¶ 

type OutputPortsApiRemoveOutputPortOpts struct {
	Version                      optional.String
	ClientId                     optional.String
	DisconnectedNodeAcknowledged optional.Bool
}

OutputPortsApiRemoveOutputPortOpts Optional parameters for the method 'RemoveOutputPort'

type OutputPortsApiService ¶ 

type OutputPortsApiService service

OutputPortsApiService OutputPortsApi service

func (*OutputPortsApiService) GetOutputPort ¶ 

func (a *OutputPortsApiService) GetOutputPort(ctx _context.Context, id string) (PortEntity, *_nethttp.Response, error)

GetOutputPort Gets an output port

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The output port id.

@return PortEntity

func (*OutputPortsApiService) RemoveOutputPort ¶ 

func (a *OutputPortsApiService) RemoveOutputPort(ctx _context.Context, id string, localVarOptionals *OutputPortsApiRemoveOutputPortOpts) (PortEntity, *_nethttp.Response, error)

RemoveOutputPort Deletes an output port

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The output port id.
  • @param optional nil or *OutputPortsApiRemoveOutputPortOpts - Optional Parameters:
  • @param "Version" (optional.String) - The revision is used to verify the client is working with the latest version of the flow.
  • @param "ClientId" (optional.String) - If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

@return PortEntity

func (*OutputPortsApiService) UpdateOutputPort ¶ 

func (a *OutputPortsApiService) UpdateOutputPort(ctx _context.Context, id string, body PortEntity) (PortEntity, *_nethttp.Response, error)

UpdateOutputPort Updates an output port

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The output port id.
  • @param body The output port configuration details.

@return PortEntity

func (*OutputPortsApiService) UpdateRunStatus ¶ 

func (a *OutputPortsApiService) UpdateRunStatus(ctx _context.Context, id string, body PortRunStatusEntity) (ProcessorEntity, *_nethttp.Response, error)

UpdateRunStatus Updates run status of an output-port

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The port id.
  • @param body The port run status.

@return ProcessorEntity

type OutputPortsEntity ¶ 

type OutputPortsEntity struct {
	OutputPorts []PortEntity `json:"outputPorts,omitempty"`
}

OutputPortsEntity struct for OutputPortsEntity

type ParameterContextDto ¶ 

type ParameterContextDto struct {
	// The Name of the Parameter Context.
	Name string `json:"name,omitempty"`
	// The Description of the Parameter Context.
	Description string `json:"description,omitempty"`
	// The Parameters for the Parameter Context
	Parameters []ParameterEntity `json:"parameters,omitempty"`
	// The Process Groups that are bound to this Parameter Context
	BoundProcessGroups []ProcessGroupEntity `json:"boundProcessGroups,omitempty"`
	// The ID the Parameter Context.
	Id string `json:"id,omitempty"`
}

ParameterContextDto struct for ParameterContextDto

type ParameterContextEntity ¶ 

type ParameterContextEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The URI for futures requests to the component.
	Uri         string         `json:"uri,omitempty"`
	Position    PositionDto    `json:"position,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
	// The bulletins for this component.
	Bulletins []BulletinEntity `json:"bulletins,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool                `json:"disconnectedNodeAcknowledged,omitempty"`
	Component                    ParameterContextDto `json:"component,omitempty"`
}

ParameterContextEntity struct for ParameterContextEntity

type ParameterContextReferenceDto ¶ 

type ParameterContextReferenceDto struct {
	// The ID of the Parameter Context
	Id string `json:"id,omitempty"`
	// The name of the Parameter Context
	Name string `json:"name,omitempty"`
}

ParameterContextReferenceDto struct for ParameterContextReferenceDto

type ParameterContextReferenceEntity ¶ 

type ParameterContextReferenceEntity struct {
	// The id of the component.
	Id          string                       `json:"id,omitempty"`
	Permissions PermissionsDto               `json:"permissions,omitempty"`
	Component   ParameterContextReferenceDto `json:"component,omitempty"`
}

ParameterContextReferenceEntity struct for ParameterContextReferenceEntity

type ParameterContextUpdateRequestDto ¶ 

type ParameterContextUpdateRequestDto struct {
	// The ID of the request
	RequestId string `json:"requestId,omitempty"`
	// The URI for the request
	Uri string `json:"uri,omitempty"`
	// The timestamp of when the request was submitted
	SubmissionTime time.Time `json:"submissionTime,omitempty"`
	// The timestamp of when the request was last updated
	LastUpdated time.Time `json:"lastUpdated,omitempty"`
	// Whether or not the request is completed
	Complete bool `json:"complete,omitempty"`
	// The reason for the request failing, or null if the request has not failed
	FailureReason string `json:"failureReason,omitempty"`
	// A value between 0 and 100 (inclusive) indicating how close the request is to completion
	PercentCompleted int32 `json:"percentCompleted,omitempty"`
	// A description of the current state of the request
	State string `json:"state,omitempty"`
	// The steps that are required in order to complete the request, along with the status of each
	UpdateSteps      []ParameterContextUpdateStepDto `json:"updateSteps,omitempty"`
	ParameterContext ParameterContextDto             `json:"parameterContext,omitempty"`
	// The components that are referenced by the update.
	ReferencingComponents []AffectedComponentEntity `json:"referencingComponents,omitempty"`
}

ParameterContextUpdateRequestDto struct for ParameterContextUpdateRequestDto

type ParameterContextUpdateRequestEntity ¶ 

type ParameterContextUpdateRequestEntity struct {
	ParameterContextRevision RevisionDto                      `json:"parameterContextRevision,omitempty"`
	Request                  ParameterContextUpdateRequestDto `json:"request,omitempty"`
}

ParameterContextUpdateRequestEntity struct for ParameterContextUpdateRequestEntity

type ParameterContextUpdateStepDto ¶ 

type ParameterContextUpdateStepDto struct {
	// Explanation of what happens in this step
	Description string `json:"description,omitempty"`
	// Whether or not this step has completed
	Complete bool `json:"complete,omitempty"`
	// An explanation of why this step failed, or null if this step did not fail
	FailureReason string `json:"failureReason,omitempty"`
}

ParameterContextUpdateStepDto struct for ParameterContextUpdateStepDto

type ParameterContextValidationRequestDto ¶ 

type ParameterContextValidationRequestDto struct {
	// The ID of the request
	RequestId string `json:"requestId,omitempty"`
	// The URI for the request
	Uri string `json:"uri,omitempty"`
	// The timestamp of when the request was submitted
	SubmissionTime time.Time `json:"submissionTime,omitempty"`
	// The timestamp of when the request was last updated
	LastUpdated time.Time `json:"lastUpdated,omitempty"`
	// Whether or not the request is completed
	Complete bool `json:"complete,omitempty"`
	// The reason for the request failing, or null if the request has not failed
	FailureReason string `json:"failureReason,omitempty"`
	// A value between 0 and 100 (inclusive) indicating how close the request is to completion
	PercentCompleted int32 `json:"percentCompleted,omitempty"`
	// A description of the current state of the request
	State string `json:"state,omitempty"`
	// The steps that are required in order to complete the request, along with the status of each
	UpdateSteps                []ParameterContextValidationStepDto `json:"updateSteps,omitempty"`
	ParameterContext           ParameterContextDto                 `json:"parameterContext,omitempty"`
	ComponentValidationResults ComponentValidationResultsEntity    `json:"componentValidationResults,omitempty"`
}

ParameterContextValidationRequestDto struct for ParameterContextValidationRequestDto

type ParameterContextValidationRequestEntity ¶ 

type ParameterContextValidationRequestEntity struct {
	Request ParameterContextValidationRequestDto `json:"request,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool `json:"disconnectedNodeAcknowledged,omitempty"`
}

ParameterContextValidationRequestEntity struct for ParameterContextValidationRequestEntity

type ParameterContextValidationStepDto ¶ 

type ParameterContextValidationStepDto struct {
	// Explanation of what happens in this step
	Description string `json:"description,omitempty"`
	// Whether or not this step has completed
	Complete bool `json:"complete,omitempty"`
	// An explanation of why this step failed, or null if this step did not fail
	FailureReason string `json:"failureReason,omitempty"`
}

ParameterContextValidationStepDto struct for ParameterContextValidationStepDto

type ParameterContextsApiDeleteParameterContextOpts ¶ 

type ParameterContextsApiDeleteParameterContextOpts struct {
	Version                      optional.String
	ClientId                     optional.String
	DisconnectedNodeAcknowledged optional.Bool
}

ParameterContextsApiDeleteParameterContextOpts Optional parameters for the method 'DeleteParameterContext'

type ParameterContextsApiDeleteUpdateRequestOpts ¶ 

type ParameterContextsApiDeleteUpdateRequestOpts struct {
	DisconnectedNodeAcknowledged optional.Bool
}

ParameterContextsApiDeleteUpdateRequestOpts Optional parameters for the method 'DeleteUpdateRequest'

type ParameterContextsApiDeleteValidationRequestOpts ¶ 

type ParameterContextsApiDeleteValidationRequestOpts struct {
	DisconnectedNodeAcknowledged optional.Bool
}

ParameterContextsApiDeleteValidationRequestOpts Optional parameters for the method 'DeleteValidationRequest'

type ParameterContextsApiService ¶ 

type ParameterContextsApiService service

ParameterContextsApiService ParameterContextsApi service

func (*ParameterContextsApiService) CreateParameterContext ¶ 

func (a *ParameterContextsApiService) CreateParameterContext(ctx _context.Context, body ParameterContextEntity) (ParameterContextEntity, *_nethttp.Response, error)

CreateParameterContext Create a Parameter Context

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The Parameter Context.

@return ParameterContextEntity

func (*ParameterContextsApiService) DeleteParameterContext ¶ 

func (a *ParameterContextsApiService) DeleteParameterContext(ctx _context.Context, id string, localVarOptionals *ParameterContextsApiDeleteParameterContextOpts) (ParameterContextEntity, *_nethttp.Response, error)

DeleteParameterContext Deletes the Parameter Context with the given ID Deletes the Parameter Context with the given ID.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The Parameter Context ID.
  • @param optional nil or *ParameterContextsApiDeleteParameterContextOpts - Optional Parameters:
  • @param "Version" (optional.String) - The version is used to verify the client is working with the latest version of the flow.
  • @param "ClientId" (optional.String) - If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

@return ParameterContextEntity

func (*ParameterContextsApiService) DeleteUpdateRequest ¶ 

func (a *ParameterContextsApiService) DeleteUpdateRequest(ctx _context.Context, contextId string, requestId string, localVarOptionals *ParameterContextsApiDeleteUpdateRequestOpts) (ParameterContextUpdateRequestEntity, *_nethttp.Response, error)

DeleteUpdateRequest Deletes the Update Request with the given ID Deletes the Update Request with the given ID. After a request is created via a POST to /nifi-api/parameter-contexts/update-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param contextId The ID of the ParameterContext
  • @param requestId The ID of the Update Request
  • @param optional nil or *ParameterContextsApiDeleteUpdateRequestOpts - Optional Parameters:
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

@return ParameterContextUpdateRequestEntity

func (*ParameterContextsApiService) DeleteValidationRequest ¶ 

func (a *ParameterContextsApiService) DeleteValidationRequest(ctx _context.Context, contextId string, id string, localVarOptionals *ParameterContextsApiDeleteValidationRequestOpts) (ParameterContextValidationRequestEntity, *_nethttp.Response, error)

DeleteValidationRequest Deletes the Validation Request with the given ID Deletes the Validation Request with the given ID. After a request is created via a POST to /nifi-api/validation-contexts, it is expected that the client will properly clean up the request by DELETE'ing it, once the validation process has completed. If the request is deleted before the request completes, then the Validation request will finish the step that it is currently performing and then will cancel any subsequent steps.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param contextId The ID of the Parameter Context
  • @param id The ID of the Update Request
  • @param optional nil or *ParameterContextsApiDeleteValidationRequestOpts - Optional Parameters:
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

@return ParameterContextValidationRequestEntity

func (*ParameterContextsApiService) GetParameterContext ¶ 

func (a *ParameterContextsApiService) GetParameterContext(ctx _context.Context, id string) (ParameterContextEntity, *_nethttp.Response, error)

GetParameterContext Returns the Parameter Context with the given ID Returns the Parameter Context with the given ID.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of the Parameter Context

@return ParameterContextEntity

func (*ParameterContextsApiService) GetParameterContextUpdate ¶ 

func (a *ParameterContextsApiService) GetParameterContextUpdate(ctx _context.Context, contextId string, requestId string) (ParameterContextUpdateRequestEntity, *_nethttp.Response, error)

GetParameterContextUpdate Returns the Update Request with the given ID Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /nifi-api/parameter-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param contextId The ID of the Parameter Context
  • @param requestId The ID of the Update Request

@return ParameterContextUpdateRequestEntity

func (*ParameterContextsApiService) GetValidationRequest ¶ 

func (a *ParameterContextsApiService) GetValidationRequest(ctx _context.Context, contextId string, id string) (ParameterContextValidationRequestEntity, *_nethttp.Response, error)

GetValidationRequest Returns the Validation Request with the given ID Returns the Validation Request with the given ID. Once a Validation Request has been created by performing a POST to /nifi-api/validation-contexts, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param contextId The ID of the Parameter Context
  • @param id The ID of the Validation Request

@return ParameterContextValidationRequestEntity

func (*ParameterContextsApiService) SubmitParameterContextUpdate ¶ 

func (a *ParameterContextsApiService) SubmitParameterContextUpdate(ctx _context.Context, contextId string, body ParameterContextEntity) (ParameterContextUpdateRequestEntity, *_nethttp.Response, error)

SubmitParameterContextUpdate Initiate the Update Request of a Parameter Context This will initiate the process of updating a Parameter Context. Changing the value of a Parameter may require that one or more components be stopped and restarted, so this acttion may take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextUpdateRequestEntity, and the process of updating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/update-requests/{requestId}.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param contextId
  • @param body The updated version of the parameter context.

@return ParameterContextUpdateRequestEntity

func (*ParameterContextsApiService) SubmitValidationRequest ¶ 

func (a *ParameterContextsApiService) SubmitValidationRequest(ctx _context.Context, contextId string, body ParameterContextValidationRequestEntity) (ParameterContextValidationRequestEntity, *_nethttp.Response, error)

SubmitValidationRequest Initiate a Validation Request to determine how the validity of components will change if a Parameter Context were to be updated This will initiate the process of validating all components whose Process Group is bound to the specified Parameter Context. Performing validation against an arbitrary number of components may be expect and take significantly more time than many other REST API actions. As a result, this endpoint will immediately return a ParameterContextValidationRequestEntity, and the process of validating the necessary components will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /parameter-contexts/validation-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /parameter-contexts/validation-requests/{requestId}.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param contextId
  • @param body The validation request

@return ParameterContextValidationRequestEntity

func (*ParameterContextsApiService) UpdateParameterContext ¶ 

func (a *ParameterContextsApiService) UpdateParameterContext(ctx _context.Context, id string, body ParameterContextEntity) (ParameterContextEntity, *_nethttp.Response, error)

UpdateParameterContext Modifies a Parameter Context This endpoint will update a Parameter Context to match the provided entity. However, this request will fail if any component is running and is referencing a Parameter in the Parameter Context. Generally, this endpoint is not called directly. Instead, an update request should be submitted by making a POST to the /parameter-contexts/update-requests endpoint. That endpoint will, in turn, call this endpoint.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id
  • @param body The updated Parameter Context

@return ParameterContextEntity

type ParameterContextsEntity ¶ 

type ParameterContextsEntity struct {
	// The Parameter Contexts
	ParameterContexts []ParameterContextEntity `json:"parameterContexts,omitempty"`
	// The current time on the system.
	CurrentTime string `json:"currentTime,omitempty"`
}

ParameterContextsEntity struct for ParameterContextsEntity

type ParameterDto ¶ 

type ParameterDto struct {
	// The name of the Parameter
	Name string `json:"name,omitempty"`
	// The description of the Parameter
	Description string `json:"description,omitempty"`
	// Whether or not the Parameter is sensitive
	Sensitive bool `json:"sensitive,omitempty"`
	// The value of the Parameter
	Value string `json:"value,omitempty"`
	// The set of all components in the flow that are referencing this Parameter
	ReferencingComponents []AffectedComponentEntity `json:"referencingComponents,omitempty"`
}

ParameterDto struct for ParameterDto

type ParameterEntity ¶ 

type ParameterEntity struct {
	// Indicates whether the user can write a given resource.
	CanWrite  bool         `json:"canWrite,omitempty"`
	Parameter ParameterDto `json:"parameter,omitempty"`
}

ParameterEntity struct for ParameterEntity

type PeerDto ¶ 

type PeerDto struct {
	// The hostname of this peer.
	Hostname string `json:"hostname,omitempty"`
	// The port number of this peer.
	Port int32 `json:"port,omitempty"`
	// Returns if this peer connection is secure.
	Secure bool `json:"secure,omitempty"`
	// The number of flowFiles this peer holds.
	FlowFileCount int32 `json:"flowFileCount,omitempty"`
}

PeerDto struct for PeerDto

type PeersEntity ¶ 

type PeersEntity struct {
	Peers []PeerDto `json:"peers,omitempty"`
}

PeersEntity struct for PeersEntity

type Permissions ¶ 

type Permissions struct {
	// Indicates whether the user can read a given resource.
	CanRead bool `json:"canRead,omitempty"`
	// Indicates whether the user can write a given resource.
	CanWrite bool `json:"canWrite,omitempty"`
	// Indicates whether the user can delete a given resource.
	CanDelete bool `json:"canDelete,omitempty"`
}

Permissions struct for Permissions

type PermissionsDto ¶ 

type PermissionsDto struct {
	// Indicates whether the user can read a given resource.
	CanRead bool `json:"canRead,omitempty"`
	// Indicates whether the user can write a given resource.
	CanWrite bool `json:"canWrite,omitempty"`
}

PermissionsDto struct for PermissionsDto

type PoliciesApiRemoveAccessPolicyOpts ¶ 

type PoliciesApiRemoveAccessPolicyOpts struct {
	Version                      optional.String
	ClientId                     optional.String
	DisconnectedNodeAcknowledged optional.Bool
}

PoliciesApiRemoveAccessPolicyOpts Optional parameters for the method 'RemoveAccessPolicy'

type PoliciesApiService ¶ 

type PoliciesApiService service

PoliciesApiService PoliciesApi service

func (*PoliciesApiService) CreateAccessPolicy ¶ 

func (a *PoliciesApiService) CreateAccessPolicy(ctx _context.Context, body AccessPolicyEntity) (AccessPolicyEntity, *_nethttp.Response, error)

CreateAccessPolicy Creates an access policy

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The access policy configuration details.

@return AccessPolicyEntity

func (*PoliciesApiService) GetAccessPolicy ¶ 

func (a *PoliciesApiService) GetAccessPolicy(ctx _context.Context, id string) (AccessPolicyEntity, *_nethttp.Response, error)

GetAccessPolicy Gets an access policy

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The access policy id.

@return AccessPolicyEntity

func (*PoliciesApiService) GetAccessPolicyForResource ¶ 

func (a *PoliciesApiService) GetAccessPolicyForResource(ctx _context.Context, action string, resource string) (AccessPolicyEntity, *_nethttp.Response, error)

GetAccessPolicyForResource Gets an access policy 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.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param action The request action.
  • @param resource The resource of the policy.

@return AccessPolicyEntity

func (*PoliciesApiService) RemoveAccessPolicy ¶ 

func (a *PoliciesApiService) RemoveAccessPolicy(ctx _context.Context, id string, localVarOptionals *PoliciesApiRemoveAccessPolicyOpts) (AccessPolicyEntity, *_nethttp.Response, error)

RemoveAccessPolicy Deletes an access policy

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The access policy id.
  • @param optional nil or *PoliciesApiRemoveAccessPolicyOpts - Optional Parameters:
  • @param "Version" (optional.String) - The revision is used to verify the client is working with the latest version of the flow.
  • @param "ClientId" (optional.String) - If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

@return AccessPolicyEntity

func (*PoliciesApiService) UpdateAccessPolicy ¶ 

func (a *PoliciesApiService) UpdateAccessPolicy(ctx _context.Context, id string, body AccessPolicyEntity) (AccessPolicyEntity, *_nethttp.Response, error)

UpdateAccessPolicy Updates a access policy

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The access policy id.
  • @param body The access policy configuration details.

@return AccessPolicyEntity

type PortDto ¶ 

type PortDto struct {
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The ID of the corresponding component that is under version control
	VersionedComponentId string `json:"versionedComponentId,omitempty"`
	// The id of parent process group of this component if applicable.
	ParentGroupId string      `json:"parentGroupId,omitempty"`
	Position      PositionDto `json:"position,omitempty"`
	// The name of the port.
	Name string `json:"name,omitempty"`
	// The comments for the port.
	Comments string `json:"comments,omitempty"`
	// The state of the port.
	State string `json:"state,omitempty"`
	// The type of port.
	Type string `json:"type,omitempty"`
	// Whether the port has incoming or output connections to a remote NiFi. This is only applicable when the port is allowed to be accessed remotely.
	Transmitting bool `json:"transmitting,omitempty"`
	// The number of tasks that should be concurrently scheduled for the port.
	ConcurrentlySchedulableTaskCount int32 `json:"concurrentlySchedulableTaskCount,omitempty"`
	// The users that are allowed to access the port.
	UserAccessControl []string `json:"userAccessControl,omitempty"`
	// The user groups that are allowed to access the port.
	GroupAccessControl []string `json:"groupAccessControl,omitempty"`
	// Whether this port can be accessed remotely via Site-to-Site protocol.
	AllowRemoteAccess bool `json:"allowRemoteAccess,omitempty"`
	// Gets the validation errors from this port. These validation errors represent the problems with the port that must be resolved before it can be started.
	ValidationErrors []string `json:"validationErrors,omitempty"`
}

PortDto struct for PortDto

type PortEntity ¶ 

type PortEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The URI for futures requests to the component.
	Uri         string         `json:"uri,omitempty"`
	Position    PositionDto    `json:"position,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
	// The bulletins for this component.
	Bulletins []BulletinEntity `json:"bulletins,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool           `json:"disconnectedNodeAcknowledged,omitempty"`
	Component                    PortDto        `json:"component,omitempty"`
	Status                       PortStatusDto  `json:"status,omitempty"`
	PortType                     string         `json:"portType,omitempty"`
	OperatePermissions           PermissionsDto `json:"operatePermissions,omitempty"`
	// Whether this port can be accessed remotely via Site-to-Site protocol.
	AllowRemoteAccess bool `json:"allowRemoteAccess,omitempty"`
}

PortEntity struct for PortEntity

type PortRunStatusEntity ¶ 

type PortRunStatusEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The run status of the Port.
	State string `json:"state,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool `json:"disconnectedNodeAcknowledged,omitempty"`
}

PortRunStatusEntity struct for PortRunStatusEntity

type PortStatusDto ¶ 

type PortStatusDto struct {
	// The id of the port.
	Id string `json:"id,omitempty"`
	// The id of the parent process group of the port.
	GroupId string `json:"groupId,omitempty"`
	// The name of the port.
	Name string `json:"name,omitempty"`
	// Whether the port has incoming or outgoing connections to a remote NiFi.
	Transmitting bool `json:"transmitting,omitempty"`
	// The run status of the port.
	RunStatus string `json:"runStatus,omitempty"`
	// The time the status for the process group was last refreshed.
	StatsLastRefreshed string                `json:"statsLastRefreshed,omitempty"`
	AggregateSnapshot  PortStatusSnapshotDto `json:"aggregateSnapshot,omitempty"`
	// A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.
	NodeSnapshots []NodePortStatusSnapshotDto `json:"nodeSnapshots,omitempty"`
}

PortStatusDto struct for PortStatusDto

type PortStatusEntity ¶ 

type PortStatusEntity struct {
	PortStatus PortStatusDto `json:"portStatus,omitempty"`
	// Indicates whether the user can read a given resource.
	CanRead bool `json:"canRead,omitempty"`
}

PortStatusEntity struct for PortStatusEntity

type PortStatusSnapshotDto ¶ 

type PortStatusSnapshotDto struct {
	// The id of the port.
	Id string `json:"id,omitempty"`
	// The id of the parent process group of the port.
	GroupId string `json:"groupId,omitempty"`
	// The name of the port.
	Name string `json:"name,omitempty"`
	// The active thread count for the port.
	ActiveThreadCount int32 `json:"activeThreadCount,omitempty"`
	// The number of FlowFiles that have been accepted in the last 5 minutes.
	FlowFilesIn int32 `json:"flowFilesIn,omitempty"`
	// The size of hte FlowFiles that have been accepted in the last 5 minutes.
	BytesIn int64 `json:"bytesIn,omitempty"`
	// The count/size of flowfiles that have been accepted in the last 5 minutes.
	Input string `json:"input,omitempty"`
	// The number of FlowFiles that have been processed in the last 5 minutes.
	FlowFilesOut int32 `json:"flowFilesOut,omitempty"`
	// The number of bytes that have been processed in the last 5 minutes.
	BytesOut int64 `json:"bytesOut,omitempty"`
	// The count/size of flowfiles that have been processed in the last 5 minutes.
	Output string `json:"output,omitempty"`
	// Whether the port has incoming or outgoing connections to a remote NiFi.
	Transmitting bool `json:"transmitting,omitempty"`
	// The run status of the port.
	RunStatus string `json:"runStatus,omitempty"`
}

PortStatusSnapshotDto struct for PortStatusSnapshotDto

type PortStatusSnapshotEntity ¶ 

type PortStatusSnapshotEntity struct {
	// The id of the port.
	Id                 string                `json:"id,omitempty"`
	PortStatusSnapshot PortStatusSnapshotDto `json:"portStatusSnapshot,omitempty"`
	// Indicates whether the user can read a given resource.
	CanRead bool `json:"canRead,omitempty"`
}

PortStatusSnapshotEntity struct for PortStatusSnapshotEntity

type Position ¶ 

type Position struct {
	// The x coordinate.
	X float64 `json:"x,omitempty"`
	// The y coordinate.
	Y float64 `json:"y,omitempty"`
}

Position The position of a component on the graph

type PositionDto ¶ 

type PositionDto struct {
	// The x coordinate.
	X float64 `json:"x,omitempty"`
	// The y coordinate.
	Y float64 `json:"y,omitempty"`
}

PositionDto struct for PositionDto

type PreviousValueDto ¶ 

type PreviousValueDto struct {
	// The previous value.
	PreviousValue string `json:"previousValue,omitempty"`
	// The timestamp when the value was modified.
	Timestamp string `json:"timestamp,omitempty"`
	// The user who changed the previous value.
	UserIdentity string `json:"userIdentity,omitempty"`
}

PreviousValueDto struct for PreviousValueDto

type PrioritizerTypesEntity ¶ 

type PrioritizerTypesEntity struct {
	PrioritizerTypes []DocumentedTypeDto `json:"prioritizerTypes,omitempty"`
}

PrioritizerTypesEntity struct for PrioritizerTypesEntity

type ProcessGroupDto ¶ 

type ProcessGroupDto struct {
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The ID of the corresponding component that is under version control
	VersionedComponentId string `json:"versionedComponentId,omitempty"`
	// The id of parent process group of this component if applicable.
	ParentGroupId string      `json:"parentGroupId,omitempty"`
	Position      PositionDto `json:"position,omitempty"`
	// The name of the process group.
	Name string `json:"name,omitempty"`
	// The comments for the process group.
	Comments string `json:"comments,omitempty"`
	// The variables that are configured for the Process Group. Note that this map contains only those variables that are defined on this Process Group and not any variables that are defined in the parent Process Group, etc. I.e., this Map will not contain all variables that are accessible by components in this Process Group by rather only the variables that are defined for this Process Group itself.
	Variables                 map[string]string               `json:"variables,omitempty"`
	VersionControlInformation VersionControlInformationDto    `json:"versionControlInformation,omitempty"`
	ParameterContext          ParameterContextReferenceEntity `json:"parameterContext,omitempty"`
	// The FlowFile Concurrency for this Process Group.
	FlowfileConcurrency string `json:"flowfileConcurrency,omitempty"`
	// The Oubound Policy that is used for determining how FlowFiles should be transferred out of the Process Group.
	FlowfileOutboundPolicy string `json:"flowfileOutboundPolicy,omitempty"`
	// The number of running components in this process group.
	RunningCount int32 `json:"runningCount,omitempty"`
	// The number of stopped components in the process group.
	StoppedCount int32 `json:"stoppedCount,omitempty"`
	// The number of invalid components in the process group.
	InvalidCount int32 `json:"invalidCount,omitempty"`
	// The number of disabled components in the process group.
	DisabledCount int32 `json:"disabledCount,omitempty"`
	// The number of active remote ports in the process group.
	ActiveRemotePortCount int32 `json:"activeRemotePortCount,omitempty"`
	// The number of inactive remote ports in the process group.
	InactiveRemotePortCount int32 `json:"inactiveRemotePortCount,omitempty"`
	// The number of up to date versioned process groups in the process group.
	UpToDateCount int32 `json:"upToDateCount,omitempty"`
	// The number of locally modified versioned process groups in the process group.
	LocallyModifiedCount int32 `json:"locallyModifiedCount,omitempty"`
	// The number of stale versioned process groups in the process group.
	StaleCount int32 `json:"staleCount,omitempty"`
	// The number of locally modified and stale versioned process groups in the process group.
	LocallyModifiedAndStaleCount int32 `json:"locallyModifiedAndStaleCount,omitempty"`
	// The number of versioned process groups in the process group that are unable to sync to a registry.
	SyncFailureCount int32 `json:"syncFailureCount,omitempty"`
	// The number of local input ports in the process group.
	LocalInputPortCount int32 `json:"localInputPortCount,omitempty"`
	// The number of local output ports in the process group.
	LocalOutputPortCount int32 `json:"localOutputPortCount,omitempty"`
	// The number of public input ports in the process group.
	PublicInputPortCount int32 `json:"publicInputPortCount,omitempty"`
	// The number of public output ports in the process group.
	PublicOutputPortCount int32          `json:"publicOutputPortCount,omitempty"`
	Contents              FlowSnippetDto `json:"contents,omitempty"`
	// The number of input ports in the process group.
	InputPortCount int32 `json:"inputPortCount,omitempty"`
	// The number of output ports in the process group.
	OutputPortCount int32 `json:"outputPortCount,omitempty"`
}

ProcessGroupDto struct for ProcessGroupDto

type ProcessGroupEntity ¶ 

type ProcessGroupEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The URI for futures requests to the component.
	Uri         string         `json:"uri,omitempty"`
	Position    PositionDto    `json:"position,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
	// The bulletins for this component.
	Bulletins []BulletinEntity `json:"bulletins,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool                  `json:"disconnectedNodeAcknowledged,omitempty"`
	Component                    ProcessGroupDto       `json:"component,omitempty"`
	Status                       ProcessGroupStatusDto `json:"status,omitempty"`
	VersionedFlowSnapshot        VersionedFlowSnapshot `json:"versionedFlowSnapshot,omitempty"`
	// The number of running components in this process group.
	RunningCount int32 `json:"runningCount,omitempty"`
	// The number of stopped components in the process group.
	StoppedCount int32 `json:"stoppedCount,omitempty"`
	// The number of invalid components in the process group.
	InvalidCount int32 `json:"invalidCount,omitempty"`
	// The number of disabled components in the process group.
	DisabledCount int32 `json:"disabledCount,omitempty"`
	// The number of active remote ports in the process group.
	ActiveRemotePortCount int32 `json:"activeRemotePortCount,omitempty"`
	// The number of inactive remote ports in the process group.
	InactiveRemotePortCount int32 `json:"inactiveRemotePortCount,omitempty"`
	// The current state of the Process Group, as it relates to the Versioned Flow
	VersionedFlowState string `json:"versionedFlowState,omitempty"`
	// The number of up to date versioned process groups in the process group.
	UpToDateCount int32 `json:"upToDateCount,omitempty"`
	// The number of locally modified versioned process groups in the process group.
	LocallyModifiedCount int32 `json:"locallyModifiedCount,omitempty"`
	// The number of stale versioned process groups in the process group.
	StaleCount int32 `json:"staleCount,omitempty"`
	// The number of locally modified and stale versioned process groups in the process group.
	LocallyModifiedAndStaleCount int32 `json:"locallyModifiedAndStaleCount,omitempty"`
	// The number of versioned process groups in the process group that are unable to sync to a registry.
	SyncFailureCount int32 `json:"syncFailureCount,omitempty"`
	// The number of local input ports in the process group.
	LocalInputPortCount int32 `json:"localInputPortCount,omitempty"`
	// The number of local output ports in the process group.
	LocalOutputPortCount int32 `json:"localOutputPortCount,omitempty"`
	// The number of public input ports in the process group.
	PublicInputPortCount int32 `json:"publicInputPortCount,omitempty"`
	// The number of public output ports in the process group.
	PublicOutputPortCount int32                           `json:"publicOutputPortCount,omitempty"`
	ParameterContext      ParameterContextReferenceEntity `json:"parameterContext,omitempty"`
	// The number of input ports in the process group.
	InputPortCount int32 `json:"inputPortCount,omitempty"`
	// The number of output ports in the process group.
	OutputPortCount int32 `json:"outputPortCount,omitempty"`
}

ProcessGroupEntity struct for ProcessGroupEntity

type ProcessGroupFlowDto ¶ 

type ProcessGroupFlowDto struct {
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The URI for futures requests to the component.
	Uri string `json:"uri,omitempty"`
	// The id of parent process group of this component if applicable.
	ParentGroupId    string                          `json:"parentGroupId,omitempty"`
	ParameterContext ParameterContextReferenceEntity `json:"parameterContext,omitempty"`
	Breadcrumb       FlowBreadcrumbEntity            `json:"breadcrumb,omitempty"`
	Flow             FlowDto                         `json:"flow,omitempty"`
	// The time the flow for the process group was last refreshed.
	LastRefreshed string `json:"lastRefreshed,omitempty"`
}

ProcessGroupFlowDto struct for ProcessGroupFlowDto

type ProcessGroupFlowEntity ¶ 

type ProcessGroupFlowEntity struct {
	Permissions      PermissionsDto      `json:"permissions,omitempty"`
	ProcessGroupFlow ProcessGroupFlowDto `json:"processGroupFlow,omitempty"`
}

ProcessGroupFlowEntity struct for ProcessGroupFlowEntity

type ProcessGroupImportEntity ¶ 

type ProcessGroupImportEntity struct {
	ProcessGroupRevision RevisionDto `json:"processGroupRevision,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool                  `json:"disconnectedNodeAcknowledged,omitempty"`
	VersionedFlowSnapshot        VersionedFlowSnapshot `json:"versionedFlowSnapshot,omitempty"`
}

ProcessGroupImportEntity struct for ProcessGroupImportEntity

type ProcessGroupNameDto ¶ 

type ProcessGroupNameDto struct {
	// The ID of the Process Group
	Id string `json:"id,omitempty"`
	// The name of the Process Group, or the ID of the Process Group if the user does not have the READ policy for the Process Group
	Name string `json:"name,omitempty"`
}

ProcessGroupNameDto struct for ProcessGroupNameDto

type ProcessGroupReplaceRequestDto ¶ 

type ProcessGroupReplaceRequestDto struct {
	// The unique ID of this request.
	RequestId string `json:"requestId,omitempty"`
	// The unique ID of the Process Group being updated
	ProcessGroupId string `json:"processGroupId,omitempty"`
	// The URI for future requests to this drop request.
	Uri string `json:"uri,omitempty"`
	// The last time this request was updated.
	LastUpdated string `json:"lastUpdated,omitempty"`
	// Whether or not this request has completed
	Complete bool `json:"complete,omitempty"`
	// An explanation of why this request failed, or null if this request has not failed
	FailureReason string `json:"failureReason,omitempty"`
	// The percentage complete for the request, between 0 and 100
	PercentCompleted int32 `json:"percentCompleted,omitempty"`
	// The state of the request
	State string `json:"state,omitempty"`
}

ProcessGroupReplaceRequestDto struct for ProcessGroupReplaceRequestDto

type ProcessGroupReplaceRequestEntity ¶ 

type ProcessGroupReplaceRequestEntity struct {
	ProcessGroupRevision  RevisionDto                   `json:"processGroupRevision,omitempty"`
	Request               ProcessGroupReplaceRequestDto `json:"request,omitempty"`
	VersionedFlowSnapshot VersionedFlowSnapshot         `json:"versionedFlowSnapshot,omitempty"`
}

ProcessGroupReplaceRequestEntity struct for ProcessGroupReplaceRequestEntity

type ProcessGroupStatusDto ¶ 

type ProcessGroupStatusDto struct {
	// The ID of the Process Group
	Id string `json:"id,omitempty"`
	// The name of the Process Group
	Name string `json:"name,omitempty"`
	// The time the status for the process group was last refreshed.
	StatsLastRefreshed string                        `json:"statsLastRefreshed,omitempty"`
	AggregateSnapshot  ProcessGroupStatusSnapshotDto `json:"aggregateSnapshot,omitempty"`
	// The status reported by each node in the cluster. If the NiFi instance is a standalone instance, rather than a clustered instance, this value may be null.
	NodeSnapshots []NodeProcessGroupStatusSnapshotDto `json:"nodeSnapshots,omitempty"`
}

ProcessGroupStatusDto struct for ProcessGroupStatusDto

type ProcessGroupStatusEntity ¶ 

type ProcessGroupStatusEntity struct {
	ProcessGroupStatus ProcessGroupStatusDto `json:"processGroupStatus,omitempty"`
	// Indicates whether the user can read a given resource.
	CanRead bool `json:"canRead,omitempty"`
}

ProcessGroupStatusEntity struct for ProcessGroupStatusEntity

type ProcessGroupStatusSnapshotDto ¶ 

type ProcessGroupStatusSnapshotDto struct {
	// The id of the process group.
	Id string `json:"id,omitempty"`
	// The name of this process group.
	Name string `json:"name,omitempty"`
	// The status of all connections in the process group.
	ConnectionStatusSnapshots []ConnectionStatusSnapshotEntity `json:"connectionStatusSnapshots,omitempty"`
	// The status of all processors in the process group.
	ProcessorStatusSnapshots []ProcessorStatusSnapshotEntity `json:"processorStatusSnapshots,omitempty"`
	// The status of all process groups in the process group.
	ProcessGroupStatusSnapshots []ProcessGroupStatusSnapshotEntity `json:"processGroupStatusSnapshots,omitempty"`
	// The status of all remote process groups in the process group.
	RemoteProcessGroupStatusSnapshots []RemoteProcessGroupStatusSnapshotEntity `json:"remoteProcessGroupStatusSnapshots,omitempty"`
	// The status of all input ports in the process group.
	InputPortStatusSnapshots []PortStatusSnapshotEntity `json:"inputPortStatusSnapshots,omitempty"`
	// The status of all output ports in the process group.
	OutputPortStatusSnapshots []PortStatusSnapshotEntity `json:"outputPortStatusSnapshots,omitempty"`
	// The current state of the Process Group, as it relates to the Versioned Flow
	VersionedFlowState string `json:"versionedFlowState,omitempty"`
	// The number of FlowFiles that have come into this ProcessGroup in the last 5 minutes
	FlowFilesIn int32 `json:"flowFilesIn,omitempty"`
	// The number of bytes that have come into this ProcessGroup in the last 5 minutes
	BytesIn int64 `json:"bytesIn,omitempty"`
	// The input count/size for the process group in the last 5 minutes (pretty printed).
	Input string `json:"input,omitempty"`
	// The number of FlowFiles that are queued up in this ProcessGroup right now
	FlowFilesQueued int32 `json:"flowFilesQueued,omitempty"`
	// The number of bytes that are queued up in this ProcessGroup right now
	BytesQueued int64 `json:"bytesQueued,omitempty"`
	// The count/size that is queued in the the process group.
	Queued string `json:"queued,omitempty"`
	// The count that is queued for the process group.
	QueuedCount string `json:"queuedCount,omitempty"`
	// The size that is queued for the process group.
	QueuedSize string `json:"queuedSize,omitempty"`
	// The number of bytes read by components in this ProcessGroup in the last 5 minutes
	BytesRead int64 `json:"bytesRead,omitempty"`
	// The number of bytes read in the last 5 minutes.
	Read string `json:"read,omitempty"`
	// The number of bytes written by components in this ProcessGroup in the last 5 minutes
	BytesWritten int64 `json:"bytesWritten,omitempty"`
	// The number of bytes written in the last 5 minutes.
	Written string `json:"written,omitempty"`
	// The number of FlowFiles transferred out of this ProcessGroup in the last 5 minutes
	FlowFilesOut int32 `json:"flowFilesOut,omitempty"`
	// The number of bytes transferred out of this ProcessGroup in the last 5 minutes
	BytesOut int64 `json:"bytesOut,omitempty"`
	// The output count/size for the process group in the last 5 minutes.
	Output string `json:"output,omitempty"`
	// The number of FlowFiles transferred in this ProcessGroup in the last 5 minutes
	FlowFilesTransferred int32 `json:"flowFilesTransferred,omitempty"`
	// The number of bytes transferred in this ProcessGroup in the last 5 minutes
	BytesTransferred int64 `json:"bytesTransferred,omitempty"`
	// The count/size transferred to/from queues in the process group in the last 5 minutes.
	Transferred string `json:"transferred,omitempty"`
	// The number of bytes received from external sources by components within this ProcessGroup in the last 5 minutes
	BytesReceived int64 `json:"bytesReceived,omitempty"`
	// The number of FlowFiles received from external sources by components within this ProcessGroup in the last 5 minutes
	FlowFilesReceived int32 `json:"flowFilesReceived,omitempty"`
	// The count/size sent to the process group in the last 5 minutes.
	Received string `json:"received,omitempty"`
	// The number of bytes sent to an external sink by components within this ProcessGroup in the last 5 minutes
	BytesSent int64 `json:"bytesSent,omitempty"`
	// The number of FlowFiles sent to an external sink by components within this ProcessGroup in the last 5 minutes
	FlowFilesSent int32 `json:"flowFilesSent,omitempty"`
	// The count/size sent from this process group in the last 5 minutes.
	Sent string `json:"sent,omitempty"`
	// The active thread count for this process group.
	ActiveThreadCount int32 `json:"activeThreadCount,omitempty"`
	// The number of threads currently terminated for the process group.
	TerminatedThreadCount int32 `json:"terminatedThreadCount,omitempty"`
}

ProcessGroupStatusSnapshotDto struct for ProcessGroupStatusSnapshotDto

type ProcessGroupStatusSnapshotEntity ¶ 

type ProcessGroupStatusSnapshotEntity struct {
	// The id of the process group.
	Id                         string                        `json:"id,omitempty"`
	ProcessGroupStatusSnapshot ProcessGroupStatusSnapshotDto `json:"processGroupStatusSnapshot,omitempty"`
	// Indicates whether the user can read a given resource.
	CanRead bool `json:"canRead,omitempty"`
}

ProcessGroupStatusSnapshotEntity struct for ProcessGroupStatusSnapshotEntity

type ProcessGroupsApiDeleteReplaceProcessGroupRequestOpts ¶ 

type ProcessGroupsApiDeleteReplaceProcessGroupRequestOpts struct {
	DisconnectedNodeAcknowledged optional.Bool
}

ProcessGroupsApiDeleteReplaceProcessGroupRequestOpts Optional parameters for the method 'DeleteReplaceProcessGroupRequest'

type ProcessGroupsApiDeleteVariableRegistryUpdateRequestOpts ¶ 

type ProcessGroupsApiDeleteVariableRegistryUpdateRequestOpts struct {
	DisconnectedNodeAcknowledged optional.Bool
}

ProcessGroupsApiDeleteVariableRegistryUpdateRequestOpts Optional parameters for the method 'DeleteVariableRegistryUpdateRequest'

type ProcessGroupsApiGetProcessorsOpts ¶ 

type ProcessGroupsApiGetProcessorsOpts struct {
	IncludeDescendantGroups optional.Bool
}

ProcessGroupsApiGetProcessorsOpts Optional parameters for the method 'GetProcessors'

type ProcessGroupsApiGetVariableRegistryOpts ¶ 

type ProcessGroupsApiGetVariableRegistryOpts struct {
	IncludeAncestorGroups optional.Bool
}

ProcessGroupsApiGetVariableRegistryOpts Optional parameters for the method 'GetVariableRegistry'

type ProcessGroupsApiRemoveProcessGroupOpts ¶ 

type ProcessGroupsApiRemoveProcessGroupOpts struct {
	Version                      optional.String
	ClientId                     optional.String
	DisconnectedNodeAcknowledged optional.Bool
}

ProcessGroupsApiRemoveProcessGroupOpts Optional parameters for the method 'RemoveProcessGroup'

type ProcessGroupsApiService ¶ 

type ProcessGroupsApiService service

ProcessGroupsApiService ProcessGroupsApi service

func (*ProcessGroupsApiService) CopySnippet ¶ 

func (a *ProcessGroupsApiService) CopySnippet(ctx _context.Context, id string, body CopySnippetRequestEntity) (FlowEntity, *_nethttp.Response, error)

CopySnippet Copies a snippet and discards it.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param body The copy snippet request.

@return FlowEntity

func (*ProcessGroupsApiService) CreateConnection ¶ 

func (a *ProcessGroupsApiService) CreateConnection(ctx _context.Context, id string, body ConnectionEntity) (ConnectionEntity, *_nethttp.Response, error)

CreateConnection Creates a connection

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param body The connection configuration details.

@return ConnectionEntity

func (*ProcessGroupsApiService) CreateControllerService ¶ 

func (a *ProcessGroupsApiService) CreateControllerService(ctx _context.Context, id string, body ControllerServiceEntity) (ControllerServiceEntity, *_nethttp.Response, error)

CreateControllerService Creates a new controller service

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param body The controller service configuration details.

@return ControllerServiceEntity

func (*ProcessGroupsApiService) CreateFunnel ¶ 

func (a *ProcessGroupsApiService) CreateFunnel(ctx _context.Context, id string, body FunnelEntity) (FunnelEntity, *_nethttp.Response, error)

CreateFunnel Creates a funnel

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param body The funnel configuration details.

@return FunnelEntity

func (*ProcessGroupsApiService) CreateInputPort ¶ 

func (a *ProcessGroupsApiService) CreateInputPort(ctx _context.Context, id string, body PortEntity) (PortEntity, *_nethttp.Response, error)

CreateInputPort Creates an input port

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param body The input port configuration details.

@return PortEntity

func (*ProcessGroupsApiService) CreateLabel ¶ 

func (a *ProcessGroupsApiService) CreateLabel(ctx _context.Context, id string, body LabelEntity) (LabelEntity, *_nethttp.Response, error)

CreateLabel Creates a label

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param body The label configuration details.

@return LabelEntity

func (*ProcessGroupsApiService) CreateOutputPort ¶ 

func (a *ProcessGroupsApiService) CreateOutputPort(ctx _context.Context, id string, body PortEntity) (PortEntity, *_nethttp.Response, error)

CreateOutputPort Creates an output port

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param body The output port configuration.

@return PortEntity

func (*ProcessGroupsApiService) CreateProcessGroup ¶ 

func (a *ProcessGroupsApiService) CreateProcessGroup(ctx _context.Context, id string, body ProcessGroupEntity) (ProcessGroupEntity, *_nethttp.Response, error)

CreateProcessGroup Creates a process group

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param body The process group configuration details.

@return ProcessGroupEntity

func (*ProcessGroupsApiService) CreateProcessor ¶ 

func (a *ProcessGroupsApiService) CreateProcessor(ctx _context.Context, id string, body ProcessorEntity) (ProcessorEntity, *_nethttp.Response, error)

CreateProcessor Creates a new processor

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param body The processor configuration details.

@return ProcessorEntity

func (*ProcessGroupsApiService) CreateRemoteProcessGroup ¶ 

func (a *ProcessGroupsApiService) CreateRemoteProcessGroup(ctx _context.Context, id string, body RemoteProcessGroupEntity) (RemoteProcessGroupEntity, *_nethttp.Response, error)

CreateRemoteProcessGroup Creates a new process group

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param body The remote process group configuration details.

@return RemoteProcessGroupEntity

func (*ProcessGroupsApiService) CreateTemplate ¶ 

func (a *ProcessGroupsApiService) CreateTemplate(ctx _context.Context, id string, body CreateTemplateRequestEntity) (TemplateEntity, *_nethttp.Response, error)

CreateTemplate Creates a template and discards the specified snippet.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param body The create template request.

@return TemplateEntity

func (*ProcessGroupsApiService) DeleteReplaceProcessGroupRequest ¶ 

func (a *ProcessGroupsApiService) DeleteReplaceProcessGroupRequest(ctx _context.Context, id string, localVarOptionals *ProcessGroupsApiDeleteReplaceProcessGroupRequestOpts) (ProcessGroupReplaceRequestEntity, *_nethttp.Response, error)

DeleteReplaceProcessGroupRequest Deletes the Replace Request with the given ID Deletes the Replace Request with the given ID. After a request is created via a POST to /process-groups/{id}/replace-requests, it is expected that the client will properly clean up the request by DELETE'ing it, once the Replace process has completed. If the request is deleted before the request completes, then the Replace request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of the Update Request
  • @param optional nil or *ProcessGroupsApiDeleteReplaceProcessGroupRequestOpts - Optional Parameters:
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

@return ProcessGroupReplaceRequestEntity

func (*ProcessGroupsApiService) DeleteVariableRegistryUpdateRequest ¶ 

func (a *ProcessGroupsApiService) DeleteVariableRegistryUpdateRequest(ctx _context.Context, groupId string, updateId string, localVarOptionals *ProcessGroupsApiDeleteVariableRegistryUpdateRequestOpts) (VariableRegistryUpdateRequestEntity, *_nethttp.Response, error)

DeleteVariableRegistryUpdateRequest Deletes an update request for a process group's variable registry. If the request is not yet complete, it will automatically be cancelled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param groupId The process group id.
  • @param updateId The ID of the Variable Registry Update Request
  • @param optional nil or *ProcessGroupsApiDeleteVariableRegistryUpdateRequestOpts - Optional Parameters:
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

@return VariableRegistryUpdateRequestEntity

func (*ProcessGroupsApiService) ExportProcessGroup ¶ 

func (a *ProcessGroupsApiService) ExportProcessGroup(ctx _context.Context, id string) (string, *_nethttp.Response, error)

ExportProcessGroup Gets a process group for download

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.

@return string

func (*ProcessGroupsApiService) GetConnections ¶ 

func (a *ProcessGroupsApiService) GetConnections(ctx _context.Context, id string) (ConnectionsEntity, *_nethttp.Response, error)

GetConnections Gets all connections

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.

@return ConnectionsEntity

func (*ProcessGroupsApiService) GetFunnels ¶ 

func (a *ProcessGroupsApiService) GetFunnels(ctx _context.Context, id string) (FunnelsEntity, *_nethttp.Response, error)

GetFunnels Gets all funnels

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.

@return FunnelsEntity

func (*ProcessGroupsApiService) GetInputPorts ¶ 

func (a *ProcessGroupsApiService) GetInputPorts(ctx _context.Context, id string) (InputPortsEntity, *_nethttp.Response, error)

GetInputPorts Gets all input ports

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.

@return InputPortsEntity

func (*ProcessGroupsApiService) GetLabels ¶ 

func (a *ProcessGroupsApiService) GetLabels(ctx _context.Context, id string) (LabelsEntity, *_nethttp.Response, error)

GetLabels Gets all labels

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.

@return LabelsEntity

func (*ProcessGroupsApiService) GetLocalModifications ¶ 

func (a *ProcessGroupsApiService) GetLocalModifications(ctx _context.Context, id string) (FlowComparisonEntity, *_nethttp.Response, error)

GetLocalModifications Gets a list of local modifications to the Process Group since it was last synchronized with the Flow Registry

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.

@return FlowComparisonEntity

func (*ProcessGroupsApiService) GetOutputPorts ¶ 

func (a *ProcessGroupsApiService) GetOutputPorts(ctx _context.Context, id string) (OutputPortsEntity, *_nethttp.Response, error)

GetOutputPorts Gets all output ports

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.

@return OutputPortsEntity

func (*ProcessGroupsApiService) GetProcessGroup ¶ 

func (a *ProcessGroupsApiService) GetProcessGroup(ctx _context.Context, id string) (ProcessGroupEntity, *_nethttp.Response, error)

GetProcessGroup Gets a process group

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.

@return ProcessGroupEntity

func (*ProcessGroupsApiService) GetProcessGroups ¶ 

func (a *ProcessGroupsApiService) GetProcessGroups(ctx _context.Context, id string) (ProcessGroupsEntity, *_nethttp.Response, error)

GetProcessGroups Gets all process groups

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.

@return ProcessGroupsEntity

func (*ProcessGroupsApiService) GetProcessors ¶ 

func (a *ProcessGroupsApiService) GetProcessors(ctx _context.Context, id string, localVarOptionals *ProcessGroupsApiGetProcessorsOpts) (ProcessorsEntity, *_nethttp.Response, error)

GetProcessors Gets all processors

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param optional nil or *ProcessGroupsApiGetProcessorsOpts - Optional Parameters:
  • @param "IncludeDescendantGroups" (optional.Bool) - Whether or not to include processors from descendant process groups

@return ProcessorsEntity

func (*ProcessGroupsApiService) GetRemoteProcessGroups ¶ 

func (a *ProcessGroupsApiService) GetRemoteProcessGroups(ctx _context.Context, id string) (RemoteProcessGroupsEntity, *_nethttp.Response, error)

GetRemoteProcessGroups Gets all remote process groups

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.

@return RemoteProcessGroupsEntity

func (*ProcessGroupsApiService) GetReplaceProcessGroupRequest ¶ 

func (a *ProcessGroupsApiService) GetReplaceProcessGroupRequest(ctx _context.Context, id string) (ProcessGroupReplaceRequestEntity, *_nethttp.Response, error)

GetReplaceProcessGroupRequest Returns the Replace Request with the given ID Returns the Replace Request with the given ID. Once a Replace Request has been created by performing a POST to /process-groups/{id}/replace-requests, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of the Replace Request

@return ProcessGroupReplaceRequestEntity

func (*ProcessGroupsApiService) GetVariableRegistry ¶ 

func (a *ProcessGroupsApiService) GetVariableRegistry(ctx _context.Context, id string, localVarOptionals *ProcessGroupsApiGetVariableRegistryOpts) (VariableRegistryEntity, *_nethttp.Response, error)

GetVariableRegistry Gets a process group's variable registry Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param optional nil or *ProcessGroupsApiGetVariableRegistryOpts - Optional Parameters:
  • @param "IncludeAncestorGroups" (optional.Bool) - Whether or not to include ancestor groups

@return VariableRegistryEntity

func (*ProcessGroupsApiService) GetVariableRegistryUpdateRequest ¶ 

func (a *ProcessGroupsApiService) GetVariableRegistryUpdateRequest(ctx _context.Context, groupId string, updateId string) (VariableRegistryUpdateRequestEntity, *_nethttp.Response, error)

GetVariableRegistryUpdateRequest Gets a process group's variable registry Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param groupId The process group id.
  • @param updateId The ID of the Variable Registry Update Request

@return VariableRegistryUpdateRequestEntity

func (*ProcessGroupsApiService) ImportTemplate ¶ 

func (a *ProcessGroupsApiService) ImportTemplate(ctx _context.Context, id string) (TemplateEntity, *_nethttp.Response, error)

ImportTemplate Imports a template

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.

@return TemplateEntity

func (*ProcessGroupsApiService) InitiateReplaceProcessGroup ¶ 

func (a *ProcessGroupsApiService) InitiateReplaceProcessGroup(ctx _context.Context, id string, body ProcessGroupImportEntity) (ProcessGroupReplaceRequestEntity, *_nethttp.Response, error)

InitiateReplaceProcessGroup Initiate the Replace Request of a Process Group with the given ID This will initiate the action of replacing a process group with the given process group. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a ProcessGroupReplaceRequestEntity, and the process of replacing the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /process-groups/replace-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /process-groups/replace-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param body The process group replace request entity

@return ProcessGroupReplaceRequestEntity

func (*ProcessGroupsApiService) InstantiateTemplate ¶ 

func (a *ProcessGroupsApiService) InstantiateTemplate(ctx _context.Context, id string, body InstantiateTemplateRequestEntity) (FlowEntity, *_nethttp.Response, error)

InstantiateTemplate Instantiates a template

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param body The instantiate template request.

@return FlowEntity

func (*ProcessGroupsApiService) RemoveProcessGroup ¶ 

func (a *ProcessGroupsApiService) RemoveProcessGroup(ctx _context.Context, id string, localVarOptionals *ProcessGroupsApiRemoveProcessGroupOpts) (ProcessGroupEntity, *_nethttp.Response, error)

RemoveProcessGroup Deletes a process group

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param optional nil or *ProcessGroupsApiRemoveProcessGroupOpts - Optional Parameters:
  • @param "Version" (optional.String) - The revision is used to verify the client is working with the latest version of the flow.
  • @param "ClientId" (optional.String) - If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

@return ProcessGroupEntity

func (*ProcessGroupsApiService) ReplaceProcessGroup ¶ 

func (a *ProcessGroupsApiService) ReplaceProcessGroup(ctx _context.Context, id string, body ProcessGroupImportEntity) (ProcessGroupImportEntity, *_nethttp.Response, error)

ReplaceProcessGroup Replace Process Group contents with the given ID with the specified Process Group contents This endpoint is used for replication within a cluster, when replacing a flow with a new flow. It expects that the flow beingreplaced is not under version control and that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param body The process group replace request entity.

@return ProcessGroupImportEntity

func (*ProcessGroupsApiService) SubmitUpdateVariableRegistryRequest ¶ 

func (a *ProcessGroupsApiService) SubmitUpdateVariableRegistryRequest(ctx _context.Context, id string, body VariableRegistryEntity) (VariableRegistryUpdateRequestEntity, *_nethttp.Response, error)

SubmitUpdateVariableRegistryRequest Submits a request to update a process group's variable registry Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param body The variable registry configuration details.

@return VariableRegistryUpdateRequestEntity

func (*ProcessGroupsApiService) UpdateProcessGroup ¶ 

func (a *ProcessGroupsApiService) UpdateProcessGroup(ctx _context.Context, id string, body ProcessGroupEntity) (ProcessGroupEntity, *_nethttp.Response, error)

UpdateProcessGroup Updates a process group

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param body The process group configuration details.

@return ProcessGroupEntity

func (*ProcessGroupsApiService) UpdateVariableRegistry ¶ 

func (a *ProcessGroupsApiService) UpdateVariableRegistry(ctx _context.Context, id string, body VariableRegistryEntity) (VariableRegistryEntity, *_nethttp.Response, error)

UpdateVariableRegistry Updates the contents of a Process Group's variable Registry Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param body The variable registry configuration details.

@return VariableRegistryEntity

func (*ProcessGroupsApiService) UploadTemplate ¶ 

func (a *ProcessGroupsApiService) UploadTemplate(ctx _context.Context, id string, template *os.File) (TemplateEntity, *_nethttp.Response, error)

UploadTemplate Uploads a template

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param template The binary content of the template file being uploaded.

@return TemplateEntity

type ProcessGroupsEntity ¶ 

type ProcessGroupsEntity struct {
	ProcessGroups []ProcessGroupEntity `json:"processGroups,omitempty"`
}

ProcessGroupsEntity struct for ProcessGroupsEntity

type ProcessorConfigDto ¶ 

type ProcessorConfigDto struct {
	// The properties for the processor. Properties whose value is not set will only contain the property name.
	Properties map[string]string `json:"properties,omitempty"`
	// Descriptors for the processor's properties.
	Descriptors map[string]PropertyDescriptorDto `json:"descriptors,omitempty"`
	// The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy.
	SchedulingPeriod string `json:"schedulingPeriod,omitempty"`
	// Indcates whether the prcessor should be scheduled to run in event or timer driven mode.
	SchedulingStrategy string `json:"schedulingStrategy,omitempty"`
	// Indicates the node where the process will execute.
	ExecutionNode string `json:"executionNode,omitempty"`
	// The amount of time that is used when the process penalizes a flowfile.
	PenaltyDuration string `json:"penaltyDuration,omitempty"`
	// The amount of time that must elapse before this processor is scheduled again after yielding.
	YieldDuration string `json:"yieldDuration,omitempty"`
	// The level at which the processor will report bulletins.
	BulletinLevel string `json:"bulletinLevel,omitempty"`
	// The run duration for the processor in milliseconds.
	RunDurationMillis int64 `json:"runDurationMillis,omitempty"`
	// The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored.
	ConcurrentlySchedulableTaskCount int32 `json:"concurrentlySchedulableTaskCount,omitempty"`
	// The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.
	AutoTerminatedRelationships []string `json:"autoTerminatedRelationships,omitempty"`
	// The comments for the processor.
	Comments string `json:"comments,omitempty"`
	// The URL for the processor's custom configuration UI if applicable.
	CustomUiUrl string `json:"customUiUrl,omitempty"`
	// Whether the processor is loss tolerant.
	LossTolerant bool `json:"lossTolerant,omitempty"`
	// The annotation data for the processor used to relay configuration between a custom UI and the procesosr.
	AnnotationData string `json:"annotationData,omitempty"`
	// Maps default values for concurrent tasks for each applicable scheduling strategy.
	DefaultConcurrentTasks map[string]string `json:"defaultConcurrentTasks,omitempty"`
	// Maps default values for scheduling period for each applicable scheduling strategy.
	DefaultSchedulingPeriod map[string]string `json:"defaultSchedulingPeriod,omitempty"`
}

ProcessorConfigDto struct for ProcessorConfigDto

type ProcessorDto ¶ 

type ProcessorDto struct {
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The ID of the corresponding component that is under version control
	VersionedComponentId string `json:"versionedComponentId,omitempty"`
	// The id of parent process group of this component if applicable.
	ParentGroupId string      `json:"parentGroupId,omitempty"`
	Position      PositionDto `json:"position,omitempty"`
	// The name of the processor.
	Name string `json:"name,omitempty"`
	// The type of the processor.
	Type   string    `json:"type,omitempty"`
	Bundle BundleDto `json:"bundle,omitempty"`
	// The state of the processor
	State string `json:"state,omitempty"`
	// Styles for the processor (background-color : #eee).
	Style map[string]string `json:"style,omitempty"`
	// The available relationships that the processor currently supports.
	Relationships []RelationshipDto `json:"relationships,omitempty"`
	// The description of the processor.
	Description string `json:"description,omitempty"`
	// Whether the processor supports parallel processing.
	SupportsParallelProcessing bool `json:"supportsParallelProcessing,omitempty"`
	// Whether the processor supports event driven scheduling.
	SupportsEventDriven bool `json:"supportsEventDriven,omitempty"`
	// Whether the processor supports batching. This makes the run duration settings available.
	SupportsBatching bool `json:"supportsBatching,omitempty"`
	// Whether the processor persists state.
	PersistsState bool `json:"persistsState,omitempty"`
	// Whether the processor requires elevated privileges.
	Restricted bool `json:"restricted,omitempty"`
	// Whether the processor has been deprecated.
	Deprecated bool `json:"deprecated,omitempty"`
	// Indicates if the execution node of a processor is restricted to run only on the primary node
	ExecutionNodeRestricted bool `json:"executionNodeRestricted,omitempty"`
	// Whether the processor has multiple versions available.
	MultipleVersionsAvailable bool `json:"multipleVersionsAvailable,omitempty"`
	// The input requirement for this processor.
	InputRequirement string             `json:"inputRequirement,omitempty"`
	Config           ProcessorConfigDto `json:"config,omitempty"`
	// The validation errors for the processor. These validation errors represent the problems with the processor that must be resolved before it can be started.
	ValidationErrors []string `json:"validationErrors,omitempty"`
	// Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)
	ValidationStatus string `json:"validationStatus,omitempty"`
	// Whether the underlying extension is missing.
	ExtensionMissing bool `json:"extensionMissing,omitempty"`
}

ProcessorDto struct for ProcessorDto

type ProcessorEntity ¶ 

type ProcessorEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The URI for futures requests to the component.
	Uri         string         `json:"uri,omitempty"`
	Position    PositionDto    `json:"position,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
	// The bulletins for this component.
	Bulletins []BulletinEntity `json:"bulletins,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool         `json:"disconnectedNodeAcknowledged,omitempty"`
	Component                    ProcessorDto `json:"component,omitempty"`
	// The input requirement for this processor.
	InputRequirement   string             `json:"inputRequirement,omitempty"`
	Status             ProcessorStatusDto `json:"status,omitempty"`
	OperatePermissions PermissionsDto     `json:"operatePermissions,omitempty"`
}

ProcessorEntity struct for ProcessorEntity

type ProcessorRunStatusDetailsDto ¶ 

type ProcessorRunStatusDetailsDto struct {
	// The ID of the processor
	Id string `json:"id,omitempty"`
	// The name of the processor
	Name string `json:"name,omitempty"`
	// The run status of the processor
	RunStatus string `json:"runStatus,omitempty"`
	// The processor's validation errors
	ValidationErrors []string `json:"validationErrors,omitempty"`
	// The current number of threads that the processor is currently using
	ActiveThreadCount int32 `json:"activeThreadCount,omitempty"`
}

ProcessorRunStatusDetailsDto struct for ProcessorRunStatusDetailsDto

type ProcessorRunStatusDetailsEntity ¶ 

type ProcessorRunStatusDetailsEntity struct {
	Revision         RevisionDto                  `json:"revision,omitempty"`
	Permissions      PermissionsDto               `json:"permissions,omitempty"`
	RunStatusDetails ProcessorRunStatusDetailsDto `json:"runStatusDetails,omitempty"`
}

ProcessorRunStatusDetailsEntity struct for ProcessorRunStatusDetailsEntity

type ProcessorRunStatusEntity ¶ 

type ProcessorRunStatusEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The run status of the Processor.
	State string `json:"state,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool `json:"disconnectedNodeAcknowledged,omitempty"`
}

ProcessorRunStatusEntity struct for ProcessorRunStatusEntity

type ProcessorStatusDto ¶ 

type ProcessorStatusDto struct {
	// The unique ID of the process group that the Processor belongs to
	GroupId string `json:"groupId,omitempty"`
	// The unique ID of the Processor
	Id string `json:"id,omitempty"`
	// The name of the Processor
	Name string `json:"name,omitempty"`
	// The type of the Processor
	Type string `json:"type,omitempty"`
	// The run status of the Processor
	RunStatus string `json:"runStatus,omitempty"`
	// The timestamp of when the stats were last refreshed
	StatsLastRefreshed string                     `json:"statsLastRefreshed,omitempty"`
	AggregateSnapshot  ProcessorStatusSnapshotDto `json:"aggregateSnapshot,omitempty"`
	// A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.
	NodeSnapshots []NodeProcessorStatusSnapshotDto `json:"nodeSnapshots,omitempty"`
}

ProcessorStatusDto struct for ProcessorStatusDto

type ProcessorStatusEntity ¶ 

type ProcessorStatusEntity struct {
	ProcessorStatus ProcessorStatusDto `json:"processorStatus,omitempty"`
	// Indicates whether the user can read a given resource.
	CanRead bool `json:"canRead,omitempty"`
}

ProcessorStatusEntity struct for ProcessorStatusEntity

type ProcessorStatusSnapshotDto ¶ 

type ProcessorStatusSnapshotDto struct {
	// The id of the processor.
	Id string `json:"id,omitempty"`
	// The id of the parent process group to which the processor belongs.
	GroupId string `json:"groupId,omitempty"`
	// The name of the prcessor.
	Name string `json:"name,omitempty"`
	// The type of the processor.
	Type string `json:"type,omitempty"`
	// The state of the processor.
	RunStatus string `json:"runStatus,omitempty"`
	// Indicates the node where the process will execute.
	ExecutionNode string `json:"executionNode,omitempty"`
	// The number of bytes read by this Processor in the last 5 mintues
	BytesRead int64 `json:"bytesRead,omitempty"`
	// The number of bytes written by this Processor in the last 5 minutes
	BytesWritten int64 `json:"bytesWritten,omitempty"`
	// The number of bytes read in the last 5 minutes.
	Read string `json:"read,omitempty"`
	// The number of bytes written in the last 5 minutes.
	Written string `json:"written,omitempty"`
	// The number of FlowFiles that have been accepted in the last 5 minutes
	FlowFilesIn int32 `json:"flowFilesIn,omitempty"`
	// The size of the FlowFiles that have been accepted in the last 5 minutes
	BytesIn int64 `json:"bytesIn,omitempty"`
	// The count/size of flowfiles that have been accepted in the last 5 minutes.
	Input string `json:"input,omitempty"`
	// The number of FlowFiles transferred to a Connection in the last 5 minutes
	FlowFilesOut int32 `json:"flowFilesOut,omitempty"`
	// The size of the FlowFiles transferred to a Connection in the last 5 minutes
	BytesOut int64 `json:"bytesOut,omitempty"`
	// The count/size of flowfiles that have been processed in the last 5 minutes.
	Output string `json:"output,omitempty"`
	// The number of times this Processor has run in the last 5 minutes
	TaskCount int32 `json:"taskCount,omitempty"`
	// The number of nanoseconds that this Processor has spent running in the last 5 minutes
	TasksDurationNanos int64 `json:"tasksDurationNanos,omitempty"`
	// The total number of task this connectable has completed over the last 5 minutes.
	Tasks string `json:"tasks,omitempty"`
	// The total duration of all tasks for this connectable over the last 5 minutes.
	TasksDuration string `json:"tasksDuration,omitempty"`
	// The number of threads currently executing in the processor.
	ActiveThreadCount int32 `json:"activeThreadCount,omitempty"`
	// The number of threads currently terminated for the processor.
	TerminatedThreadCount int32 `json:"terminatedThreadCount,omitempty"`
}

ProcessorStatusSnapshotDto struct for ProcessorStatusSnapshotDto

type ProcessorStatusSnapshotEntity ¶ 

type ProcessorStatusSnapshotEntity struct {
	// The id of the processor.
	Id                      string                     `json:"id,omitempty"`
	ProcessorStatusSnapshot ProcessorStatusSnapshotDto `json:"processorStatusSnapshot,omitempty"`
	// Indicates whether the user can read a given resource.
	CanRead bool `json:"canRead,omitempty"`
}

ProcessorStatusSnapshotEntity struct for ProcessorStatusSnapshotEntity

type ProcessorTypesEntity ¶ 

type ProcessorTypesEntity struct {
	ProcessorTypes []DocumentedTypeDto `json:"processorTypes,omitempty"`
}

ProcessorTypesEntity struct for ProcessorTypesEntity

type ProcessorsApiDeleteProcessorOpts ¶ 

type ProcessorsApiDeleteProcessorOpts struct {
	Version                      optional.String
	ClientId                     optional.String
	DisconnectedNodeAcknowledged optional.Bool
}

ProcessorsApiDeleteProcessorOpts Optional parameters for the method 'DeleteProcessor'

type ProcessorsApiGetProcessorRunStatusDetailsOpts ¶ 

type ProcessorsApiGetProcessorRunStatusDetailsOpts struct {
	Body optional.Interface
}

ProcessorsApiGetProcessorRunStatusDetailsOpts Optional parameters for the method 'GetProcessorRunStatusDetails'

type ProcessorsApiGetPropertyDescriptorOpts ¶ 

type ProcessorsApiGetPropertyDescriptorOpts struct {
	ClientId optional.String
}

ProcessorsApiGetPropertyDescriptorOpts Optional parameters for the method 'GetPropertyDescriptor'

type ProcessorsApiService ¶ 

type ProcessorsApiService service

ProcessorsApiService ProcessorsApi service

func (*ProcessorsApiService) ClearState ¶ 

func (a *ProcessorsApiService) ClearState(ctx _context.Context, id string) (ComponentStateEntity, *_nethttp.Response, error)

ClearState Clears the state for a processor

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The processor id.

@return ComponentStateEntity

func (*ProcessorsApiService) DeleteProcessor ¶ 

func (a *ProcessorsApiService) DeleteProcessor(ctx _context.Context, id string, localVarOptionals *ProcessorsApiDeleteProcessorOpts) (ProcessorEntity, *_nethttp.Response, error)

DeleteProcessor Deletes a processor

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The processor id.
  • @param optional nil or *ProcessorsApiDeleteProcessorOpts - Optional Parameters:
  • @param "Version" (optional.String) - The revision is used to verify the client is working with the latest version of the flow.
  • @param "ClientId" (optional.String) - If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

@return ProcessorEntity

func (*ProcessorsApiService) GetProcessor ¶ 

func (a *ProcessorsApiService) GetProcessor(ctx _context.Context, id string) (ProcessorEntity, *_nethttp.Response, error)

GetProcessor Gets a processor

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The processor id.

@return ProcessorEntity

func (*ProcessorsApiService) GetProcessorDiagnostics ¶ 

func (a *ProcessorsApiService) GetProcessorDiagnostics(ctx _context.Context, id string) (ProcessorEntity, *_nethttp.Response, error)

GetProcessorDiagnostics Gets diagnostics information about a processor Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The processor id.

@return ProcessorEntity

func (*ProcessorsApiService) GetProcessorRunStatusDetails ¶ 

func (a *ProcessorsApiService) GetProcessorRunStatusDetails(ctx _context.Context, localVarOptionals *ProcessorsApiGetProcessorRunStatusDetailsOpts) (ProcessorsRunStatusDetailsEntity, *_nethttp.Response, error)

GetProcessorRunStatusDetails Submits a query to retrieve the run status details of all processors that are in the given list of Processor IDs

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *ProcessorsApiGetProcessorRunStatusDetailsOpts - Optional Parameters:
  • @param "Body" (optional.Interface of RunStatusDetailsRequestEntity) - The request for the processors that should be included in the results

@return ProcessorsRunStatusDetailsEntity

func (*ProcessorsApiService) GetPropertyDescriptor ¶ 

func (a *ProcessorsApiService) GetPropertyDescriptor(ctx _context.Context, id string, propertyName string, localVarOptionals *ProcessorsApiGetPropertyDescriptorOpts) (PropertyDescriptorEntity, *_nethttp.Response, error)

GetPropertyDescriptor Gets the descriptor for a processor property

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The processor id.
  • @param propertyName The property name.
  • @param optional nil or *ProcessorsApiGetPropertyDescriptorOpts - Optional Parameters:
  • @param "ClientId" (optional.String) - If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.

@return PropertyDescriptorEntity

func (*ProcessorsApiService) GetState ¶ 

func (a *ProcessorsApiService) GetState(ctx _context.Context, id string) (ComponentStateEntity, *_nethttp.Response, error)

GetState Gets the state for a processor

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The processor id.

@return ComponentStateEntity

func (*ProcessorsApiService) TerminateProcessor ¶ 

func (a *ProcessorsApiService) TerminateProcessor(ctx _context.Context, id string) (ProcessorEntity, *_nethttp.Response, error)

TerminateProcessor Terminates a processor, essentially \"deleting\" its threads and any active tasks

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The processor id.

@return ProcessorEntity

func (*ProcessorsApiService) UpdateProcessor ¶ 

func (a *ProcessorsApiService) UpdateProcessor(ctx _context.Context, id string, body ProcessorEntity) (ProcessorEntity, *_nethttp.Response, error)

UpdateProcessor Updates a processor

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The processor id.
  • @param body The processor configuration details.

@return ProcessorEntity

func (*ProcessorsApiService) UpdateRunStatus ¶ 

func (a *ProcessorsApiService) UpdateRunStatus(ctx _context.Context, id string, body ProcessorRunStatusEntity) (ProcessorEntity, *_nethttp.Response, error)

UpdateRunStatus Updates run status of a processor

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The processor id.
  • @param body The processor run status.

@return ProcessorEntity

type ProcessorsEntity ¶ 

type ProcessorsEntity struct {
	Processors []ProcessorEntity `json:"processors,omitempty"`
}

ProcessorsEntity struct for ProcessorsEntity

type ProcessorsRunStatusDetailsEntity ¶ 

type ProcessorsRunStatusDetailsEntity struct {
	RunStatusDetails []ProcessorRunStatusDetailsEntity `json:"runStatusDetails,omitempty"`
}

ProcessorsRunStatusDetailsEntity struct for ProcessorsRunStatusDetailsEntity

type PropertyDescriptorDto ¶ 

type PropertyDescriptorDto struct {
	// The name for the property.
	Name string `json:"name,omitempty"`
	// The human readable name for the property.
	DisplayName string `json:"displayName,omitempty"`
	// The description for the property. Used to relay additional details to a user or provide a mechanism of documenting intent.
	Description string `json:"description,omitempty"`
	// The default value for the property.
	DefaultValue string `json:"defaultValue,omitempty"`
	// Allowable values for the property. If empty then the allowed values are not constrained.
	AllowableValues []AllowableValueEntity `json:"allowableValues,omitempty"`
	// Whether the property is required.
	Required bool `json:"required,omitempty"`
	// Whether the property is sensitive and protected whenever stored or represented.
	Sensitive bool `json:"sensitive,omitempty"`
	// Whether the property is dynamic (user-defined).
	Dynamic bool `json:"dynamic,omitempty"`
	// Whether the property supports expression language.
	SupportsEl bool `json:"supportsEl,omitempty"`
	// Scope of the Expression Language evaluation for the property.
	ExpressionLanguageScope string `json:"expressionLanguageScope,omitempty"`
	// If the property identifies a controller service this returns the fully qualified type.
	IdentifiesControllerService       string    `json:"identifiesControllerService,omitempty"`
	IdentifiesControllerServiceBundle BundleDto `json:"identifiesControllerServiceBundle,omitempty"`
}

PropertyDescriptorDto struct for PropertyDescriptorDto

type PropertyDescriptorEntity ¶ 

type PropertyDescriptorEntity struct {
	PropertyDescriptor PropertyDescriptorDto `json:"propertyDescriptor,omitempty"`
}

PropertyDescriptorEntity struct for PropertyDescriptorEntity

type PropertyHistoryDto ¶ 

type PropertyHistoryDto struct {
	// Previous values for a given property.
	PreviousValues []PreviousValueDto `json:"previousValues,omitempty"`
}

PropertyHistoryDto struct for PropertyHistoryDto

type ProvenanceApiDeleteLineageOpts ¶ 

type ProvenanceApiDeleteLineageOpts struct {
	ClusterNodeId optional.String
}

ProvenanceApiDeleteLineageOpts Optional parameters for the method 'DeleteLineage'

type ProvenanceApiDeleteProvenanceOpts ¶ 

type ProvenanceApiDeleteProvenanceOpts struct {
	ClusterNodeId optional.String
}

ProvenanceApiDeleteProvenanceOpts Optional parameters for the method 'DeleteProvenance'

type ProvenanceApiGetLineageOpts ¶ 

type ProvenanceApiGetLineageOpts struct {
	ClusterNodeId optional.String
}

ProvenanceApiGetLineageOpts Optional parameters for the method 'GetLineage'

type ProvenanceApiGetProvenanceOpts ¶ 

type ProvenanceApiGetProvenanceOpts struct {
	ClusterNodeId      optional.String
	Summarize          optional.Bool
	IncrementalResults optional.Bool
}

ProvenanceApiGetProvenanceOpts Optional parameters for the method 'GetProvenance'

type ProvenanceApiService ¶ 

type ProvenanceApiService service

ProvenanceApiService ProvenanceApi service

func (*ProvenanceApiService) DeleteLineage ¶ 

func (a *ProvenanceApiService) DeleteLineage(ctx _context.Context, id string, localVarOptionals *ProvenanceApiDeleteLineageOpts) (LineageEntity, *_nethttp.Response, error)

DeleteLineage Deletes a lineage query

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the lineage query.
  • @param optional nil or *ProvenanceApiDeleteLineageOpts - Optional Parameters:
  • @param "ClusterNodeId" (optional.String) - The id of the node where this query exists if clustered.

@return LineageEntity

func (*ProvenanceApiService) DeleteProvenance ¶ 

func (a *ProvenanceApiService) DeleteProvenance(ctx _context.Context, id string, localVarOptionals *ProvenanceApiDeleteProvenanceOpts) (ProvenanceEntity, *_nethttp.Response, error)

DeleteProvenance Deletes a provenance query

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the provenance query.
  • @param optional nil or *ProvenanceApiDeleteProvenanceOpts - Optional Parameters:
  • @param "ClusterNodeId" (optional.String) - The id of the node where this query exists if clustered.

@return ProvenanceEntity

func (*ProvenanceApiService) GetLineage ¶ 

func (a *ProvenanceApiService) GetLineage(ctx _context.Context, id string, localVarOptionals *ProvenanceApiGetLineageOpts) (LineageEntity, *_nethttp.Response, error)

GetLineage Gets a lineage query

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the lineage query.
  • @param optional nil or *ProvenanceApiGetLineageOpts - Optional Parameters:
  • @param "ClusterNodeId" (optional.String) - The id of the node where this query exists if clustered.

@return LineageEntity

func (*ProvenanceApiService) GetProvenance ¶ 

func (a *ProvenanceApiService) GetProvenance(ctx _context.Context, id string, localVarOptionals *ProvenanceApiGetProvenanceOpts) (ProvenanceEntity, *_nethttp.Response, error)

GetProvenance Gets a provenance query

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The id of the provenance query.
  • @param optional nil or *ProvenanceApiGetProvenanceOpts - Optional Parameters:
  • @param "ClusterNodeId" (optional.String) - The id of the node where this query exists if clustered.
  • @param "Summarize" (optional.Bool) - Whether or not incremental results are returned. If false, provenance events are only returned once the query completes. This property is true by default.
  • @param "IncrementalResults" (optional.Bool) - Whether or not to summarize provenance events returned. This property is false by default.

@return ProvenanceEntity

func (*ProvenanceApiService) GetSearchOptions ¶ 

func (a *ProvenanceApiService) GetSearchOptions(ctx _context.Context) (ProvenanceOptionsEntity, *_nethttp.Response, error)

GetSearchOptions Gets the searchable attributes for provenance events

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ProvenanceOptionsEntity

func (*ProvenanceApiService) SubmitLineageRequest ¶ 

func (a *ProvenanceApiService) SubmitLineageRequest(ctx _context.Context, body LineageEntity) (LineageEntity, *_nethttp.Response, error)

SubmitLineageRequest Submits a lineage query 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.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The lineage query details.

@return LineageEntity

func (*ProvenanceApiService) SubmitProvenanceRequest ¶ 

func (a *ProvenanceApiService) SubmitProvenanceRequest(ctx _context.Context, body ProvenanceEntity) (ProvenanceEntity, *_nethttp.Response, error)

SubmitProvenanceRequest Submits a provenance query 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.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The provenance query details.

@return ProvenanceEntity

type ProvenanceDto ¶ 

type ProvenanceDto struct {
	// The id of the provenance query.
	Id string `json:"id,omitempty"`
	// The URI for this query. Used for obtaining/deleting the request at a later time
	Uri string `json:"uri,omitempty"`
	// The timestamp when the query was submitted.
	SubmissionTime string `json:"submissionTime,omitempty"`
	// The timestamp when the query will expire.
	Expiration string `json:"expiration,omitempty"`
	// The current percent complete.
	PercentCompleted int32 `json:"percentCompleted,omitempty"`
	// Whether the query has finished.
	Finished bool                 `json:"finished,omitempty"`
	Request  ProvenanceRequestDto `json:"request,omitempty"`
	Results  ProvenanceResultsDto `json:"results,omitempty"`
}

ProvenanceDto struct for ProvenanceDto

type ProvenanceEntity ¶ 

type ProvenanceEntity struct {
	Provenance ProvenanceDto `json:"provenance,omitempty"`
}

ProvenanceEntity struct for ProvenanceEntity

type ProvenanceEventDto ¶ 

type ProvenanceEventDto struct {
	// The event uuid.
	Id string `json:"id,omitempty"`
	// The event id. This is a one up number thats unique per node.
	EventId int64 `json:"eventId,omitempty"`
	// The timestamp of the event.
	EventTime string `json:"eventTime,omitempty"`
	// The event duration in milliseconds.
	EventDuration int64 `json:"eventDuration,omitempty"`
	// The duration since the lineage began, in milliseconds.
	LineageDuration int64 `json:"lineageDuration,omitempty"`
	// The type of the event.
	EventType string `json:"eventType,omitempty"`
	// The uuid of the flowfile for the event.
	FlowFileUuid string `json:"flowFileUuid,omitempty"`
	// The size of the flowfile for the event.
	FileSize string `json:"fileSize,omitempty"`
	// The size of the flowfile in bytes for the event.
	FileSizeBytes int64 `json:"fileSizeBytes,omitempty"`
	// The identifier for the node where the event originated.
	ClusterNodeId string `json:"clusterNodeId,omitempty"`
	// The label for the node where the event originated.
	ClusterNodeAddress string `json:"clusterNodeAddress,omitempty"`
	// The id of the group that the component resides in. If the component is no longer in the flow, the group id will not be set.
	GroupId string `json:"groupId,omitempty"`
	// The id of the component that generated the event.
	ComponentId string `json:"componentId,omitempty"`
	// The type of the component that generated the event.
	ComponentType string `json:"componentType,omitempty"`
	// The name of the component that generated the event.
	ComponentName string `json:"componentName,omitempty"`
	// The source system flowfile id.
	SourceSystemFlowFileId string `json:"sourceSystemFlowFileId,omitempty"`
	// The alternate identifier uri for the fileflow for the event.
	AlternateIdentifierUri string `json:"alternateIdentifierUri,omitempty"`
	// The attributes of the flowfile for the event.
	Attributes []AttributeDto `json:"attributes,omitempty"`
	// The parent uuids for the event.
	ParentUuids []string `json:"parentUuids,omitempty"`
	// The child uuids for the event.
	ChildUuids []string `json:"childUuids,omitempty"`
	// The source/destination system uri if the event was a RECEIVE/SEND.
	TransitUri string `json:"transitUri,omitempty"`
	// The relationship to which the flowfile was routed if the event is of type ROUTE.
	Relationship string `json:"relationship,omitempty"`
	// The event details.
	Details string `json:"details,omitempty"`
	// Whether the input and output content claim is the same.
	ContentEqual bool `json:"contentEqual,omitempty"`
	// Whether the input content is still available.
	InputContentAvailable bool `json:"inputContentAvailable,omitempty"`
	// The section in which the input content claim lives.
	InputContentClaimSection string `json:"inputContentClaimSection,omitempty"`
	// The container in which the input content claim lives.
	InputContentClaimContainer string `json:"inputContentClaimContainer,omitempty"`
	// The identifier of the input content claim.
	InputContentClaimIdentifier string `json:"inputContentClaimIdentifier,omitempty"`
	// The offset into the input content claim where the flowfiles content begins.
	InputContentClaimOffset int64 `json:"inputContentClaimOffset,omitempty"`
	// The file size of the input content claim formatted.
	InputContentClaimFileSize string `json:"inputContentClaimFileSize,omitempty"`
	// The file size of the intput content claim in bytes.
	InputContentClaimFileSizeBytes int64 `json:"inputContentClaimFileSizeBytes,omitempty"`
	// Whether the output content is still available.
	OutputContentAvailable bool `json:"outputContentAvailable,omitempty"`
	// The section in which the output content claim lives.
	OutputContentClaimSection string `json:"outputContentClaimSection,omitempty"`
	// The container in which the output content claim lives.
	OutputContentClaimContainer string `json:"outputContentClaimContainer,omitempty"`
	// The identifier of the output content claim.
	OutputContentClaimIdentifier string `json:"outputContentClaimIdentifier,omitempty"`
	// The offset into the output content claim where the flowfiles content begins.
	OutputContentClaimOffset int64 `json:"outputContentClaimOffset,omitempty"`
	// The file size of the output content claim formatted.
	OutputContentClaimFileSize string `json:"outputContentClaimFileSize,omitempty"`
	// The file size of the output content claim in bytes.
	OutputContentClaimFileSizeBytes int64 `json:"outputContentClaimFileSizeBytes,omitempty"`
	// Whether or not replay is available.
	ReplayAvailable bool `json:"replayAvailable,omitempty"`
	// Explanation as to why replay is unavailable.
	ReplayExplanation string `json:"replayExplanation,omitempty"`
	// The identifier of the queue/connection from which the flowfile was pulled to genereate this event. May be null if the queue/connection is unknown or the flowfile was generated from this event.
	SourceConnectionIdentifier string `json:"sourceConnectionIdentifier,omitempty"`
}

ProvenanceEventDto struct for ProvenanceEventDto

type ProvenanceEventEntity ¶ 

type ProvenanceEventEntity struct {
	ProvenanceEvent ProvenanceEventDto `json:"provenanceEvent,omitempty"`
}

ProvenanceEventEntity struct for ProvenanceEventEntity

type ProvenanceEventsApiGetInputContentOpts ¶ 

type ProvenanceEventsApiGetInputContentOpts struct {
	ClusterNodeId optional.String
}

ProvenanceEventsApiGetInputContentOpts Optional parameters for the method 'GetInputContent'

type ProvenanceEventsApiGetOutputContentOpts ¶ 

type ProvenanceEventsApiGetOutputContentOpts struct {
	ClusterNodeId optional.String
}

ProvenanceEventsApiGetOutputContentOpts Optional parameters for the method 'GetOutputContent'

type ProvenanceEventsApiGetProvenanceEventOpts ¶ 

type ProvenanceEventsApiGetProvenanceEventOpts struct {
	ClusterNodeId optional.String
}

ProvenanceEventsApiGetProvenanceEventOpts Optional parameters for the method 'GetProvenanceEvent'

type ProvenanceEventsApiService ¶ 

type ProvenanceEventsApiService service

ProvenanceEventsApiService ProvenanceEventsApi service

func (*ProvenanceEventsApiService) GetInputContent ¶ 

func (a *ProvenanceEventsApiService) GetInputContent(ctx _context.Context, id string, localVarOptionals *ProvenanceEventsApiGetInputContentOpts) (map[string]interface{}, *_nethttp.Response, error)

GetInputContent Gets the input content for a provenance event

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The provenance event id.
  • @param optional nil or *ProvenanceEventsApiGetInputContentOpts - Optional Parameters:
  • @param "ClusterNodeId" (optional.String) - The id of the node where the content exists if clustered.

@return map[string]interface{}

func (*ProvenanceEventsApiService) GetOutputContent ¶ 

func (a *ProvenanceEventsApiService) GetOutputContent(ctx _context.Context, id string, localVarOptionals *ProvenanceEventsApiGetOutputContentOpts) (map[string]interface{}, *_nethttp.Response, error)

GetOutputContent Gets the output content for a provenance event

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The provenance event id.
  • @param optional nil or *ProvenanceEventsApiGetOutputContentOpts - Optional Parameters:
  • @param "ClusterNodeId" (optional.String) - The id of the node where the content exists if clustered.

@return map[string]interface{}

func (*ProvenanceEventsApiService) GetProvenanceEvent ¶ 

func (a *ProvenanceEventsApiService) GetProvenanceEvent(ctx _context.Context, id string, localVarOptionals *ProvenanceEventsApiGetProvenanceEventOpts) (ProvenanceEventEntity, *_nethttp.Response, error)

GetProvenanceEvent Gets a provenance event

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The provenance event id.
  • @param optional nil or *ProvenanceEventsApiGetProvenanceEventOpts - Optional Parameters:
  • @param "ClusterNodeId" (optional.String) - The id of the node where this event exists if clustered.

@return ProvenanceEventEntity

func (*ProvenanceEventsApiService) SubmitReplay ¶ 

func (a *ProvenanceEventsApiService) SubmitReplay(ctx _context.Context, body SubmitReplayRequestEntity) (ProvenanceEventEntity, *_nethttp.Response, error)

SubmitReplay Replays content from a provenance event

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The replay request.

@return ProvenanceEventEntity

type ProvenanceLinkDto ¶ 

type ProvenanceLinkDto struct {
	// The source node id of the link.
	SourceId string `json:"sourceId,omitempty"`
	// The target node id of the link.
	TargetId string `json:"targetId,omitempty"`
	// The flowfile uuid that traversed the link.
	FlowFileUuid string `json:"flowFileUuid,omitempty"`
	// The timestamp of the link (based on the destination).
	Timestamp string `json:"timestamp,omitempty"`
	// The timestamp of this link in milliseconds.
	Millis int64 `json:"millis,omitempty"`
}

ProvenanceLinkDto struct for ProvenanceLinkDto

type ProvenanceNodeDto ¶ 

type ProvenanceNodeDto struct {
	// The id of the node.
	Id string `json:"id,omitempty"`
	// The uuid of the flowfile associated with the provenance event.
	FlowFileUuid string `json:"flowFileUuid,omitempty"`
	// The uuid of the parent flowfiles of the provenance event.
	ParentUuids []string `json:"parentUuids,omitempty"`
	// The uuid of the childrent flowfiles of the provenance event.
	ChildUuids []string `json:"childUuids,omitempty"`
	// The identifier of the node that this event/flowfile originated from.
	ClusterNodeIdentifier string `json:"clusterNodeIdentifier,omitempty"`
	// The type of the node.
	Type string `json:"type,omitempty"`
	// If the type is EVENT, this is the type of event.
	EventType string `json:"eventType,omitempty"`
	// The timestamp of the node in milliseconds.
	Millis int64 `json:"millis,omitempty"`
	// The timestamp of the node formatted.
	Timestamp string `json:"timestamp,omitempty"`
}

ProvenanceNodeDto struct for ProvenanceNodeDto

type ProvenanceOptionsDto ¶ 

type ProvenanceOptionsDto struct {
	// The available searchable field for the NiFi.
	SearchableFields []ProvenanceSearchableFieldDto `json:"searchableFields,omitempty"`
}

ProvenanceOptionsDto struct for ProvenanceOptionsDto

type ProvenanceOptionsEntity ¶ 

type ProvenanceOptionsEntity struct {
	ProvenanceOptions ProvenanceOptionsDto `json:"provenanceOptions,omitempty"`
}

ProvenanceOptionsEntity struct for ProvenanceOptionsEntity

type ProvenanceRequestDto ¶ 

type ProvenanceRequestDto struct {
	// The search terms used to perform the search.
	SearchTerms map[string]string `json:"searchTerms,omitempty"`
	// The id of the node in the cluster where this provenance originated.
	ClusterNodeId string `json:"clusterNodeId,omitempty"`
	// The earliest event time to include in the query.
	StartDate string `json:"startDate,omitempty"`
	// The latest event time to include in the query.
	EndDate string `json:"endDate,omitempty"`
	// The minimum file size to include in the query.
	MinimumFileSize string `json:"minimumFileSize,omitempty"`
	// The maximum file size to include in the query.
	MaximumFileSize string `json:"maximumFileSize,omitempty"`
	// The maximum number of results to include.
	MaxResults int32 `json:"maxResults,omitempty"`
	// Whether or not to summarize provenance events returned. This property is false by default.
	Summarize bool `json:"summarize,omitempty"`
	// 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 bool `json:"incrementalResults,omitempty"`
}

ProvenanceRequestDto struct for ProvenanceRequestDto

type ProvenanceResultsDto ¶ 

type ProvenanceResultsDto struct {
	// The provenance events that matched the search criteria.
	ProvenanceEvents []ProvenanceEventDto `json:"provenanceEvents,omitempty"`
	// The total number of results formatted.
	Total string `json:"total,omitempty"`
	// The total number of results.
	TotalCount int64 `json:"totalCount,omitempty"`
	// Then the search was performed.
	Generated string `json:"generated,omitempty"`
	// The oldest event available in the provenance repository.
	OldestEvent string `json:"oldestEvent,omitempty"`
	// The time offset of the server that's used for event time.
	TimeOffset int32 `json:"timeOffset,omitempty"`
	// Any errors that occurred while performing the provenance request.
	Errors []string `json:"errors,omitempty"`
}

ProvenanceResultsDto struct for ProvenanceResultsDto

type ProvenanceSearchableFieldDto ¶ 

type ProvenanceSearchableFieldDto struct {
	// The id of the searchable field.
	Id string `json:"id,omitempty"`
	// The searchable field.
	Field string `json:"field,omitempty"`
	// The label for the searchable field.
	Label string `json:"label,omitempty"`
	// The type of the searchable field.
	Type string `json:"type,omitempty"`
}

ProvenanceSearchableFieldDto struct for ProvenanceSearchableFieldDto

type QueueSizeDto ¶ 

type QueueSizeDto struct {
	// The size of objects in a queue.
	ByteCount int64 `json:"byteCount,omitempty"`
	// The count of objects in a queue.
	ObjectCount int32 `json:"objectCount,omitempty"`
}

QueueSizeDto struct for QueueSizeDto

type RegistryClientEntity ¶ 

type RegistryClientEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The URI for futures requests to the component.
	Uri         string         `json:"uri,omitempty"`
	Position    PositionDto    `json:"position,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
	// The bulletins for this component.
	Bulletins []BulletinEntity `json:"bulletins,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool        `json:"disconnectedNodeAcknowledged,omitempty"`
	Component                    RegistryDto `json:"component,omitempty"`
}

RegistryClientEntity struct for RegistryClientEntity

type RegistryClientsEntity ¶ 

type RegistryClientsEntity struct {
	Registries []RegistryClientEntity `json:"registries,omitempty"`
}

RegistryClientsEntity struct for RegistryClientsEntity

type RegistryDto ¶ 

type RegistryDto struct {
	// The registry identifier
	Id string `json:"id,omitempty"`
	// The registry name
	Name string `json:"name,omitempty"`
	// The registry description
	Description string `json:"description,omitempty"`
	// The registry URI
	Uri string `json:"uri,omitempty"`
}

RegistryDto struct for RegistryDto

type RelationshipDto ¶ 

type RelationshipDto struct {
	// The relationship name.
	Name string `json:"name,omitempty"`
	// The relationship description.
	Description string `json:"description,omitempty"`
	// Whether or not flowfiles sent to this relationship should auto terminate.
	AutoTerminate bool `json:"autoTerminate,omitempty"`
}

RelationshipDto struct for RelationshipDto

type RemotePortRunStatusEntity ¶ 

type RemotePortRunStatusEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The run status of the RemotePort.
	State string `json:"state,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool `json:"disconnectedNodeAcknowledged,omitempty"`
}

RemotePortRunStatusEntity struct for RemotePortRunStatusEntity

type RemoteProcessGroupContentsDto ¶ 

type RemoteProcessGroupContentsDto struct {
	// The input ports to which data can be sent.
	InputPorts []RemoteProcessGroupPortDto `json:"inputPorts,omitempty"`
	// The output ports from which data can be retrieved.
	OutputPorts []RemoteProcessGroupPortDto `json:"outputPorts,omitempty"`
}

RemoteProcessGroupContentsDto struct for RemoteProcessGroupContentsDto

type RemoteProcessGroupDto ¶ 

type RemoteProcessGroupDto struct {
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The ID of the corresponding component that is under version control
	VersionedComponentId string `json:"versionedComponentId,omitempty"`
	// The id of parent process group of this component if applicable.
	ParentGroupId string      `json:"parentGroupId,omitempty"`
	Position      PositionDto `json:"position,omitempty"`
	// The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first url in the urls. If neither target uri nor uris are set, then returns null.
	TargetUri string `json:"targetUri,omitempty"`
	// The target URI of the remote process group. If target uris is not set but target uri is set, then returns a collection containing the single target uri. If neither target uris nor uris are set, then returns null.
	TargetUris string `json:"targetUris,omitempty"`
	// Whether the target is running securely.
	TargetSecure bool `json:"targetSecure,omitempty"`
	// The name of the remote process group.
	Name string `json:"name,omitempty"`
	// The comments for the remote process group.
	Comments string `json:"comments,omitempty"`
	// The time period used for the timeout when communicating with the target.
	CommunicationsTimeout string `json:"communicationsTimeout,omitempty"`
	// When yielding, this amount of time must elapse before the remote process group is scheduled again.
	YieldDuration     string `json:"yieldDuration,omitempty"`
	TransportProtocol string `json:"transportProtocol,omitempty"`
	// The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier.
	LocalNetworkInterface string `json:"localNetworkInterface,omitempty"`
	ProxyHost             string `json:"proxyHost,omitempty"`
	ProxyPort             int32  `json:"proxyPort,omitempty"`
	ProxyUser             string `json:"proxyUser,omitempty"`
	ProxyPassword         string `json:"proxyPassword,omitempty"`
	// Any remote authorization issues for the remote process group.
	AuthorizationIssues []string `json:"authorizationIssues,omitempty"`
	// The validation errors for the remote process group. These validation errors represent the problems with the remote process group that must be resolved before it can transmit.
	ValidationErrors []string `json:"validationErrors,omitempty"`
	// Whether the remote process group is actively transmitting.
	Transmitting bool `json:"transmitting,omitempty"`
	// The number of remote input ports currently available on the target.
	InputPortCount int32 `json:"inputPortCount,omitempty"`
	// The number of remote output ports currently available on the target.
	OutputPortCount int32 `json:"outputPortCount,omitempty"`
	// The number of active remote input ports.
	ActiveRemoteInputPortCount int32 `json:"activeRemoteInputPortCount,omitempty"`
	// The number of inactive remote input ports.
	InactiveRemoteInputPortCount int32 `json:"inactiveRemoteInputPortCount,omitempty"`
	// The number of active remote output ports.
	ActiveRemoteOutputPortCount int32 `json:"activeRemoteOutputPortCount,omitempty"`
	// The number of inactive remote output ports.
	InactiveRemoteOutputPortCount int32 `json:"inactiveRemoteOutputPortCount,omitempty"`
	// The timestamp when this remote process group was last refreshed.
	FlowRefreshed string                        `json:"flowRefreshed,omitempty"`
	Contents      RemoteProcessGroupContentsDto `json:"contents,omitempty"`
}

RemoteProcessGroupDto struct for RemoteProcessGroupDto

type RemoteProcessGroupEntity ¶ 

type RemoteProcessGroupEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The URI for futures requests to the component.
	Uri         string         `json:"uri,omitempty"`
	Position    PositionDto    `json:"position,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
	// The bulletins for this component.
	Bulletins []BulletinEntity `json:"bulletins,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool                        `json:"disconnectedNodeAcknowledged,omitempty"`
	Component                    RemoteProcessGroupDto       `json:"component,omitempty"`
	Status                       RemoteProcessGroupStatusDto `json:"status,omitempty"`
	// The number of remote input ports currently available on the target.
	InputPortCount int32 `json:"inputPortCount,omitempty"`
	// The number of remote output ports currently available on the target.
	OutputPortCount    int32          `json:"outputPortCount,omitempty"`
	OperatePermissions PermissionsDto `json:"operatePermissions,omitempty"`
}

RemoteProcessGroupEntity struct for RemoteProcessGroupEntity

type RemoteProcessGroupPortDto ¶ 

type RemoteProcessGroupPortDto struct {
	// The id of the port.
	Id string `json:"id,omitempty"`
	// The id of the target port.
	TargetId string `json:"targetId,omitempty"`
	// The ID of the corresponding component that is under version control
	VersionedComponentId string `json:"versionedComponentId,omitempty"`
	// The id of the remote process group that the port resides in.
	GroupId string `json:"groupId,omitempty"`
	// The name of the target port.
	Name string `json:"name,omitempty"`
	// The comments as configured on the target port.
	Comments string `json:"comments,omitempty"`
	// The number of task that may transmit flowfiles to the target port concurrently.
	ConcurrentlySchedulableTaskCount int32 `json:"concurrentlySchedulableTaskCount,omitempty"`
	// Whether the remote port is configured for transmission.
	Transmitting bool `json:"transmitting,omitempty"`
	// Whether the flowfiles are compressed when sent to the target port.
	UseCompression bool `json:"useCompression,omitempty"`
	// Whether the target port exists.
	Exists bool `json:"exists,omitempty"`
	// Whether the target port is running.
	TargetRunning bool `json:"targetRunning,omitempty"`
	// Whether the port has either an incoming or outgoing connection.
	Connected     bool             `json:"connected,omitempty"`
	BatchSettings BatchSettingsDto `json:"batchSettings,omitempty"`
}

RemoteProcessGroupPortDto struct for RemoteProcessGroupPortDto

type RemoteProcessGroupPortEntity ¶ 

type RemoteProcessGroupPortEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The URI for futures requests to the component.
	Uri         string         `json:"uri,omitempty"`
	Position    PositionDto    `json:"position,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
	// The bulletins for this component.
	Bulletins []BulletinEntity `json:"bulletins,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool                      `json:"disconnectedNodeAcknowledged,omitempty"`
	RemoteProcessGroupPort       RemoteProcessGroupPortDto `json:"remoteProcessGroupPort,omitempty"`
	OperatePermissions           PermissionsDto            `json:"operatePermissions,omitempty"`
}

RemoteProcessGroupPortEntity struct for RemoteProcessGroupPortEntity

type RemoteProcessGroupStatusDto ¶ 

type RemoteProcessGroupStatusDto struct {
	// The unique ID of the process group that the Processor belongs to
	GroupId string `json:"groupId,omitempty"`
	// The unique ID of the Processor
	Id string `json:"id,omitempty"`
	// The name of the remote process group.
	Name string `json:"name,omitempty"`
	// The URI of the target system.
	TargetUri string `json:"targetUri,omitempty"`
	// The transmission status of the remote process group.
	TransmissionStatus string `json:"transmissionStatus,omitempty"`
	// The time the status for the process group was last refreshed.
	StatsLastRefreshed string `json:"statsLastRefreshed,omitempty"`
	// Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)
	ValidationStatus  string                              `json:"validationStatus,omitempty"`
	AggregateSnapshot RemoteProcessGroupStatusSnapshotDto `json:"aggregateSnapshot,omitempty"`
	// A status snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.
	NodeSnapshots []NodeRemoteProcessGroupStatusSnapshotDto `json:"nodeSnapshots,omitempty"`
}

RemoteProcessGroupStatusDto struct for RemoteProcessGroupStatusDto

type RemoteProcessGroupStatusEntity ¶ 

type RemoteProcessGroupStatusEntity struct {
	RemoteProcessGroupStatus RemoteProcessGroupStatusDto `json:"remoteProcessGroupStatus,omitempty"`
	// Indicates whether the user can read a given resource.
	CanRead bool `json:"canRead,omitempty"`
}

RemoteProcessGroupStatusEntity struct for RemoteProcessGroupStatusEntity

type RemoteProcessGroupStatusSnapshotDto ¶ 

type RemoteProcessGroupStatusSnapshotDto struct {
	// The id of the remote process group.
	Id string `json:"id,omitempty"`
	// The id of the parent process group the remote process group resides in.
	GroupId string `json:"groupId,omitempty"`
	// The name of the remote process group.
	Name string `json:"name,omitempty"`
	// The URI of the target system.
	TargetUri string `json:"targetUri,omitempty"`
	// The transmission status of the remote process group.
	TransmissionStatus string `json:"transmissionStatus,omitempty"`
	// The number of active threads for the remote process group.
	ActiveThreadCount int32 `json:"activeThreadCount,omitempty"`
	// The number of FlowFiles sent to the remote process group in the last 5 minutes.
	FlowFilesSent int32 `json:"flowFilesSent,omitempty"`
	// The size of the FlowFiles sent to the remote process group in the last 5 minutes.
	BytesSent int64 `json:"bytesSent,omitempty"`
	// The count/size of the flowfiles sent to the remote process group in the last 5 minutes.
	Sent string `json:"sent,omitempty"`
	// The number of FlowFiles received from the remote process group in the last 5 minutes.
	FlowFilesReceived int32 `json:"flowFilesReceived,omitempty"`
	// The size of the FlowFiles received from the remote process group in the last 5 minutes.
	BytesReceived int64 `json:"bytesReceived,omitempty"`
	// The count/size of the flowfiles received from the remote process group in the last 5 minutes.
	Received string `json:"received,omitempty"`
}

RemoteProcessGroupStatusSnapshotDto struct for RemoteProcessGroupStatusSnapshotDto

type RemoteProcessGroupStatusSnapshotEntity ¶ 

type RemoteProcessGroupStatusSnapshotEntity struct {
	// The id of the remote process group.
	Id                               string                              `json:"id,omitempty"`
	RemoteProcessGroupStatusSnapshot RemoteProcessGroupStatusSnapshotDto `json:"remoteProcessGroupStatusSnapshot,omitempty"`
	// Indicates whether the user can read a given resource.
	CanRead bool `json:"canRead,omitempty"`
}

RemoteProcessGroupStatusSnapshotEntity struct for RemoteProcessGroupStatusSnapshotEntity

type RemoteProcessGroupsApiRemoveRemoteProcessGroupOpts ¶ 

type RemoteProcessGroupsApiRemoveRemoteProcessGroupOpts struct {
	Version                      optional.String
	ClientId                     optional.String
	DisconnectedNodeAcknowledged optional.Bool
}

RemoteProcessGroupsApiRemoveRemoteProcessGroupOpts Optional parameters for the method 'RemoveRemoteProcessGroup'

type RemoteProcessGroupsApiService ¶ 

type RemoteProcessGroupsApiService service

RemoteProcessGroupsApiService RemoteProcessGroupsApi service

func (*RemoteProcessGroupsApiService) GetRemoteProcessGroup ¶ 

func (a *RemoteProcessGroupsApiService) GetRemoteProcessGroup(ctx _context.Context, id string) (RemoteProcessGroupEntity, *_nethttp.Response, error)

GetRemoteProcessGroup Gets a remote process group

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The remote process group id.

@return RemoteProcessGroupEntity

func (*RemoteProcessGroupsApiService) GetState ¶ 

func (a *RemoteProcessGroupsApiService) GetState(ctx _context.Context, id string) (ComponentStateEntity, *_nethttp.Response, error)

GetState Gets the state for a RemoteProcessGroup

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The processor id.

@return ComponentStateEntity

func (*RemoteProcessGroupsApiService) RemoveRemoteProcessGroup ¶ 

func (a *RemoteProcessGroupsApiService) RemoveRemoteProcessGroup(ctx _context.Context, id string, localVarOptionals *RemoteProcessGroupsApiRemoveRemoteProcessGroupOpts) (RemoteProcessGroupEntity, *_nethttp.Response, error)

RemoveRemoteProcessGroup Deletes a remote process group

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The remote process group id.
  • @param optional nil or *RemoteProcessGroupsApiRemoveRemoteProcessGroupOpts - Optional Parameters:
  • @param "Version" (optional.String) - The revision is used to verify the client is working with the latest version of the flow.
  • @param "ClientId" (optional.String) - If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

@return RemoteProcessGroupEntity

func (*RemoteProcessGroupsApiService) UpdateRemoteProcessGroup ¶ 

func (a *RemoteProcessGroupsApiService) UpdateRemoteProcessGroup(ctx _context.Context, id string, body RemoteProcessGroupEntity) (RemoteProcessGroupEntity, *_nethttp.Response, error)

UpdateRemoteProcessGroup Updates a remote process group

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The remote process group id.
  • @param body The remote process group.

@return RemoteProcessGroupEntity

func (*RemoteProcessGroupsApiService) UpdateRemoteProcessGroupInputPort ¶ 

func (a *RemoteProcessGroupsApiService) UpdateRemoteProcessGroupInputPort(ctx _context.Context, id string, portId string, body RemoteProcessGroupPortEntity) (RemoteProcessGroupPortEntity, *_nethttp.Response, error)

UpdateRemoteProcessGroupInputPort Updates a remote port Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The remote process group id.
  • @param portId The remote process group port id.
  • @param body The remote process group port.

@return RemoteProcessGroupPortEntity

func (*RemoteProcessGroupsApiService) UpdateRemoteProcessGroupInputPortRunStatus ¶ 

func (a *RemoteProcessGroupsApiService) UpdateRemoteProcessGroupInputPortRunStatus(ctx _context.Context, id string, portId string, body RemotePortRunStatusEntity) (RemoteProcessGroupPortEntity, *_nethttp.Response, error)

UpdateRemoteProcessGroupInputPortRunStatus Updates run status of a remote port Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The remote process group id.
  • @param portId The remote process group port id.
  • @param body The remote process group port.

@return RemoteProcessGroupPortEntity

func (*RemoteProcessGroupsApiService) UpdateRemoteProcessGroupOutputPort ¶ 

func (a *RemoteProcessGroupsApiService) UpdateRemoteProcessGroupOutputPort(ctx _context.Context, id string, portId string, body RemoteProcessGroupPortEntity) (RemoteProcessGroupPortEntity, *_nethttp.Response, error)

UpdateRemoteProcessGroupOutputPort Updates a remote port Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The remote process group id.
  • @param portId The remote process group port id.
  • @param body The remote process group port.

@return RemoteProcessGroupPortEntity

func (*RemoteProcessGroupsApiService) UpdateRemoteProcessGroupOutputPortRunStatus ¶ 

func (a *RemoteProcessGroupsApiService) UpdateRemoteProcessGroupOutputPortRunStatus(ctx _context.Context, id string, portId string, body RemotePortRunStatusEntity) (RemoteProcessGroupPortEntity, *_nethttp.Response, error)

UpdateRemoteProcessGroupOutputPortRunStatus Updates run status of a remote port Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The remote process group id.
  • @param portId The remote process group port id.
  • @param body The remote process group port.

@return RemoteProcessGroupPortEntity

func (*RemoteProcessGroupsApiService) UpdateRemoteProcessGroupRunStatus ¶ 

func (a *RemoteProcessGroupsApiService) UpdateRemoteProcessGroupRunStatus(ctx _context.Context, id string, body RemotePortRunStatusEntity) (RemoteProcessGroupEntity, *_nethttp.Response, error)

UpdateRemoteProcessGroupRunStatus Updates run status of a remote process group

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The remote process group id.
  • @param body The remote process group run status.

@return RemoteProcessGroupEntity

type RemoteProcessGroupsEntity ¶ 

type RemoteProcessGroupsEntity struct {
	RemoteProcessGroups []RemoteProcessGroupEntity `json:"remoteProcessGroups,omitempty"`
}

RemoteProcessGroupsEntity struct for RemoteProcessGroupsEntity

type ReportingTaskDto ¶ 

type ReportingTaskDto struct {
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The ID of the corresponding component that is under version control
	VersionedComponentId string `json:"versionedComponentId,omitempty"`
	// The id of parent process group of this component if applicable.
	ParentGroupId string      `json:"parentGroupId,omitempty"`
	Position      PositionDto `json:"position,omitempty"`
	// The name of the reporting task.
	Name string `json:"name,omitempty"`
	// The fully qualified type of the reporting task.
	Type   string    `json:"type,omitempty"`
	Bundle BundleDto `json:"bundle,omitempty"`
	// The state of the reporting task.
	State string `json:"state,omitempty"`
	// The comments of the reporting task.
	Comments string `json:"comments,omitempty"`
	// Whether the reporting task persists state.
	PersistsState bool `json:"persistsState,omitempty"`
	// Whether the reporting task requires elevated privileges.
	Restricted bool `json:"restricted,omitempty"`
	// Whether the reporting task has been deprecated.
	Deprecated bool `json:"deprecated,omitempty"`
	// Whether the reporting task has multiple versions available.
	MultipleVersionsAvailable bool `json:"multipleVersionsAvailable,omitempty"`
	// The frequency with which to schedule the reporting task. The format of the value willd epend on the valud of the schedulingStrategy.
	SchedulingPeriod string `json:"schedulingPeriod,omitempty"`
	// The scheduling strategy that determines how the schedulingPeriod value should be interpreted.
	SchedulingStrategy string `json:"schedulingStrategy,omitempty"`
	// The default scheduling period for the different scheduling strategies.
	DefaultSchedulingPeriod map[string]string `json:"defaultSchedulingPeriod,omitempty"`
	// The properties of the reporting task.
	Properties map[string]string `json:"properties,omitempty"`
	// The descriptors for the reporting tasks properties.
	Descriptors map[string]PropertyDescriptorDto `json:"descriptors,omitempty"`
	// The URL for the custom configuration UI for the reporting task.
	CustomUiUrl string `json:"customUiUrl,omitempty"`
	// The annotation data for the repoting task. This is how the custom UI relays configuration to the reporting task.
	AnnotationData string `json:"annotationData,omitempty"`
	// Gets the validation errors from the reporting task. These validation errors represent the problems with the reporting task that must be resolved before it can be scheduled to run.
	ValidationErrors []string `json:"validationErrors,omitempty"`
	// Indicates whether the Processor is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the Processor is valid)
	ValidationStatus string `json:"validationStatus,omitempty"`
	// The number of active threads for the reporting task.
	ActiveThreadCount int32 `json:"activeThreadCount,omitempty"`
	// Whether the underlying extension is missing.
	ExtensionMissing bool `json:"extensionMissing,omitempty"`
}

ReportingTaskDto struct for ReportingTaskDto

type ReportingTaskEntity ¶ 

type ReportingTaskEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The URI for futures requests to the component.
	Uri         string         `json:"uri,omitempty"`
	Position    PositionDto    `json:"position,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
	// The bulletins for this component.
	Bulletins []BulletinEntity `json:"bulletins,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool                   `json:"disconnectedNodeAcknowledged,omitempty"`
	Component                    ReportingTaskDto       `json:"component,omitempty"`
	OperatePermissions           PermissionsDto         `json:"operatePermissions,omitempty"`
	Status                       ReportingTaskStatusDto `json:"status,omitempty"`
}

ReportingTaskEntity struct for ReportingTaskEntity

type ReportingTaskRunStatusEntity ¶ 

type ReportingTaskRunStatusEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The run status of the ReportingTask.
	State string `json:"state,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool `json:"disconnectedNodeAcknowledged,omitempty"`
}

ReportingTaskRunStatusEntity struct for ReportingTaskRunStatusEntity

type ReportingTaskStatusDto ¶ 

type ReportingTaskStatusDto struct {
	// The run status of this ReportingTask
	RunStatus string `json:"runStatus,omitempty"`
	// Indicates whether the component is valid, invalid, or still in the process of validating (i.e., it is unknown whether or not the component is valid)
	ValidationStatus string `json:"validationStatus,omitempty"`
	// The number of active threads for the component.
	ActiveThreadCount int32 `json:"activeThreadCount,omitempty"`
}

ReportingTaskStatusDto struct for ReportingTaskStatusDto

type ReportingTaskTypesEntity ¶ 

type ReportingTaskTypesEntity struct {
	ReportingTaskTypes []DocumentedTypeDto `json:"reportingTaskTypes,omitempty"`
}

ReportingTaskTypesEntity struct for ReportingTaskTypesEntity

type ReportingTasksApiRemoveReportingTaskOpts ¶ 

type ReportingTasksApiRemoveReportingTaskOpts struct {
	Version                      optional.String
	ClientId                     optional.String
	DisconnectedNodeAcknowledged optional.Bool
}

ReportingTasksApiRemoveReportingTaskOpts Optional parameters for the method 'RemoveReportingTask'

type ReportingTasksApiService ¶ 

type ReportingTasksApiService service

ReportingTasksApiService ReportingTasksApi service

func (*ReportingTasksApiService) ClearState ¶ 

func (a *ReportingTasksApiService) ClearState(ctx _context.Context, id string) (ComponentStateEntity, *_nethttp.Response, error)

ClearState Clears the state for a reporting task

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The reporting task id.

@return ComponentStateEntity

func (*ReportingTasksApiService) GetPropertyDescriptor ¶ 

func (a *ReportingTasksApiService) GetPropertyDescriptor(ctx _context.Context, id string, propertyName string) (PropertyDescriptorEntity, *_nethttp.Response, error)

GetPropertyDescriptor Gets a reporting task property descriptor

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The reporting task id.
  • @param propertyName The property name.

@return PropertyDescriptorEntity

func (*ReportingTasksApiService) GetReportingTask ¶ 

func (a *ReportingTasksApiService) GetReportingTask(ctx _context.Context, id string) (ReportingTaskEntity, *_nethttp.Response, error)

GetReportingTask Gets a reporting task

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The reporting task id.

@return ReportingTaskEntity

func (*ReportingTasksApiService) GetState ¶ 

func (a *ReportingTasksApiService) GetState(ctx _context.Context, id string) (ComponentStateEntity, *_nethttp.Response, error)

GetState Gets the state for a reporting task

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The reporting task id.

@return ComponentStateEntity

func (*ReportingTasksApiService) RemoveReportingTask ¶ 

func (a *ReportingTasksApiService) RemoveReportingTask(ctx _context.Context, id string, localVarOptionals *ReportingTasksApiRemoveReportingTaskOpts) (ReportingTaskEntity, *_nethttp.Response, error)

RemoveReportingTask Deletes a reporting task

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The reporting task id.
  • @param optional nil or *ReportingTasksApiRemoveReportingTaskOpts - Optional Parameters:
  • @param "Version" (optional.String) - The revision is used to verify the client is working with the latest version of the flow.
  • @param "ClientId" (optional.String) - If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

@return ReportingTaskEntity

func (*ReportingTasksApiService) UpdateReportingTask ¶ 

func (a *ReportingTasksApiService) UpdateReportingTask(ctx _context.Context, id string, body ReportingTaskEntity) (ReportingTaskEntity, *_nethttp.Response, error)

UpdateReportingTask Updates a reporting task

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The reporting task id.
  • @param body The reporting task configuration details.

@return ReportingTaskEntity

func (*ReportingTasksApiService) UpdateRunStatus ¶ 

func (a *ReportingTasksApiService) UpdateRunStatus(ctx _context.Context, id string, body ReportingTaskRunStatusEntity) (ReportingTaskEntity, *_nethttp.Response, error)

UpdateRunStatus Updates run status of a reporting task

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The reporting task id.
  • @param body The reporting task run status.

@return ReportingTaskEntity

type ReportingTasksEntity ¶ 

type ReportingTasksEntity struct {
	ReportingTasks []ReportingTaskEntity `json:"reportingTasks,omitempty"`
}

ReportingTasksEntity struct for ReportingTasksEntity

type RequiredPermissionDto ¶ 

type RequiredPermissionDto struct {
	// The required sub-permission necessary for this restriction.
	Id string `json:"id,omitempty"`
	// The label for the required sub-permission necessary for this restriction.
	Label string `json:"label,omitempty"`
}

RequiredPermissionDto struct for RequiredPermissionDto

type ResourceDto ¶ 

type ResourceDto struct {
	// The identifier of the resource.
	Identifier string `json:"identifier,omitempty"`
	// The name of the resource.
	Name string `json:"name,omitempty"`
}

ResourceDto struct for ResourceDto

type ResourcesApiService ¶ 

type ResourcesApiService service

ResourcesApiService ResourcesApi service

func (*ResourcesApiService) GetResources ¶ 

func (a *ResourcesApiService) GetResources(ctx _context.Context) (ResourcesEntity, *_nethttp.Response, error)

GetResources Gets the available resources that support access/authorization policies

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ResourcesEntity

type ResourcesEntity ¶ 

type ResourcesEntity struct {
	Resources []ResourceDto `json:"resources,omitempty"`
}

ResourcesEntity struct for ResourcesEntity

type RevisionDto ¶ 

type RevisionDto struct {
	// A client identifier used to make a request. By including a client identifier, the API can allow multiple requests without needing the current revision. Due to the asynchronous nature of requests/responses this was implemented to allow the client to make numerous requests without having to wait for the previous response to come back
	ClientId string `json:"clientId,omitempty"`
	// NiFi employs an optimistic locking strategy where the client must include a revision in their request when performing an update. In a response to a mutable flow request, this field represents the updated base version.
	Version int64 `json:"version,omitempty"`
	// The user that last modified the flow.
	LastModifier string `json:"lastModifier,omitempty"`
}

RevisionDto struct for RevisionDto

type RunStatusDetailsRequestEntity ¶ 

type RunStatusDetailsRequestEntity struct {
	// The IDs of all processors whose run status details should be provided
	ProcessorIds []string `json:"processorIds,omitempty"`
}

RunStatusDetailsRequestEntity struct for RunStatusDetailsRequestEntity

type ScheduleComponentsEntity ¶ 

type ScheduleComponentsEntity struct {
	// The id of the ProcessGroup
	Id string `json:"id,omitempty"`
	// The desired state of the descendant components
	State string `json:"state,omitempty"`
	// Optional components to schedule. If not specified, all authorized descendant components will be used.
	Components map[string]RevisionDto `json:"components,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool `json:"disconnectedNodeAcknowledged,omitempty"`
}

ScheduleComponentsEntity struct for ScheduleComponentsEntity

type SearchResultGroupDto ¶ 

type SearchResultGroupDto struct {
	// The id of the group.
	Id string `json:"id"`
	// The name of the group.
	Name string `json:"name,omitempty"`
}

SearchResultGroupDto struct for SearchResultGroupDto

type SearchResultsDto ¶ 

type SearchResultsDto struct {
	// The processors that matched the search.
	ProcessorResults []ComponentSearchResultDto `json:"processorResults,omitempty"`
	// The connections that matched the search.
	ConnectionResults []ComponentSearchResultDto `json:"connectionResults,omitempty"`
	// The process groups that matched the search.
	ProcessGroupResults []ComponentSearchResultDto `json:"processGroupResults,omitempty"`
	// The input ports that matched the search.
	InputPortResults []ComponentSearchResultDto `json:"inputPortResults,omitempty"`
	// The output ports that matched the search.
	OutputPortResults []ComponentSearchResultDto `json:"outputPortResults,omitempty"`
	// The remote process groups that matched the search.
	RemoteProcessGroupResults []ComponentSearchResultDto `json:"remoteProcessGroupResults,omitempty"`
	// The funnels that matched the search.
	FunnelResults []ComponentSearchResultDto `json:"funnelResults,omitempty"`
	// The labels that matched the search.
	LabelResults []ComponentSearchResultDto `json:"labelResults,omitempty"`
	// The controller service nodes that matched the search
	ControllerServiceNodeResults []ComponentSearchResultDto `json:"controllerServiceNodeResults,omitempty"`
	// The parameter contexts that matched the search.
	ParameterContextResults []ComponentSearchResultDto `json:"parameterContextResults,omitempty"`
	// The parameters that matched the search.
	ParameterResults []ComponentSearchResultDto `json:"parameterResults,omitempty"`
}

SearchResultsDto struct for SearchResultsDto

type SearchResultsEntity ¶ 

type SearchResultsEntity struct {
	SearchResultsDTO SearchResultsDto `json:"searchResultsDTO,omitempty"`
}

SearchResultsEntity struct for SearchResultsEntity

type ServerConfiguration ¶ 

type ServerConfiguration struct {
	Url         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerVariable ¶ 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type SiteToSiteApiService ¶ 

type SiteToSiteApiService service

SiteToSiteApiService SiteToSiteApi service

func (*SiteToSiteApiService) GetPeers ¶ 

func (a *SiteToSiteApiService) GetPeers(ctx _context.Context) (PeersEntity, *_nethttp.Response, error)

GetPeers Returns the available Peers and its status of this NiFi

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return PeersEntity

func (*SiteToSiteApiService) GetSiteToSiteDetails ¶ 

func (a *SiteToSiteApiService) GetSiteToSiteDetails(ctx _context.Context) (ControllerEntity, *_nethttp.Response, error)

GetSiteToSiteDetails Returns the details about this NiFi necessary to communicate via site to site

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ControllerEntity

type SnippetDto ¶ 

type SnippetDto struct {
	// The id of the snippet.
	Id string `json:"id,omitempty"`
	// The URI of the snippet.
	Uri string `json:"uri,omitempty"`
	// The group id for the components in the snippet.
	ParentGroupId string `json:"parentGroupId,omitempty"`
	// The ids of the process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).
	ProcessGroups map[string]RevisionDto `json:"processGroups,omitempty"`
	// The ids of the remote process groups in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).
	RemoteProcessGroups map[string]RevisionDto `json:"remoteProcessGroups,omitempty"`
	// The ids of the processors in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).
	Processors map[string]RevisionDto `json:"processors,omitempty"`
	// The ids of the input ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).
	InputPorts map[string]RevisionDto `json:"inputPorts,omitempty"`
	// The ids of the output ports in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).
	OutputPorts map[string]RevisionDto `json:"outputPorts,omitempty"`
	// The ids of the connections in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).
	Connections map[string]RevisionDto `json:"connections,omitempty"`
	// The ids of the labels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).
	Labels map[string]RevisionDto `json:"labels,omitempty"`
	// The ids of the funnels in this snippet. These ids will be populated within each response. They can be specified when creating a snippet. However, once a snippet has been created its contents cannot be modified (these ids are ignored during update requests).
	Funnels map[string]RevisionDto `json:"funnels,omitempty"`
}

SnippetDto struct for SnippetDto

type SnippetEntity ¶ 

type SnippetEntity struct {
	Snippet SnippetDto `json:"snippet,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool `json:"disconnectedNodeAcknowledged,omitempty"`
}

SnippetEntity struct for SnippetEntity

type SnippetsApiDeleteSnippetOpts ¶ 

type SnippetsApiDeleteSnippetOpts struct {
	DisconnectedNodeAcknowledged optional.Bool
}

SnippetsApiDeleteSnippetOpts Optional parameters for the method 'DeleteSnippet'

type SnippetsApiService ¶ 

type SnippetsApiService service

SnippetsApiService SnippetsApi service

func (*SnippetsApiService) CreateSnippet ¶ 

func (a *SnippetsApiService) CreateSnippet(ctx _context.Context, body SnippetEntity) (SnippetEntity, *_nethttp.Response, error)

CreateSnippet Creates a snippet. The snippet will be automatically discarded if not used in a subsequent request after 1 minute.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The snippet configuration details.

@return SnippetEntity

func (*SnippetsApiService) DeleteSnippet ¶ 

func (a *SnippetsApiService) DeleteSnippet(ctx _context.Context, id string, localVarOptionals *SnippetsApiDeleteSnippetOpts) (SnippetEntity, *_nethttp.Response, error)

DeleteSnippet Deletes the components in a snippet and discards the snippet

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The snippet id.
  • @param optional nil or *SnippetsApiDeleteSnippetOpts - Optional Parameters:
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

@return SnippetEntity

func (*SnippetsApiService) UpdateSnippet ¶ 

func (a *SnippetsApiService) UpdateSnippet(ctx _context.Context, id string, body SnippetEntity) (SnippetEntity, *_nethttp.Response, error)

UpdateSnippet Move's the components in this Snippet into a new Process Group and discards the snippet

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The snippet id.
  • @param body The snippet configuration details.

@return SnippetEntity

type StartVersionControlRequestEntity ¶ 

type StartVersionControlRequestEntity struct {
	VersionedFlow        VersionedFlowDto `json:"versionedFlow,omitempty"`
	ProcessGroupRevision RevisionDto      `json:"processGroupRevision,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool `json:"disconnectedNodeAcknowledged,omitempty"`
}

StartVersionControlRequestEntity struct for StartVersionControlRequestEntity

type StateEntryDto ¶ 

type StateEntryDto struct {
	// The key for this state.
	Key string `json:"key,omitempty"`
	// The value for this state.
	Value string `json:"value,omitempty"`
	// The identifier for the node where the state originated.
	ClusterNodeId string `json:"clusterNodeId,omitempty"`
	// The label for the node where the state originated.
	ClusterNodeAddress string `json:"clusterNodeAddress,omitempty"`
}

StateEntryDto struct for StateEntryDto

type StateMapDto ¶ 

type StateMapDto struct {
	// The scope of this StateMap.
	Scope string `json:"scope,omitempty"`
	// The total number of state entries. When the state map is lengthy, only of portion of the entries are returned.
	TotalEntryCount int32 `json:"totalEntryCount,omitempty"`
	// The state.
	State []StateEntryDto `json:"state,omitempty"`
}

StateMapDto struct for StateMapDto

type StatusDescriptorDto ¶ 

type StatusDescriptorDto struct {
	// The name of the status field.
	Field string `json:"field,omitempty"`
	// The label for the status field.
	Label string `json:"label,omitempty"`
	// The description of the status field.
	Description string `json:"description,omitempty"`
	// The formatter for the status descriptor.
	Formatter string `json:"formatter,omitempty"`
}

StatusDescriptorDto struct for StatusDescriptorDto

type StatusHistoryDto ¶ 

type StatusHistoryDto struct {
	// When the status history was generated.
	Generated string `json:"generated,omitempty"`
	// A Map of key/value pairs that describe the component that the status history belongs to
	ComponentDetails map[string]string `json:"componentDetails,omitempty"`
	// The Descriptors that provide information on each of the metrics provided in the status history
	FieldDescriptors []StatusDescriptorDto `json:"fieldDescriptors,omitempty"`
	// A list of StatusSnapshotDTO objects that provide the actual metric values for the component. If the NiFi instance is clustered, this will represent the aggregate status across all nodes. If the NiFi instance is not clustered, this will represent the status of the entire NiFi instance.
	AggregateSnapshots []StatusSnapshotDto `json:"aggregateSnapshots,omitempty"`
	// The NodeStatusSnapshotsDTO objects that provide the actual metric values for the component, for each node. If the NiFi instance is not clustered, this value will be null.
	NodeSnapshots []NodeStatusSnapshotsDto `json:"nodeSnapshots,omitempty"`
}

StatusHistoryDto struct for StatusHistoryDto

type StatusHistoryEntity ¶ 

type StatusHistoryEntity struct {
	StatusHistory StatusHistoryDto `json:"statusHistory,omitempty"`
	// Indicates whether the user can read a given resource.
	CanRead bool `json:"canRead,omitempty"`
}

StatusHistoryEntity struct for StatusHistoryEntity

type StatusSnapshotDto ¶ 

type StatusSnapshotDto struct {
	// The timestamp of the snapshot.
	Timestamp time.Time `json:"timestamp,omitempty"`
	// The status metrics.
	StatusMetrics map[string]int64 `json:"statusMetrics,omitempty"`
}

StatusSnapshotDto struct for StatusSnapshotDto

type StorageUsageDto ¶ 

type StorageUsageDto struct {
	// The identifier of this storage location. The identifier will correspond to the identifier keyed in the storage configuration.
	Identifier string `json:"identifier,omitempty"`
	// Amount of free space.
	FreeSpace string `json:"freeSpace,omitempty"`
	// Amount of total space.
	TotalSpace string `json:"totalSpace,omitempty"`
	// Amount of used space.
	UsedSpace string `json:"usedSpace,omitempty"`
	// The number of bytes of free space.
	FreeSpaceBytes int64 `json:"freeSpaceBytes,omitempty"`
	// The number of bytes of total space.
	TotalSpaceBytes int64 `json:"totalSpaceBytes,omitempty"`
	// The number of bytes of used space.
	UsedSpaceBytes int64 `json:"usedSpaceBytes,omitempty"`
	// Utilization of this storage location.
	Utilization string `json:"utilization,omitempty"`
}

StorageUsageDto struct for StorageUsageDto

type SubmitReplayRequestEntity ¶ 

type SubmitReplayRequestEntity struct {
	// The event identifier
	EventId int64 `json:"eventId,omitempty"`
	// The identifier of the node where to submit the replay request.
	ClusterNodeId string `json:"clusterNodeId,omitempty"`
}

SubmitReplayRequestEntity struct for SubmitReplayRequestEntity

type SystemDiagnosticsApiGetSystemDiagnosticsOpts ¶ 

type SystemDiagnosticsApiGetSystemDiagnosticsOpts struct {
	Nodewise      optional.Bool
	ClusterNodeId optional.String
}

SystemDiagnosticsApiGetSystemDiagnosticsOpts Optional parameters for the method 'GetSystemDiagnostics'

type SystemDiagnosticsApiService ¶ 

type SystemDiagnosticsApiService service

SystemDiagnosticsApiService SystemDiagnosticsApi service

func (*SystemDiagnosticsApiService) GetSystemDiagnostics ¶ 

func (a *SystemDiagnosticsApiService) GetSystemDiagnostics(ctx _context.Context, localVarOptionals *SystemDiagnosticsApiGetSystemDiagnosticsOpts) (SystemDiagnosticsEntity, *_nethttp.Response, error)

GetSystemDiagnostics Gets the diagnostics for the system NiFi is running on

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *SystemDiagnosticsApiGetSystemDiagnosticsOpts - Optional Parameters:
  • @param "Nodewise" (optional.Bool) - Whether or not to include the breakdown per node. Optional, defaults to false
  • @param "ClusterNodeId" (optional.String) - The id of the node where to get the status.

@return SystemDiagnosticsEntity

type SystemDiagnosticsDto ¶ 

type SystemDiagnosticsDto struct {
	AggregateSnapshot SystemDiagnosticsSnapshotDto `json:"aggregateSnapshot,omitempty"`
	// A systems diagnostics snapshot for each node in the cluster. If the NiFi instance is a standalone instance, rather than a cluster, this may be null.
	NodeSnapshots []NodeSystemDiagnosticsSnapshotDto `json:"nodeSnapshots,omitempty"`
}

SystemDiagnosticsDto struct for SystemDiagnosticsDto

type SystemDiagnosticsEntity ¶ 

type SystemDiagnosticsEntity struct {
	SystemDiagnostics SystemDiagnosticsDto `json:"systemDiagnostics,omitempty"`
}

SystemDiagnosticsEntity struct for SystemDiagnosticsEntity

type SystemDiagnosticsSnapshotDto ¶ 

type SystemDiagnosticsSnapshotDto struct {
	// Total size of non heap.
	TotalNonHeap string `json:"totalNonHeap,omitempty"`
	// Total number of bytes allocated to the JVM not used for heap
	TotalNonHeapBytes int64 `json:"totalNonHeapBytes,omitempty"`
	// Amount of use non heap.
	UsedNonHeap string `json:"usedNonHeap,omitempty"`
	// Total number of bytes used by the JVM not in the heap space
	UsedNonHeapBytes int64 `json:"usedNonHeapBytes,omitempty"`
	// Amount of free non heap.
	FreeNonHeap string `json:"freeNonHeap,omitempty"`
	// Total number of free non-heap bytes available to the JVM
	FreeNonHeapBytes int64 `json:"freeNonHeapBytes,omitempty"`
	// Maximum size of non heap.
	MaxNonHeap string `json:"maxNonHeap,omitempty"`
	// The maximum number of bytes that the JVM can use for non-heap purposes
	MaxNonHeapBytes int64 `json:"maxNonHeapBytes,omitempty"`
	// Utilization of non heap.
	NonHeapUtilization string `json:"nonHeapUtilization,omitempty"`
	// Total size of heap.
	TotalHeap string `json:"totalHeap,omitempty"`
	// The total number of bytes that are available for the JVM heap to use
	TotalHeapBytes int64 `json:"totalHeapBytes,omitempty"`
	// Amount of used heap.
	UsedHeap string `json:"usedHeap,omitempty"`
	// The number of bytes of JVM heap that are currently being used
	UsedHeapBytes int64 `json:"usedHeapBytes,omitempty"`
	// Amount of free heap.
	FreeHeap string `json:"freeHeap,omitempty"`
	// The number of bytes that are allocated to the JVM heap but not currently being used
	FreeHeapBytes int64 `json:"freeHeapBytes,omitempty"`
	// Maximum size of heap.
	MaxHeap string `json:"maxHeap,omitempty"`
	// The maximum number of bytes that can be used by the JVM
	MaxHeapBytes int64 `json:"maxHeapBytes,omitempty"`
	// Utilization of heap.
	HeapUtilization string `json:"heapUtilization,omitempty"`
	// Number of available processors if supported by the underlying system.
	AvailableProcessors int32 `json:"availableProcessors,omitempty"`
	// The processor load average if supported by the underlying system.
	ProcessorLoadAverage float64 `json:"processorLoadAverage,omitempty"`
	// Total number of threads.
	TotalThreads int32 `json:"totalThreads,omitempty"`
	// Number of daemon threads.
	DaemonThreads int32 `json:"daemonThreads,omitempty"`
	// The uptime of the Java virtual machine
	Uptime                         string          `json:"uptime,omitempty"`
	FlowFileRepositoryStorageUsage StorageUsageDto `json:"flowFileRepositoryStorageUsage,omitempty"`
	// The content repository storage usage.
	ContentRepositoryStorageUsage []StorageUsageDto `json:"contentRepositoryStorageUsage,omitempty"`
	// The provenance repository storage usage.
	ProvenanceRepositoryStorageUsage []StorageUsageDto `json:"provenanceRepositoryStorageUsage,omitempty"`
	// The garbage collection details.
	GarbageCollection []GarbageCollectionDto `json:"garbageCollection,omitempty"`
	// When the diagnostics were generated.
	StatsLastRefreshed string         `json:"statsLastRefreshed,omitempty"`
	VersionInfo        VersionInfoDto `json:"versionInfo,omitempty"`
}

SystemDiagnosticsSnapshotDto struct for SystemDiagnosticsSnapshotDto

type TemplateDto ¶ 

type TemplateDto struct {
	// The URI for the template.
	Uri string `json:"uri,omitempty"`
	// The id of the template.
	Id string `json:"id,omitempty"`
	// The id of the Process Group that the template belongs to.
	GroupId string `json:"groupId,omitempty"`
	// The name of the template.
	Name string `json:"name,omitempty"`
	// The description of the template.
	Description string `json:"description,omitempty"`
	// The timestamp when this template was created.
	Timestamp string `json:"timestamp,omitempty"`
	// The encoding version of this template.
	EncodingVersion string         `json:"encodingVersion,omitempty"`
	Snippet         FlowSnippetDto `json:"snippet,omitempty"`
}

TemplateDto struct for TemplateDto

type TemplateEntity ¶ 

type TemplateEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The URI for futures requests to the component.
	Uri         string         `json:"uri,omitempty"`
	Position    PositionDto    `json:"position,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
	// The bulletins for this component.
	Bulletins []BulletinEntity `json:"bulletins,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool        `json:"disconnectedNodeAcknowledged,omitempty"`
	Template                     TemplateDto `json:"template,omitempty"`
}

TemplateEntity struct for TemplateEntity

type TemplatesApiRemoveTemplateOpts ¶ 

type TemplatesApiRemoveTemplateOpts struct {
	DisconnectedNodeAcknowledged optional.Bool
}

TemplatesApiRemoveTemplateOpts Optional parameters for the method 'RemoveTemplate'

type TemplatesApiService ¶ 

type TemplatesApiService service

TemplatesApiService TemplatesApi service

func (*TemplatesApiService) ExportTemplate ¶ 

func (a *TemplatesApiService) ExportTemplate(ctx _context.Context, id string) (string, *_nethttp.Response, error)

ExportTemplate Exports a template

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The template id.

@return string

func (*TemplatesApiService) RemoveTemplate ¶ 

func (a *TemplatesApiService) RemoveTemplate(ctx _context.Context, id string, localVarOptionals *TemplatesApiRemoveTemplateOpts) (TemplateEntity, *_nethttp.Response, error)

RemoveTemplate Deletes a template

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The template id.
  • @param optional nil or *TemplatesApiRemoveTemplateOpts - Optional Parameters:
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

@return TemplateEntity

type TemplatesEntity ¶ 

type TemplatesEntity struct {
	Templates []TemplateEntity `json:"templates,omitempty"`
	// When this content was generated.
	Generated string `json:"generated,omitempty"`
}

TemplatesEntity struct for TemplatesEntity

type TenantDto ¶ 

type TenantDto struct {
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The ID of the corresponding component that is under version control
	VersionedComponentId string `json:"versionedComponentId,omitempty"`
	// The id of parent process group of this component if applicable.
	ParentGroupId string      `json:"parentGroupId,omitempty"`
	Position      PositionDto `json:"position,omitempty"`
	// The identity of the tenant.
	Identity string `json:"identity,omitempty"`
	// Whether this tenant is configurable.
	Configurable bool `json:"configurable,omitempty"`
}

TenantDto struct for TenantDto

type TenantEntity ¶ 

type TenantEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The URI for futures requests to the component.
	Uri         string         `json:"uri,omitempty"`
	Position    PositionDto    `json:"position,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
	// The bulletins for this component.
	Bulletins []BulletinEntity `json:"bulletins,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool      `json:"disconnectedNodeAcknowledged,omitempty"`
	Component                    TenantDto `json:"component,omitempty"`
}

TenantEntity struct for TenantEntity

type TenantsApiRemoveUserGroupOpts ¶ 

type TenantsApiRemoveUserGroupOpts struct {
	Version                      optional.String
	ClientId                     optional.String
	DisconnectedNodeAcknowledged optional.Bool
}

TenantsApiRemoveUserGroupOpts Optional parameters for the method 'RemoveUserGroup'

type TenantsApiRemoveUserOpts ¶ 

type TenantsApiRemoveUserOpts struct {
	Version                      optional.String
	ClientId                     optional.String
	DisconnectedNodeAcknowledged optional.Bool
}

TenantsApiRemoveUserOpts Optional parameters for the method 'RemoveUser'

type TenantsApiService ¶ 

type TenantsApiService service

TenantsApiService TenantsApi service

func (*TenantsApiService) CreateUser ¶ 

func (a *TenantsApiService) CreateUser(ctx _context.Context, body UserEntity) (UserEntity, *_nethttp.Response, error)

CreateUser Creates a user Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The user configuration details.

@return UserEntity

func (*TenantsApiService) CreateUserGroup ¶ 

func (a *TenantsApiService) CreateUserGroup(ctx _context.Context, body UserGroupEntity) (UserGroupEntity, *_nethttp.Response, error)

CreateUserGroup Creates a user group Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The user group configuration details.

@return UserGroupEntity

func (*TenantsApiService) GetUser ¶ 

func (a *TenantsApiService) GetUser(ctx _context.Context, id string) (UserEntity, *_nethttp.Response, error)

GetUser Gets a user Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The user id.

@return UserEntity

func (*TenantsApiService) GetUserGroup ¶ 

func (a *TenantsApiService) GetUserGroup(ctx _context.Context, id string) (UserGroupEntity, *_nethttp.Response, error)

GetUserGroup Gets a user group Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The user group id.

@return UserGroupEntity

func (*TenantsApiService) GetUserGroups ¶ 

func (a *TenantsApiService) GetUserGroups(ctx _context.Context) (UserGroupsEntity, *_nethttp.Response, error)

GetUserGroups Gets all user groups Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return UserGroupsEntity

func (*TenantsApiService) GetUsers ¶ 

func (a *TenantsApiService) GetUsers(ctx _context.Context) (UsersEntity, *_nethttp.Response, error)

GetUsers Gets all users Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return UsersEntity

func (*TenantsApiService) RemoveUser ¶ 

func (a *TenantsApiService) RemoveUser(ctx _context.Context, id string, localVarOptionals *TenantsApiRemoveUserOpts) (UserEntity, *_nethttp.Response, error)

RemoveUser Deletes a user Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The user id.
  • @param optional nil or *TenantsApiRemoveUserOpts - Optional Parameters:
  • @param "Version" (optional.String) - The revision is used to verify the client is working with the latest version of the flow.
  • @param "ClientId" (optional.String) - If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

@return UserEntity

func (*TenantsApiService) RemoveUserGroup ¶ 

func (a *TenantsApiService) RemoveUserGroup(ctx _context.Context, id string, localVarOptionals *TenantsApiRemoveUserGroupOpts) (UserGroupEntity, *_nethttp.Response, error)

RemoveUserGroup Deletes a user group Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The user group id.
  • @param optional nil or *TenantsApiRemoveUserGroupOpts - Optional Parameters:
  • @param "Version" (optional.String) - The revision is used to verify the client is working with the latest version of the flow.
  • @param "ClientId" (optional.String) - If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

@return UserGroupEntity

func (*TenantsApiService) SearchTenants ¶ 

func (a *TenantsApiService) SearchTenants(ctx _context.Context, q string) (TenantsEntity, *_nethttp.Response, error)

SearchTenants Searches for a tenant with the specified identity Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param q Identity to search for.

@return TenantsEntity

func (*TenantsApiService) UpdateUser ¶ 

func (a *TenantsApiService) UpdateUser(ctx _context.Context, id string, body UserEntity) (UserEntity, *_nethttp.Response, error)

UpdateUser Updates a user Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The user id.
  • @param body The user configuration details.

@return UserEntity

func (*TenantsApiService) UpdateUserGroup ¶ 

func (a *TenantsApiService) UpdateUserGroup(ctx _context.Context, id string, body UserGroupEntity) (UserGroupEntity, *_nethttp.Response, error)

UpdateUserGroup Updates a user group Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The user group id.
  • @param body The user group configuration details.

@return UserGroupEntity

type TenantsEntity ¶ 

type TenantsEntity struct {
	Users      []TenantEntity `json:"users,omitempty"`
	UserGroups []TenantEntity `json:"userGroups,omitempty"`
}

TenantsEntity struct for TenantsEntity

type TransactionResultEntity ¶ 

type TransactionResultEntity struct {
	FlowFileSent int32  `json:"flowFileSent,omitempty"`
	ResponseCode int32  `json:"responseCode,omitempty"`
	Message      string `json:"message,omitempty"`
}

TransactionResultEntity struct for TransactionResultEntity

type UpdateControllerServiceReferenceRequestEntity ¶ 

type UpdateControllerServiceReferenceRequestEntity struct {
	// The identifier of the Controller Service.
	Id string `json:"id,omitempty"`
	// The new state of the references for the controller service.
	State string `json:"state,omitempty"`
	// The revisions for all referencing components.
	ReferencingComponentRevisions map[string]RevisionDto `json:"referencingComponentRevisions,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool `json:"disconnectedNodeAcknowledged,omitempty"`
}

UpdateControllerServiceReferenceRequestEntity struct for UpdateControllerServiceReferenceRequestEntity

type UserDto ¶ 

type UserDto struct {
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The ID of the corresponding component that is under version control
	VersionedComponentId string `json:"versionedComponentId,omitempty"`
	// The id of parent process group of this component if applicable.
	ParentGroupId string      `json:"parentGroupId,omitempty"`
	Position      PositionDto `json:"position,omitempty"`
	// The identity of the tenant.
	Identity string `json:"identity,omitempty"`
	// Whether this tenant is configurable.
	Configurable bool `json:"configurable,omitempty"`
	// The groups to which the user belongs. This field is read only and it provided for convenience.
	UserGroups []TenantEntity `json:"userGroups,omitempty"`
	// The access policies this user belongs to.
	AccessPolicies []AccessPolicySummaryEntity `json:"accessPolicies,omitempty"`
}

UserDto struct for UserDto

type UserEntity ¶ 

type UserEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The URI for futures requests to the component.
	Uri         string         `json:"uri,omitempty"`
	Position    PositionDto    `json:"position,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
	// The bulletins for this component.
	Bulletins []BulletinEntity `json:"bulletins,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool    `json:"disconnectedNodeAcknowledged,omitempty"`
	Component                    UserDto `json:"component,omitempty"`
}

UserEntity struct for UserEntity

type UserGroupDto ¶ 

type UserGroupDto struct {
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The ID of the corresponding component that is under version control
	VersionedComponentId string `json:"versionedComponentId,omitempty"`
	// The id of parent process group of this component if applicable.
	ParentGroupId string      `json:"parentGroupId,omitempty"`
	Position      PositionDto `json:"position,omitempty"`
	// The identity of the tenant.
	Identity string `json:"identity,omitempty"`
	// Whether this tenant is configurable.
	Configurable bool `json:"configurable,omitempty"`
	// The users that belong to the user group.
	Users []TenantEntity `json:"users,omitempty"`
	// The access policies this user group belongs to. This field was incorrectly defined as an AccessPolicyEntity. For compatibility reasons the field will remain of this type, however only the fields that are present in the AccessPolicySummaryEntity will be populated here.
	AccessPolicies []AccessPolicyEntity `json:"accessPolicies,omitempty"`
}

UserGroupDto struct for UserGroupDto

type UserGroupEntity ¶ 

type UserGroupEntity struct {
	Revision RevisionDto `json:"revision,omitempty"`
	// The id of the component.
	Id string `json:"id,omitempty"`
	// The URI for futures requests to the component.
	Uri         string         `json:"uri,omitempty"`
	Position    PositionDto    `json:"position,omitempty"`
	Permissions PermissionsDto `json:"permissions,omitempty"`
	// The bulletins for this component.
	Bulletins []BulletinEntity `json:"bulletins,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool         `json:"disconnectedNodeAcknowledged,omitempty"`
	Component                    UserGroupDto `json:"component,omitempty"`
}

UserGroupEntity struct for UserGroupEntity

type UserGroupsEntity ¶ 

type UserGroupsEntity struct {
	UserGroups []UserGroupEntity `json:"userGroups,omitempty"`
}

UserGroupsEntity struct for UserGroupsEntity

type UsersEntity ¶ 

type UsersEntity struct {
	// When this content was generated.
	Generated string       `json:"generated,omitempty"`
	Users     []UserEntity `json:"users,omitempty"`
}

UsersEntity struct for UsersEntity

type VariableDto ¶ 

type VariableDto struct {
	// The name of the variable
	Name string `json:"name,omitempty"`
	// The value of the variable
	Value string `json:"value,omitempty"`
	// The ID of the Process Group where this Variable is defined
	ProcessGroupId string `json:"processGroupId,omitempty"`
	// A set of all components that will be affected if the value of this variable is changed
	AffectedComponents []AffectedComponentEntity `json:"affectedComponents,omitempty"`
}

VariableDto struct for VariableDto

type VariableEntity ¶ 

type VariableEntity struct {
	Variable VariableDto `json:"variable,omitempty"`
	// Indicates whether the user can write a given resource.
	CanWrite bool `json:"canWrite,omitempty"`
}

VariableEntity struct for VariableEntity

type VariableRegistryDto ¶ 

type VariableRegistryDto struct {
	// The variables that are available in this Variable Registry
	Variables []VariableEntity `json:"variables,omitempty"`
	// The UUID of the Process Group that this Variable Registry belongs to
	ProcessGroupId string `json:"processGroupId,omitempty"`
}

VariableRegistryDto struct for VariableRegistryDto

type VariableRegistryEntity ¶ 

type VariableRegistryEntity struct {
	ProcessGroupRevision RevisionDto         `json:"processGroupRevision,omitempty"`
	VariableRegistry     VariableRegistryDto `json:"variableRegistry,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool `json:"disconnectedNodeAcknowledged,omitempty"`
}

VariableRegistryEntity struct for VariableRegistryEntity

type VariableRegistryUpdateRequestDto ¶ 

type VariableRegistryUpdateRequestDto struct {
	// The ID of the request
	RequestId string `json:"requestId,omitempty"`
	// The URI for the request
	Uri string `json:"uri,omitempty"`
	// The timestamp of when the request was submitted
	SubmissionTime time.Time `json:"submissionTime,omitempty"`
	// The timestamp of when the request was last updated
	LastUpdated time.Time `json:"lastUpdated,omitempty"`
	// Whether or not the request is completed
	Complete bool `json:"complete,omitempty"`
	// The reason for the request failing, or null if the request has not failed
	FailureReason string `json:"failureReason,omitempty"`
	// A value between 0 and 100 (inclusive) indicating how close the request is to completion
	PercentCompleted int32 `json:"percentCompleted,omitempty"`
	// A description of the current state of the request
	State string `json:"state,omitempty"`
	// The steps that are required in order to complete the request, along with the status of each
	UpdateSteps []VariableRegistryUpdateStepDto `json:"updateSteps,omitempty"`
	// The unique ID of the Process Group that the variable registry belongs to
	ProcessGroupId string `json:"processGroupId,omitempty"`
	// A set of all components that will be affected if the value of this variable is changed
	AffectedComponents []AffectedComponentEntity `json:"affectedComponents,omitempty"`
}

VariableRegistryUpdateRequestDto struct for VariableRegistryUpdateRequestDto

type VariableRegistryUpdateRequestEntity ¶ 

type VariableRegistryUpdateRequestEntity struct {
	Request              VariableRegistryUpdateRequestDto `json:"request,omitempty"`
	ProcessGroupRevision RevisionDto                      `json:"processGroupRevision,omitempty"`
}

VariableRegistryUpdateRequestEntity struct for VariableRegistryUpdateRequestEntity

type VariableRegistryUpdateStepDto ¶ 

type VariableRegistryUpdateStepDto struct {
	// Explanation of what happens in this step
	Description string `json:"description,omitempty"`
	// Whether or not this step has completed
	Complete bool `json:"complete,omitempty"`
	// An explanation of why this step failed, or null if this step did not fail
	FailureReason string `json:"failureReason,omitempty"`
}

VariableRegistryUpdateStepDto struct for VariableRegistryUpdateStepDto

type VersionControlComponentMappingEntity ¶ 

type VersionControlComponentMappingEntity struct {
	// The mapping of Versioned Component Identifiers to instance ID's
	VersionControlComponentMapping map[string]string `json:"versionControlComponentMapping,omitempty"`
	ProcessGroupRevision           RevisionDto       `json:"processGroupRevision,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool                         `json:"disconnectedNodeAcknowledged,omitempty"`
	VersionControlInformation    VersionControlInformationDto `json:"versionControlInformation,omitempty"`
}

VersionControlComponentMappingEntity struct for VersionControlComponentMappingEntity

type VersionControlInformationDto ¶ 

type VersionControlInformationDto struct {
	// The ID of the Process Group that is under version control
	GroupId string `json:"groupId,omitempty"`
	// The ID of the registry that the flow is stored in
	RegistryId string `json:"registryId,omitempty"`
	// The name of the registry that the flow is stored in
	RegistryName string `json:"registryName,omitempty"`
	// The ID of the bucket that the flow is stored in
	BucketId string `json:"bucketId,omitempty"`
	// The name of the bucket that the flow is stored in
	BucketName string `json:"bucketName,omitempty"`
	// The ID of the flow
	FlowId string `json:"flowId,omitempty"`
	// The name of the flow
	FlowName string `json:"flowName,omitempty"`
	// The description of the flow
	FlowDescription string `json:"flowDescription,omitempty"`
	// The version of the flow
	Version int32 `json:"version,omitempty"`
	// The current state of the Process Group, as it relates to the Versioned Flow
	State string `json:"state,omitempty"`
	// Explanation of why the group is in the specified state
	StateExplanation string `json:"stateExplanation,omitempty"`
}

VersionControlInformationDto struct for VersionControlInformationDto

type VersionControlInformationEntity ¶ 

type VersionControlInformationEntity struct {
	ProcessGroupRevision RevisionDto `json:"processGroupRevision,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool                         `json:"disconnectedNodeAcknowledged,omitempty"`
	VersionControlInformation    VersionControlInformationDto `json:"versionControlInformation,omitempty"`
}

VersionControlInformationEntity struct for VersionControlInformationEntity

type VersionInfoDto ¶ 

type VersionInfoDto struct {
	// The version of this NiFi.
	NiFiVersion string `json:"niFiVersion,omitempty"`
	// Java JVM vendor
	JavaVendor string `json:"javaVendor,omitempty"`
	// Java version
	JavaVersion string `json:"javaVersion,omitempty"`
	// Host operating system name
	OsName string `json:"osName,omitempty"`
	// Host operating system version
	OsVersion string `json:"osVersion,omitempty"`
	// Host operating system architecture
	OsArchitecture string `json:"osArchitecture,omitempty"`
	// Build tag
	BuildTag string `json:"buildTag,omitempty"`
	// Build revision or commit hash
	BuildRevision string `json:"buildRevision,omitempty"`
	// Build branch
	BuildBranch string `json:"buildBranch,omitempty"`
	// Build timestamp
	BuildTimestamp time.Time `json:"buildTimestamp,omitempty"`
}

VersionInfoDto struct for VersionInfoDto

type VersionedConnection ¶ 

type VersionedConnection struct {
	// The component's unique identifier
	Identifier string `json:"identifier,omitempty"`
	// The component's name
	Name string `json:"name,omitempty"`
	// The user-supplied comments for the component
	Comments    string               `json:"comments,omitempty"`
	Position    Position             `json:"position,omitempty"`
	Source      ConnectableComponent `json:"source,omitempty"`
	Destination ConnectableComponent `json:"destination,omitempty"`
	// The index of the bend point where to place the connection label.
	LabelIndex int32 `json:"labelIndex,omitempty"`
	// The z index of the connection.
	ZIndex int64 `json:"zIndex,omitempty"`
	// The selected relationship that comprise the connection.
	SelectedRelationships []string `json:"selectedRelationships,omitempty"`
	// The object count threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue.
	BackPressureObjectThreshold int64 `json:"backPressureObjectThreshold,omitempty"`
	// The object data size threshold for determining when back pressure is applied. Updating this value is a passive change in the sense that it won't impact whether existing files over the limit are affected but it does help feeder processors to stop pushing too much into this work queue.
	BackPressureDataSizeThreshold string `json:"backPressureDataSizeThreshold,omitempty"`
	// The amount of time a flow file may be in the flow before it will be automatically aged out of the flow. Once a flow file reaches this age it will be terminated from the flow the next time a processor attempts to start work on it.
	FlowFileExpiration string `json:"flowFileExpiration,omitempty"`
	// The comparators used to prioritize the queue.
	Prioritizers []string `json:"prioritizers,omitempty"`
	// The bend points on the connection.
	Bends []Position `json:"bends,omitempty"`
	// The Strategy to use for load balancing data across the cluster, or null, if no Load Balance Strategy has been specified.
	LoadBalanceStrategy string `json:"loadBalanceStrategy,omitempty"`
	// The attribute to use for partitioning data as it is load balanced across the cluster. If the Load Balance Strategy is configured to use PARTITION_BY_ATTRIBUTE, the value returned by this method is the name of the FlowFile Attribute that will be used to determine which node in the cluster should receive a given FlowFile. If the Load Balance Strategy is unset or is set to any other value, the Partitioning Attribute has no effect.
	PartitioningAttribute string `json:"partitioningAttribute,omitempty"`
	// Whether or not compression should be used when transferring FlowFiles between nodes
	LoadBalanceCompression string `json:"loadBalanceCompression,omitempty"`
	ComponentType          string `json:"componentType,omitempty"`
	// The ID of the Process Group that this component belongs to
	GroupIdentifier string `json:"groupIdentifier,omitempty"`
}

VersionedConnection struct for VersionedConnection

type VersionedControllerService ¶ 

type VersionedControllerService struct {
	// The component's unique identifier
	Identifier string `json:"identifier,omitempty"`
	// The component's name
	Name string `json:"name,omitempty"`
	// The user-supplied comments for the component
	Comments string   `json:"comments,omitempty"`
	Position Position `json:"position,omitempty"`
	// The type of the controller service.
	Type   string `json:"type,omitempty"`
	Bundle Bundle `json:"bundle,omitempty"`
	// Lists the APIs this Controller Service implements.
	ControllerServiceApis []ControllerServiceApi `json:"controllerServiceApis,omitempty"`
	// The properties of the controller service.
	Properties map[string]string `json:"properties,omitempty"`
	// The property descriptors for the processor.
	PropertyDescriptors map[string]VersionedPropertyDescriptor `json:"propertyDescriptors,omitempty"`
	// The annotation for the controller service. This is how the custom UI relays configuration to the controller service.
	AnnotationData string `json:"annotationData,omitempty"`
	ComponentType  string `json:"componentType,omitempty"`
	// The ID of the Process Group that this component belongs to
	GroupIdentifier string `json:"groupIdentifier,omitempty"`
}

VersionedControllerService struct for VersionedControllerService

type VersionedFlow ¶ 

type VersionedFlow struct {
	Link JaxbLink `json:"link,omitempty"`
	// An ID to uniquely identify this object.
	Identifier string `json:"identifier,omitempty"`
	// The name of the item.
	Name string `json:"name"`
	// A description of the item.
	Description string `json:"description,omitempty"`
	// The identifier of the bucket this items belongs to. This cannot be changed after the item is created.
	BucketIdentifier string `json:"bucketIdentifier"`
	// The name of the bucket this items belongs to.
	BucketName string `json:"bucketName,omitempty"`
	// The timestamp of when the item was created, as milliseconds since epoch.
	CreatedTimestamp int64 `json:"createdTimestamp,omitempty"`
	// The timestamp of when the item was last modified, as milliseconds since epoch.
	ModifiedTimestamp int64 `json:"modifiedTimestamp,omitempty"`
	// The type of item.
	Type        string      `json:"type"`
	Permissions Permissions `json:"permissions,omitempty"`
	// The number of versions of this flow.
	VersionCount int64 `json:"versionCount,omitempty"`
}

VersionedFlow struct for VersionedFlow

type VersionedFlowCoordinates ¶ 

type VersionedFlowCoordinates struct {
	// The URL of the Flow Registry that contains the flow
	RegistryUrl string `json:"registryUrl,omitempty"`
	// The UUID of the bucket that the flow resides in
	BucketId string `json:"bucketId,omitempty"`
	// The UUID of the flow
	FlowId string `json:"flowId,omitempty"`
	// The version of the flow
	Version int32 `json:"version,omitempty"`
	// Whether or not these coordinates point to the latest version of the flow
	Latest bool `json:"latest,omitempty"`
}

VersionedFlowCoordinates struct for VersionedFlowCoordinates

type VersionedFlowDto ¶ 

type VersionedFlowDto struct {
	// The ID of the registry that the flow is tracked to
	RegistryId string `json:"registryId,omitempty"`
	// The ID of the bucket where the flow is stored
	BucketId string `json:"bucketId,omitempty"`
	// The ID of the flow
	FlowId string `json:"flowId,omitempty"`
	// The name of the flow
	FlowName string `json:"flowName,omitempty"`
	// A description of the flow
	Description string `json:"description,omitempty"`
	// Comments for the changeset
	Comments string `json:"comments,omitempty"`
	// The action being performed
	Action string `json:"action,omitempty"`
}

VersionedFlowDto struct for VersionedFlowDto

type VersionedFlowEntity ¶ 

type VersionedFlowEntity struct {
	VersionedFlow VersionedFlowDto `json:"versionedFlow,omitempty"`
}

VersionedFlowEntity struct for VersionedFlowEntity

type VersionedFlowSnapshot ¶ 

type VersionedFlowSnapshot struct {
	SnapshotMetadata VersionedFlowSnapshotMetadata `json:"snapshotMetadata"`
	FlowContents     VersionedProcessGroup         `json:"flowContents"`
	// The information about controller services that exist outside this versioned flow, but are referenced by components within the versioned flow.
	ExternalControllerServices map[string]ExternalControllerServiceReference `json:"externalControllerServices,omitempty"`
	// The parameter contexts referenced by process groups in the flow contents. The mapping is from the name of the context to the context instance, and it is expected that any context in this map is referenced by at least one process group in this flow.
	ParameterContexts map[string]VersionedParameterContext `json:"parameterContexts,omitempty"`
	// The optional encoding version of the flow contents.
	FlowEncodingVersion string        `json:"flowEncodingVersion,omitempty"`
	Flow                VersionedFlow `json:"flow,omitempty"`
	Bucket              Bucket        `json:"bucket,omitempty"`
	Latest              bool          `json:"latest,omitempty"`
}

VersionedFlowSnapshot struct for VersionedFlowSnapshot

type VersionedFlowSnapshotEntity ¶ 

type VersionedFlowSnapshotEntity struct {
	VersionedFlowSnapshot VersionedFlowSnapshot `json:"versionedFlowSnapshot,omitempty"`
	ProcessGroupRevision  RevisionDto           `json:"processGroupRevision,omitempty"`
	// The ID of the Registry that this flow belongs to
	RegistryId string `json:"registryId,omitempty"`
	// If the Process Group to be updated has a child or descendant Process Group that is also under Version Control, this specifies whether or not the contents of that child/descendant Process Group should be updated.
	UpdateDescendantVersionedFlows bool `json:"updateDescendantVersionedFlows,omitempty"`
	// Acknowledges that this node is disconnected to allow for mutable requests to proceed.
	DisconnectedNodeAcknowledged bool `json:"disconnectedNodeAcknowledged,omitempty"`
}

VersionedFlowSnapshotEntity struct for VersionedFlowSnapshotEntity

type VersionedFlowSnapshotMetadata ¶ 

type VersionedFlowSnapshotMetadata struct {
	Link JaxbLink `json:"link,omitempty"`
	// The identifier of the bucket this snapshot belongs to.
	BucketIdentifier string `json:"bucketIdentifier"`
	// The identifier of the flow this snapshot belongs to.
	FlowIdentifier string `json:"flowIdentifier"`
	// The version of this snapshot of the flow.
	Version int32 `json:"version"`
	// The timestamp when the flow was saved, as milliseconds since epoch.
	Timestamp int64 `json:"timestamp,omitempty"`
	// The user that created this snapshot of the flow.
	Author string `json:"author,omitempty"`
	// The comments provided by the user when creating the snapshot.
	Comments string `json:"comments,omitempty"`
}

VersionedFlowSnapshotMetadata struct for VersionedFlowSnapshotMetadata

type VersionedFlowSnapshotMetadataEntity ¶ 

type VersionedFlowSnapshotMetadataEntity struct {
	VersionedFlowSnapshotMetadata VersionedFlowSnapshotMetadata `json:"versionedFlowSnapshotMetadata,omitempty"`
	// The ID of the Registry that this flow belongs to
	RegistryId string `json:"registryId,omitempty"`
}

VersionedFlowSnapshotMetadataEntity struct for VersionedFlowSnapshotMetadataEntity

type VersionedFlowSnapshotMetadataSetEntity ¶ 

type VersionedFlowSnapshotMetadataSetEntity struct {
	VersionedFlowSnapshotMetadataSet []VersionedFlowSnapshotMetadataEntity `json:"versionedFlowSnapshotMetadataSet,omitempty"`
}

VersionedFlowSnapshotMetadataSetEntity struct for VersionedFlowSnapshotMetadataSetEntity

type VersionedFlowUpdateRequestDto ¶ 

type VersionedFlowUpdateRequestDto struct {
	// The unique ID of this request.
	RequestId string `json:"requestId,omitempty"`
	// The unique ID of the Process Group being updated
	ProcessGroupId string `json:"processGroupId,omitempty"`
	// The URI for future requests to this drop request.
	Uri string `json:"uri,omitempty"`
	// The last time this request was updated.
	LastUpdated string `json:"lastUpdated,omitempty"`
	// Whether or not this request has completed
	Complete bool `json:"complete,omitempty"`
	// An explanation of why this request failed, or null if this request has not failed
	FailureReason string `json:"failureReason,omitempty"`
	// The percentage complete for the request, between 0 and 100
	PercentCompleted int32 `json:"percentCompleted,omitempty"`
	// The state of the request
	State                     string                       `json:"state,omitempty"`
	VersionControlInformation VersionControlInformationDto `json:"versionControlInformation,omitempty"`
}

VersionedFlowUpdateRequestDto struct for VersionedFlowUpdateRequestDto

type VersionedFlowUpdateRequestEntity ¶ 

type VersionedFlowUpdateRequestEntity struct {
	ProcessGroupRevision RevisionDto                   `json:"processGroupRevision,omitempty"`
	Request              VersionedFlowUpdateRequestDto `json:"request,omitempty"`
}

VersionedFlowUpdateRequestEntity struct for VersionedFlowUpdateRequestEntity

type VersionedFlowsEntity ¶ 

type VersionedFlowsEntity struct {
	VersionedFlows []VersionedFlowEntity `json:"versionedFlows,omitempty"`
}

VersionedFlowsEntity struct for VersionedFlowsEntity

type VersionedFunnel ¶ 

type VersionedFunnel struct {
	// The component's unique identifier
	Identifier string `json:"identifier,omitempty"`
	// The component's name
	Name string `json:"name,omitempty"`
	// The user-supplied comments for the component
	Comments      string   `json:"comments,omitempty"`
	Position      Position `json:"position,omitempty"`
	ComponentType string   `json:"componentType,omitempty"`
	// The ID of the Process Group that this component belongs to
	GroupIdentifier string `json:"groupIdentifier,omitempty"`
}

VersionedFunnel struct for VersionedFunnel

type VersionedLabel ¶ 

type VersionedLabel struct {
	// The component's unique identifier
	Identifier string `json:"identifier,omitempty"`
	// The component's name
	Name string `json:"name,omitempty"`
	// The user-supplied comments for the component
	Comments string   `json:"comments,omitempty"`
	Position Position `json:"position,omitempty"`
	// The text that appears in the label.
	Label string `json:"label,omitempty"`
	// The width of the label in pixels when at a 1:1 scale.
	Width float64 `json:"width,omitempty"`
	// The height of the label in pixels when at a 1:1 scale.
	Height float64 `json:"height,omitempty"`
	// The styles for this label (font-size : 12px, background-color : #eee, etc).
	Style         map[string]string `json:"style,omitempty"`
	ComponentType string            `json:"componentType,omitempty"`
	// The ID of the Process Group that this component belongs to
	GroupIdentifier string `json:"groupIdentifier,omitempty"`
}

VersionedLabel struct for VersionedLabel

type VersionedParameter ¶ 

type VersionedParameter struct {
	// The name of the parameter
	Name string `json:"name,omitempty"`
	// The description of the param
	Description string `json:"description,omitempty"`
	// Whether or not the parameter value is sensitive
	Sensitive bool `json:"sensitive,omitempty"`
	// The value of the parameter
	Value string `json:"value,omitempty"`
}

VersionedParameter struct for VersionedParameter

type VersionedParameterContext ¶ 

type VersionedParameterContext struct {
	// The name of the context
	Name string `json:"name,omitempty"`
	// The description of the parameter context
	Description string `json:"description,omitempty"`
	// The parameters in the context
	Parameters []VersionedParameter `json:"parameters,omitempty"`
}

VersionedParameterContext struct for VersionedParameterContext

type VersionedPort ¶ 

type VersionedPort struct {
	// The component's unique identifier
	Identifier string `json:"identifier,omitempty"`
	// The component's name
	Name string `json:"name,omitempty"`
	// The user-supplied comments for the component
	Comments string   `json:"comments,omitempty"`
	Position Position `json:"position,omitempty"`
	// The type of port.
	Type string `json:"type,omitempty"`
	// The number of tasks that should be concurrently scheduled for the port.
	ConcurrentlySchedulableTaskCount int32 `json:"concurrentlySchedulableTaskCount,omitempty"`
	// The scheduled state of the component
	ScheduledState string `json:"scheduledState,omitempty"`
	// Whether or not this port allows remote access for site-to-site
	AllowRemoteAccess bool   `json:"allowRemoteAccess,omitempty"`
	ComponentType     string `json:"componentType,omitempty"`
	// The ID of the Process Group that this component belongs to
	GroupIdentifier string `json:"groupIdentifier,omitempty"`
}

VersionedPort struct for VersionedPort

type VersionedProcessGroup ¶ 

type VersionedProcessGroup struct {
	// The component's unique identifier
	Identifier string `json:"identifier,omitempty"`
	// The component's name
	Name string `json:"name,omitempty"`
	// The user-supplied comments for the component
	Comments string   `json:"comments,omitempty"`
	Position Position `json:"position,omitempty"`
	// The child Process Groups
	ProcessGroups []VersionedProcessGroup `json:"processGroups,omitempty"`
	// The Remote Process Groups
	RemoteProcessGroups []VersionedRemoteProcessGroup `json:"remoteProcessGroups,omitempty"`
	// The Processors
	Processors []VersionedProcessor `json:"processors,omitempty"`
	// The Input Ports
	InputPorts []VersionedPort `json:"inputPorts,omitempty"`
	// The Output Ports
	OutputPorts []VersionedPort `json:"outputPorts,omitempty"`
	// The Connections
	Connections []VersionedConnection `json:"connections,omitempty"`
	// The Labels
	Labels []VersionedLabel `json:"labels,omitempty"`
	// The Funnels
	Funnels []VersionedFunnel `json:"funnels,omitempty"`
	// The Controller Services
	ControllerServices       []VersionedControllerService `json:"controllerServices,omitempty"`
	VersionedFlowCoordinates VersionedFlowCoordinates     `json:"versionedFlowCoordinates,omitempty"`
	// The Variables in the Variable Registry for this Process Group (not including any ancestor or descendant Process Groups)
	Variables map[string]string `json:"variables,omitempty"`
	// The name of the parameter context used by this process group
	ParameterContextName string `json:"parameterContextName,omitempty"`
	ComponentType        string `json:"componentType,omitempty"`
	// The ID of the Process Group that this component belongs to
	GroupIdentifier string `json:"groupIdentifier,omitempty"`
}

VersionedProcessGroup struct for VersionedProcessGroup

type VersionedProcessor ¶ 

type VersionedProcessor struct {
	// The component's unique identifier
	Identifier string `json:"identifier,omitempty"`
	// The component's name
	Name string `json:"name,omitempty"`
	// The user-supplied comments for the component
	Comments string   `json:"comments,omitempty"`
	Position Position `json:"position,omitempty"`
	Bundle   Bundle   `json:"bundle,omitempty"`
	// Stylistic data for rendering in a UI
	Style map[string]string `json:"style,omitempty"`
	// The type of Processor
	Type string `json:"type,omitempty"`
	// The properties for the processor. Properties whose value is not set will only contain the property name.
	Properties map[string]string `json:"properties,omitempty"`
	// The property descriptors for the processor.
	PropertyDescriptors map[string]VersionedPropertyDescriptor `json:"propertyDescriptors,omitempty"`
	// The annotation data for the processor used to relay configuration between a custom UI and the procesosr.
	AnnotationData string `json:"annotationData,omitempty"`
	// The frequency with which to schedule the processor. The format of the value will depend on th value of schedulingStrategy.
	SchedulingPeriod string `json:"schedulingPeriod,omitempty"`
	// Indcates whether the prcessor should be scheduled to run in event or timer driven mode.
	SchedulingStrategy string `json:"schedulingStrategy,omitempty"`
	// Indicates the node where the process will execute.
	ExecutionNode string `json:"executionNode,omitempty"`
	// The amout of time that is used when the process penalizes a flowfile.
	PenaltyDuration string `json:"penaltyDuration,omitempty"`
	// The amount of time that must elapse before this processor is scheduled again after yielding.
	YieldDuration string `json:"yieldDuration,omitempty"`
	// The level at which the processor will report bulletins.
	BulletinLevel string `json:"bulletinLevel,omitempty"`
	// The run duration for the processor in milliseconds.
	RunDurationMillis int64 `json:"runDurationMillis,omitempty"`
	// The number of tasks that should be concurrently schedule for the processor. If the processor doesn't allow parallol processing then any positive input will be ignored.
	ConcurrentlySchedulableTaskCount int32 `json:"concurrentlySchedulableTaskCount,omitempty"`
	// The names of all relationships that cause a flow file to be terminated if the relationship is not connected elsewhere. This property differs from the 'isAutoTerminate' property of the RelationshipDTO in that the RelationshipDTO is meant to depict the current configuration, whereas this property can be set in a DTO when updating a Processor in order to change which Relationships should be auto-terminated.
	AutoTerminatedRelationships []string `json:"autoTerminatedRelationships,omitempty"`
	// The scheduled state of the component
	ScheduledState string `json:"scheduledState,omitempty"`
	ComponentType  string `json:"componentType,omitempty"`
	// The ID of the Process Group that this component belongs to
	GroupIdentifier string `json:"groupIdentifier,omitempty"`
}

VersionedProcessor struct for VersionedProcessor

type VersionedPropertyDescriptor ¶ 

type VersionedPropertyDescriptor struct {
	// The name of the property
	Name string `json:"name,omitempty"`
	// The display name of the property
	DisplayName string `json:"displayName,omitempty"`
	// Whether or not the property provides the identifier of a Controller Service
	IdentifiesControllerService bool `json:"identifiesControllerService,omitempty"`
	// Whether or not the property is considered sensitive
	Sensitive bool `json:"sensitive,omitempty"`
}

VersionedPropertyDescriptor struct for VersionedPropertyDescriptor

type VersionedRemoteGroupPort ¶ 

type VersionedRemoteGroupPort struct {
	// The component's unique identifier
	Identifier string `json:"identifier,omitempty"`
	// The component's name
	Name string `json:"name,omitempty"`
	// The user-supplied comments for the component
	Comments string   `json:"comments,omitempty"`
	Position Position `json:"position,omitempty"`
	// The id of the remote process group that the port resides in.
	RemoteGroupId string `json:"remoteGroupId,omitempty"`
	// The number of task that may transmit flowfiles to the target port concurrently.
	ConcurrentlySchedulableTaskCount int32 `json:"concurrentlySchedulableTaskCount,omitempty"`
	// Whether the flowfiles are compressed when sent to the target port.
	UseCompression bool      `json:"useCompression,omitempty"`
	BatchSize      BatchSize `json:"batchSize,omitempty"`
	ComponentType  string    `json:"componentType,omitempty"`
	// The ID of the port on the target NiFi instance
	TargetId string `json:"targetId,omitempty"`
	// The scheduled state of the component
	ScheduledState string `json:"scheduledState,omitempty"`
	// The ID of the Process Group that this component belongs to
	GroupIdentifier string `json:"groupIdentifier,omitempty"`
}

VersionedRemoteGroupPort struct for VersionedRemoteGroupPort

type VersionedRemoteProcessGroup ¶ 

type VersionedRemoteProcessGroup struct {
	// The component's unique identifier
	Identifier string `json:"identifier,omitempty"`
	// The component's name
	Name string `json:"name,omitempty"`
	// The user-supplied comments for the component
	Comments string   `json:"comments,omitempty"`
	Position Position `json:"position,omitempty"`
	// [DEPRECATED] The target URI of the remote process group. If target uri is not set, but uris are set, then returns the first uri in the uris. If neither target uri nor uris are set, then returns null.
	TargetUri string `json:"targetUri,omitempty"`
	// The target URIs of the remote process group. If target uris is not set but target uri is set, then returns the single target uri. If neither target uris nor target uri is set, then returns null.
	TargetUris string `json:"targetUris,omitempty"`
	// The time period used for the timeout when communicating with the target.
	CommunicationsTimeout string `json:"communicationsTimeout,omitempty"`
	// When yielding, this amount of time must elapse before the remote process group is scheduled again.
	YieldDuration string `json:"yieldDuration,omitempty"`
	// The Transport Protocol that is used for Site-to-Site communications
	TransportProtocol string `json:"transportProtocol,omitempty"`
	// The local network interface to send/receive data. If not specified, any local address is used. If clustered, all nodes must have an interface with this identifier.
	LocalNetworkInterface string `json:"localNetworkInterface,omitempty"`
	ProxyHost             string `json:"proxyHost,omitempty"`
	ProxyPort             int32  `json:"proxyPort,omitempty"`
	ProxyUser             string `json:"proxyUser,omitempty"`
	// A Set of Input Ports that can be connected to, in order to send data to the remote NiFi instance
	InputPorts []VersionedRemoteGroupPort `json:"inputPorts,omitempty"`
	// A Set of Output Ports that can be connected to, in order to pull data from the remote NiFi instance
	OutputPorts   []VersionedRemoteGroupPort `json:"outputPorts,omitempty"`
	ComponentType string                     `json:"componentType,omitempty"`
	// The ID of the Process Group that this component belongs to
	GroupIdentifier string `json:"groupIdentifier,omitempty"`
}

VersionedRemoteProcessGroup struct for VersionedRemoteProcessGroup

type VersionsApiDeleteRevertRequestOpts ¶ 

type VersionsApiDeleteRevertRequestOpts struct {
	DisconnectedNodeAcknowledged optional.Bool
}

VersionsApiDeleteRevertRequestOpts Optional parameters for the method 'DeleteRevertRequest'

type VersionsApiDeleteUpdateRequestOpts ¶ 

type VersionsApiDeleteUpdateRequestOpts struct {
	DisconnectedNodeAcknowledged optional.Bool
}

VersionsApiDeleteUpdateRequestOpts Optional parameters for the method 'DeleteUpdateRequest'

type VersionsApiDeleteVersionControlRequestOpts ¶ 

type VersionsApiDeleteVersionControlRequestOpts struct {
	DisconnectedNodeAcknowledged optional.Bool
}

VersionsApiDeleteVersionControlRequestOpts Optional parameters for the method 'DeleteVersionControlRequest'

type VersionsApiService ¶ 

type VersionsApiService service

VersionsApiService VersionsApi service

func (*VersionsApiService) CreateVersionControlRequest ¶ 

func (a *VersionsApiService) CreateVersionControlRequest(ctx _context.Context, body CreateActiveRequestEntity) (string, *_nethttp.Response, error)

CreateVersionControlRequest Create a version control request Creates a request so that a Process Group can be placed under Version Control or have its Version Control configuration changed. Creating this request will prevent any other threads from simultaneously saving local changes to Version Control. It will not, however, actually save the local flow to the Flow Registry. A POST to /versions/process-groups/{id} should be used to initiate saving of the local flow to the Flow Registry. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body The versioned flow details.

@return string

func (*VersionsApiService) DeleteRevertRequest ¶ 

func (a *VersionsApiService) DeleteRevertRequest(ctx _context.Context, id string, localVarOptionals *VersionsApiDeleteRevertRequestOpts) (VersionedFlowUpdateRequestEntity, *_nethttp.Response, error)

DeleteRevertRequest Deletes the Revert Request with the given ID Deletes the Revert Request with the given ID. After a request is created via a POST to /versions/revert-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Revert process has completed. If the request is deleted before the request completes, then the Revert request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of the Revert Request
  • @param optional nil or *VersionsApiDeleteRevertRequestOpts - Optional Parameters:
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

@return VersionedFlowUpdateRequestEntity

func (*VersionsApiService) DeleteUpdateRequest ¶ 

func (a *VersionsApiService) DeleteUpdateRequest(ctx _context.Context, id string, localVarOptionals *VersionsApiDeleteUpdateRequestOpts) (VersionedFlowUpdateRequestEntity, *_nethttp.Response, error)

DeleteUpdateRequest Deletes the Update Request with the given ID Deletes the Update Request with the given ID. After a request is created via a POST to /versions/update-requests/process-groups/{id}, it is expected that the client will properly clean up the request by DELETE'ing it, once the Update process has completed. If the request is deleted before the request completes, then the Update request will finish the step that it is currently performing and then will cancel any subsequent steps. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of the Update Request
  • @param optional nil or *VersionsApiDeleteUpdateRequestOpts - Optional Parameters:
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

@return VersionedFlowUpdateRequestEntity

func (*VersionsApiService) DeleteVersionControlRequest ¶ 

func (a *VersionsApiService) DeleteVersionControlRequest(ctx _context.Context, id string, localVarOptionals *VersionsApiDeleteVersionControlRequestOpts) (*_nethttp.Response, error)

DeleteVersionControlRequest Deletes the version control request with the given ID Deletes the Version Control Request with the given ID. This will allow other threads to save flows to the Flow Registry. See also the documentation for POSTing to /versions/active-requests for information regarding why this is done. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The request ID.
  • @param optional nil or *VersionsApiDeleteVersionControlRequestOpts - Optional Parameters:
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

func (*VersionsApiService) ExportFlowVersion ¶ 

func (a *VersionsApiService) ExportFlowVersion(ctx _context.Context, id string) (string, *_nethttp.Response, error)

ExportFlowVersion Gets the latest version of a Process Group for download

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.

@return string

func (*VersionsApiService) GetRevertRequest ¶ 

func (a *VersionsApiService) GetRevertRequest(ctx _context.Context, id string) (VersionedFlowUpdateRequestEntity, *_nethttp.Response, error)

GetRevertRequest Returns the Revert Request with the given ID Returns the Revert Request with the given ID. Once a Revert Request has been created by performing a POST to /versions/revert-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of the Revert Request

@return VersionedFlowUpdateRequestEntity

func (*VersionsApiService) GetUpdateRequest ¶ 

func (a *VersionsApiService) GetUpdateRequest(ctx _context.Context, id string) (VersionedFlowUpdateRequestEntity, *_nethttp.Response, error)

GetUpdateRequest Returns the Update Request with the given ID Returns the Update Request with the given ID. Once an Update Request has been created by performing a POST to /versions/update-requests/process-groups/{id}, that request can subsequently be retrieved via this endpoint, and the request that is fetched will contain the updated state, such as percent complete, the current state of the request, and any failures. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The ID of the Update Request

@return VersionedFlowUpdateRequestEntity

func (*VersionsApiService) GetVersionInformation ¶ 

func (a *VersionsApiService) GetVersionInformation(ctx _context.Context, id string) (VersionControlInformationEntity, *_nethttp.Response, error)

GetVersionInformation Gets the Version Control information for a process group Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.

@return VersionControlInformationEntity

func (*VersionsApiService) InitiateRevertFlowVersion ¶ 

func (a *VersionsApiService) InitiateRevertFlowVersion(ctx _context.Context, id string, body VersionControlInformationEntity) (VersionedFlowUpdateRequestEntity, *_nethttp.Response, error)

InitiateRevertFlowVersion Initiate the Revert Request of a Process Group with the given ID For a Process Group that is already under Version Control, this will initiate the action of reverting any local changes that have been made to the Process Group since it was last synchronized with the Flow Registry. This will result in the flow matching the Versioned Flow that exists in the Flow Registry. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/revert-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/revert-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param body The controller service configuration details.

@return VersionedFlowUpdateRequestEntity

func (*VersionsApiService) InitiateVersionControlUpdate ¶ 

func (a *VersionsApiService) InitiateVersionControlUpdate(ctx _context.Context, id string, body VersionControlInformationEntity) (VersionedFlowUpdateRequestEntity, *_nethttp.Response, error)

InitiateVersionControlUpdate Initiate the Update Request of a Process Group with the given ID For a Process Group that is already under Version Control, this will initiate the action of changing from a specific version of the flow in the Flow Registry to a different version of the flow. This can be a lengthy process, as it will stop any Processors and disable any Controller Services necessary to perform the action and then restart them. As a result, the endpoint will immediately return a VersionedFlowUpdateRequestEntity, and the process of updating the flow will occur asynchronously in the background. The client may then periodically poll the status of the request by issuing a GET request to /versions/update-requests/{requestId}. Once the request is completed, the client is expected to issue a DELETE request to /versions/update-requests/{requestId}. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param body The controller service configuration details.

@return VersionedFlowUpdateRequestEntity

func (*VersionsApiService) SaveToFlowRegistry ¶ 

func (a *VersionsApiService) SaveToFlowRegistry(ctx _context.Context, id string, body StartVersionControlRequestEntity) (VersionControlInformationEntity, *_nethttp.Response, error)

SaveToFlowRegistry Save the Process Group with the given ID Begins version controlling the Process Group with the given ID or commits changes to the Versioned Flow, depending on if the provided VersionControlInformation includes a flowId. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param body The versioned flow details.

@return VersionControlInformationEntity

func (*VersionsApiService) StopVersionControl ¶ 

func (a *VersionsApiService) StopVersionControl(ctx _context.Context, id string, localVarOptionals *VersionsApiStopVersionControlOpts) (VersionControlInformationEntity, *_nethttp.Response, error)

StopVersionControl Stops version controlling the Process Group with the given ID Stops version controlling the Process Group with the given ID. The Process Group will no longer track to any Versioned Flow. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param optional nil or *VersionsApiStopVersionControlOpts - Optional Parameters:
  • @param "Version" (optional.String) - The version is used to verify the client is working with the latest version of the flow.
  • @param "ClientId" (optional.String) - If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.
  • @param "DisconnectedNodeAcknowledged" (optional.Bool) - Acknowledges that this node is disconnected to allow for mutable requests to proceed.

@return VersionControlInformationEntity

func (*VersionsApiService) UpdateFlowVersion ¶ 

func (a *VersionsApiService) UpdateFlowVersion(ctx _context.Context, id string, body VersionedFlowSnapshotEntity) (VersionControlInformationEntity, *_nethttp.Response, error)

UpdateFlowVersion Update the version of a Process Group with the given ID For a Process Group that is already under Version Control, this will update the version of the flow to a different version. This endpoint expects that the given snapshot will not modify any Processor that is currently running or any Controller Service that is enabled. Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The process group id.
  • @param body The controller service configuration details.

@return VersionControlInformationEntity

func (*VersionsApiService) UpdateVersionControlRequest ¶ 

func (a *VersionsApiService) UpdateVersionControlRequest(ctx _context.Context, id string, body VersionControlComponentMappingEntity) (VersionControlInformationEntity, *_nethttp.Response, error)

UpdateVersionControlRequest Updates the request with the given ID Note: This endpoint is subject to change as NiFi and it's REST API evolve.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id The request ID.
  • @param body The version control component mapping.

@return VersionControlInformationEntity

type VersionsApiStopVersionControlOpts ¶ 

type VersionsApiStopVersionControlOpts struct {
	Version                      optional.String
	ClientId                     optional.String
	DisconnectedNodeAcknowledged optional.Bool
}

VersionsApiStopVersionControlOpts Optional parameters for the method 'StopVersionControl'

Source Files ¶

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.