service

package
v0.0.0-...-3897fff Latest Latest
Warning

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

 Go to latest Published: Sep 3, 2016 License: GPL-3.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Access 

type Access struct {
}

func (Access) CreateAccessToken 

func (self Access) CreateAccessToken(username string, password string) string

*

  • 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>'. *
  • Tags: ["access"] *
  • @param username
  • @param password
  • @return string

func (Access) CreateAccessTokenFromTicket 

func (self Access) CreateAccessTokenFromTicket() string

*

  • 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>'. *
  • Tags: ["access"] *
  • @return string

func (Access) CreateDownloadToken 

func (self Access) CreateDownloadToken() string

*

  • 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'. *
  • Tags: ["access"] *
  • @return string

func (Access) CreateUiExtensionToken 

func (self Access) CreateUiExtensionToken() string

*

  • 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'. *
  • Tags: ["access"] *
  • @return string

func (Access) GetAccessStatus 

func (self Access) GetAccessStatus() model.AccessStatusEntity

*

  • Gets the status the client's access *
  • Note: This endpoint is subject to change as NiFi and it's REST API evolve. *
  • Tags: ["access"] *
  • @return model.AccessStatusEntity

func (Access) GetLoginConfig 

func (self Access) GetLoginConfig() model.AccessConfigurationEntity

*

  • Retrieves the access configuration for this NiFi * *
  • Tags: ["access"] *
  • @return model.AccessConfigurationEntity

type Connections 

type Connections struct {
}

func (Connections) DeleteConnection 

func (self Connections) DeleteConnection(version string, clientId string, id string) model.ConnectionEntity

*

  • Deletes a connection * *
  • Tags: ["connections"] *
  • @param version The revision is used to verify the client is working with the latest version of the flow.
  • @param clientId If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param id The connection id.
  • @return model.ConnectionEntity

func (Connections) GetConnection 

func (self Connections) GetConnection(id string) model.ConnectionEntity

*

  • Gets a connection * *
  • Tags: ["connections"] *
  • @param id The connection id.
  • @return model.ConnectionEntity

func (Connections) UpdateConnection 

func (self Connections) UpdateConnection(id string, body model.ConnectionEntity) model.ConnectionEntity

*

  • Updates a connection * *
  • Tags: ["connections"] *
  • @param id The connection id.
  • @param body The connection configuration details.
  • @return model.ConnectionEntity

type Controller 

type Controller struct {
}

func (Controller) CreateControllerService 

func (self Controller) CreateControllerService(body model.ControllerServiceEntity) model.ControllerServiceEntity

*

  • Creates a new controller service * *
  • Tags: ["controller"] *
  • @param body The controller service configuration details.
  • @return model.ControllerServiceEntity

func (Controller) CreateReportingTask 

func (self Controller) CreateReportingTask(body model.ReportingTaskEntity) model.ReportingTaskEntity

*

  • Creates a new reporting task * *
  • Tags: ["controller"] *
  • @param body The reporting task configuration details.
  • @return model.ReportingTaskEntity

func (Controller) DeleteHistory 

func (self Controller) DeleteHistory(endDate string) model.HistoryEntity

*

  • Purges history * *
  • Tags: ["controller"] *
  • @param endDate Purge actions before this date/time.
  • @return model.HistoryEntity

func (Controller) DeleteNode 

func (self Controller) DeleteNode(id string) model.NodeEntity

*

  • Removes a node from the cluster * *
  • Tags: ["controller"] *
  • @param id The node id.
  • @return model.NodeEntity

func (Controller) GetCluster 

func (self Controller) GetCluster() model.ClusterEntity

*

  • Gets the contents of the cluster *
  • Returns the contents of the cluster including all nodes and their status. *
  • Tags: ["controller"] *
  • @return model.ClusterEntity

func (Controller) GetControllerConfig 

func (self Controller) GetControllerConfig() model.ControllerConfigurationEntity

*

  • Retrieves the configuration for this NiFi Controller * *
  • Tags: ["controller"] *
  • @return model.ControllerConfigurationEntity

func (Controller) GetNode 

func (self Controller) GetNode(id string) model.NodeEntity

*

  • Gets a node in the cluster * *
  • Tags: ["controller"] *
  • @param id The node id.
  • @return model.NodeEntity

func (Controller) UpdateControllerConfig 

func (self Controller) UpdateControllerConfig(body model.ControllerConfigurationEntity) model.ControllerConfigurationEntity

*

  • Retrieves the configuration for this NiFi * *
  • Tags: ["controller"] *
  • @param body The controller configuration.
  • @return model.ControllerConfigurationEntity

func (Controller) UpdateNode 

func (self Controller) UpdateNode(id string, body model.NodeEntity) model.NodeEntity

*

  • Updates a node in the cluster * *
  • Tags: ["controller"] *
  • @param id The node id.
  • @param body The node configuration. The only configuration that will be honored at this endpoint is the status or primary flag.
  • @return model.NodeEntity

type ControllerServices 

type ControllerServices struct {
}

func (ControllerServices) ClearState 

func (self ControllerServices) ClearState(id string) model.ComponentStateDTO

*

  • Clears the state for a controller service * *
  • Tags: ["controller-services"] *
  • @param id The controller service id.
  • @return model.ComponentStateDTO

func (ControllerServices) GetControllerService 

func (self ControllerServices) GetControllerService(id string) model.ControllerServiceEntity

*

  • Gets a controller service * *
  • Tags: ["controller-services"] *
  • @param id The controller service id.
  • @return model.ControllerServiceEntity

func (ControllerServices) GetControllerServiceReferences 

func (self ControllerServices) GetControllerServiceReferences(id string) model.ControllerServiceEntity

*

  • Gets a controller service * *
  • Tags: ["controller-services"] *
  • @param id The controller service id.
  • @return model.ControllerServiceEntity

func (ControllerServices) GetPropertyDescriptor 

func (self ControllerServices) GetPropertyDescriptor(id string, propertyName string) model.PropertyDescriptorEntity

*

  • Gets a controller service property descriptor * *
  • Tags: ["controller-services"] *
  • @param id The controller service id.
  • @param propertyName The property name to return the descriptor for.
  • @return model.PropertyDescriptorEntity

func (ControllerServices) GetState 

func (self ControllerServices) GetState(id string) model.ComponentStateDTO

*

  • Gets the state for a controller service * *
  • Tags: ["controller-services"] *
  • @param id The controller service id.
  • @return model.ComponentStateDTO

func (ControllerServices) RemoveControllerService 

func (self ControllerServices) RemoveControllerService(version string, clientId string, id string) model.ControllerServiceEntity

*

  • Deletes a controller service * *
  • Tags: ["controller-services"] *
  • @param version The revision is used to verify the client is working with the latest version of the flow.
  • @param clientId If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param id The controller service id.
  • @return model.ControllerServiceEntity

func (ControllerServices) UpdateControllerService 

func (self ControllerServices) UpdateControllerService(id string, body model.ControllerServiceEntity) model.ControllerServiceEntity

*

  • Updates a controller service * *
  • Tags: ["controller-services"] *
  • @param id The controller service id.
  • @param body The controller service configuration details.
  • @return model.ControllerServiceEntity

func (ControllerServices) UpdateControllerServiceReferences 

func (self ControllerServices) UpdateControllerServiceReferences(id string, body model.UpdateControllerServiceReferenceRequestEntity) model.ControllerServiceReferencingComponentsEntity

*

  • Updates a controller services references * *
  • Tags: ["controller-services"] *
  • @param id The controller service id.
  • @param body The controller service request update request.
  • @return model.ControllerServiceReferencingComponentsEntity

type Counters 

type Counters struct {
}

func (Counters) GetCounters 

func (self Counters) GetCounters(nodewise bool, clusterNodeId string) model.CountersEntity

*

  • Gets the current counters for this NiFi *
  • Note: This endpoint is subject to change as NiFi and it's REST API evolve. *
  • Tags: ["counters"] *
  • @param nodewise Whether or not to include the breakdown per node. Optional, defaults to false
  • @param clusterNodeId The id of the node where to get the status.
  • @return model.CountersEntity

func (Counters) UpdateCounter 

func (self Counters) UpdateCounter(id string) model.CounterEntity

*

  • 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. *
  • Tags: ["counters"] *
  • @param id The id of the counter.
  • @return model.CounterEntity

type DataTransfer 

type DataTransfer struct {
}

func (DataTransfer) CommitInputPortTransaction 

func (self DataTransfer) CommitInputPortTransaction(responseCode int, portId string, transactionId string) model.TransactionResultEntity

*

  • Commit or cancel the specified transaction * *
  • Tags: ["data-transfer"] *
  • @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 model.TransactionResultEntity

func (DataTransfer) CommitOutputPortTransaction 

func (self DataTransfer) CommitOutputPortTransaction(responseCode int, checksum string, portId string, transactionId string) model.TransactionResultEntity

*

  • Commit or cancel the specified transaction * *
  • Tags: ["data-transfer"] *
  • @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 model.TransactionResultEntity

func (DataTransfer) CreatePortTransaction 

func (self DataTransfer) CreatePortTransaction(portType string, portId string) model.TransactionResultEntity

*

  • Create a transaction to the specified output port or input port * *
  • Tags: ["data-transfer"] *
  • @param portType The port type.
  • @param portId
  • @return model.TransactionResultEntity

func (DataTransfer) ExtendInputPortTransactionTTL 

func (self DataTransfer) ExtendInputPortTransactionTTL(portId string, transactionId string) model.TransactionResultEntity

*

  • Extend transaction TTL * *
  • Tags: ["data-transfer"] *
  • @param portId
  • @param transactionId
  • @return model.TransactionResultEntity

func (DataTransfer) ExtendOutputPortTransactionTTL 

func (self DataTransfer) ExtendOutputPortTransactionTTL(portId string, transactionId string) model.TransactionResultEntity

*

  • Extend transaction TTL * *
  • Tags: ["data-transfer"] *
  • @param portId
  • @param transactionId
  • @return model.TransactionResultEntity

func (DataTransfer) ReceiveFlowFiles 

func (self DataTransfer) ReceiveFlowFiles(portId string, transactionId string) string

*

  • Transfer flow files to the input port * *
  • Tags: ["data-transfer"] *
  • @param portId The input port id.
  • @param transactionId
  • @return string

func (DataTransfer) TransferFlowFiles 

func (self DataTransfer) TransferFlowFiles(portId string, transactionId string)

*

  • Transfer flow files from the output port * *
  • Tags: ["data-transfer"] *
  • @param portId The output port id.
  • @param transactionId
  • @return

type Flow 

type Flow struct {
}

func (Flow) GenerateClientId 

func (self Flow) GenerateClientId() string

*

  • Generates a client id. * *
  • Tags: ["flow"] *
  • @return string

func (Flow) GetAboutInfo 

func (self Flow) GetAboutInfo() model.AboutEntity

*

  • Retrieves details about this NiFi to put in the About dialog * *
  • Tags: ["flow"] *
  • @return model.AboutEntity

func (Flow) GetAction 

func (self Flow) GetAction(id string) model.ActionEntity

*

  • Gets an action *
  • Note: This endpoint is subject to change as NiFi and it's REST API evolve. *
  • Tags: ["flow"] *
  • @param id The action id.
  • @return model.ActionEntity

func (Flow) GetBanners 

func (self Flow) GetBanners() model.BannerEntity

*

  • Retrieves the banners for this NiFi * *
  • Tags: ["flow"] *
  • @return model.BannerEntity

func (Flow) GetBulletinBoard 

func (self Flow) GetBulletinBoard(after string, sourceName string, message string, sourceId string, groupId string, limit string) model.BulletinBoardEntity

*

  • Gets current bulletins * *
  • Tags: ["flow"] *
  • @param after Includes bulletins with an id after this value.
  • @param sourceName Includes bulletins originating from this sources whose name match this regular expression.
  • @param message Includes bulletins whose message that match this regular expression.
  • @param sourceId Includes bulletins originating from this sources whose id match this regular expression.
  • @param groupId Includes bulletins originating from this sources whose group id match this regular expression.
  • @param limit The number of bulletins to limit the response to.
  • @return model.BulletinBoardEntity

func (Flow) GetBulletins 

func (self Flow) GetBulletins() model.ControllerBulletinsEntity

*

  • Retrieves Controller level bulletins * *
  • Tags: ["flow"] *
  • @return model.ControllerBulletinsEntity

func (Flow) GetClusterSummary 

func (self Flow) GetClusterSummary() model.ControllerStatusEntity

*

  • Gets the current status of this NiFi * *
  • Tags: ["flow"] *
  • @return model.ControllerStatusEntity

func (Flow) GetComponentHistory 

func (self Flow) GetComponentHistory(componentId string) model.ComponentHistoryEntity

*

  • Gets configuration history for a component *
  • Note: This endpoint is subject to change as NiFi and it's REST API evolve. *
  • Tags: ["flow"] *
  • @param componentId The component id.
  • @return model.ComponentHistoryEntity

func (Flow) GetConnectionStatus 

func (self Flow) GetConnectionStatus(nodewise bool, clusterNodeId string, id string) model.ConnectionStatusEntity

*

  • Gets status for a connection * *
  • Tags: ["flow"] *
  • @param nodewise Whether or not to include the breakdown per node. Optional, defaults to false
  • @param clusterNodeId The id of the node where to get the status.
  • @param id The connection id.
  • @return model.ConnectionStatusEntity

func (Flow) GetConnectionStatusHistory 

func (self Flow) GetConnectionStatusHistory(id string) model.StatusHistoryEntity

*

  • Gets the status history for a connection * *
  • Tags: ["flow"] *
  • @param id The connection id.
  • @return model.StatusHistoryEntity

func (Flow) GetControllerServiceTypes 

func (self Flow) GetControllerServiceTypes(serviceType string) model.ControllerServiceTypesEntity

*

  • 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. *
  • Tags: ["flow"] *
  • @param serviceType If specified, will only return controller services of this type.
  • @return model.ControllerServiceTypesEntity

func (Flow) GetControllerServicesFromController 

func (self Flow) GetControllerServicesFromController() model.ControllerServicesEntity

*

  • Gets all controller services * *
  • Tags: ["flow"] *
  • @return model.ControllerServicesEntity

func (Flow) GetControllerServicesFromGroup 

func (self Flow) GetControllerServicesFromGroup(id string) model.ControllerServicesEntity

*

  • Gets all controller services * *
  • Tags: ["flow"] *
  • @param id The process group id.
  • @return model.ControllerServicesEntity

func (Flow) GetControllerStatus 

func (self Flow) GetControllerStatus() model.ControllerStatusEntity

*

  • Gets the current status of this NiFi * *
  • Tags: ["flow"] *
  • @return model.ControllerStatusEntity

func (Flow) GetCurrentUser 

func (self Flow) GetCurrentUser() model.CurrentUserEntity

*

  • Retrieves the user identity of the user making the request * *
  • Tags: ["flow"] *
  • @return model.CurrentUserEntity

func (Flow) GetFlow 

func (self Flow) GetFlow(id string) model.ProcessGroupFlowEntity

*

  • Gets a process group * *
  • Tags: ["flow"] *
  • @param id The process group id.
  • @return model.ProcessGroupFlowEntity

func (Flow) GetFlowConfig 

func (self Flow) GetFlowConfig() model.FlowConfigurationEntity

*

  • Retrieves the configuration for this NiFi flow * *
  • Tags: ["flow"] *
  • @return model.FlowConfigurationEntity

func (Flow) GetInputPortStatus 

func (self Flow) GetInputPortStatus(nodewise bool, clusterNodeId string, id string) model.PortStatusEntity

*

  • Gets status for an input port * *
  • Tags: ["flow"] *
  • @param nodewise Whether or not to include the breakdown per node. Optional, defaults to false
  • @param clusterNodeId The id of the node where to get the status.
  • @param id The input port id.
  • @return model.PortStatusEntity

func (Flow) GetOutputPortStatus 

func (self Flow) GetOutputPortStatus(nodewise bool, clusterNodeId string, id string) model.PortStatusEntity

*

  • Gets status for an output port * *
  • Tags: ["flow"] *
  • @param nodewise Whether or not to include the breakdown per node. Optional, defaults to false
  • @param clusterNodeId The id of the node where to get the status.
  • @param id The output port id.
  • @return model.PortStatusEntity

func (Flow) GetPrioritizers 

func (self Flow) GetPrioritizers() model.PrioritizerTypesEntity

*

  • Retrieves the types of prioritizers that this NiFi supports *
  • Note: This endpoint is subject to change as NiFi and it's REST API evolve. *
  • Tags: ["flow"] *
  • @return model.PrioritizerTypesEntity

func (Flow) GetProcessGroupStatus 

func (self Flow) GetProcessGroupStatus(recursive bool, nodewise bool, clusterNodeId string, id string) model.ProcessGroupStatusEntity

*

  • 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. *
  • Tags: ["flow"] *
  • @param recursive Whether all descendant groups and the status of their content will be included. Optional, defaults to false
  • @param nodewise Whether or not to include the breakdown per node. Optional, defaults to false
  • @param clusterNodeId The id of the node where to get the status.
  • @param id The process group id.
  • @return model.ProcessGroupStatusEntity

func (Flow) GetProcessGroupStatusHistory 

func (self Flow) GetProcessGroupStatusHistory(id string) model.StatusHistoryEntity

*

  • Gets status history for a remote process group * *
  • Tags: ["flow"] *
  • @param id The process group id.
  • @return model.StatusHistoryEntity

func (Flow) GetProcessorStatus 

func (self Flow) GetProcessorStatus(nodewise bool, clusterNodeId string, id string) model.ProcessorStatusEntity

*

  • Gets status for a processor * *
  • Tags: ["flow"] *
  • @param nodewise Whether or not to include the breakdown per node. Optional, defaults to false
  • @param clusterNodeId The id of the node where to get the status.
  • @param id The processor id.
  • @return model.ProcessorStatusEntity

func (Flow) GetProcessorStatusHistory 

func (self Flow) GetProcessorStatusHistory(id string) model.StatusHistoryEntity

*

  • Gets status history for a processor * *
  • Tags: ["flow"] *
  • @param id The processor id.
  • @return model.StatusHistoryEntity

func (Flow) GetProcessorTypes 

func (self Flow) GetProcessorTypes() model.ProcessorTypesEntity

*

  • Retrieves the types of processors that this NiFi supports *
  • Note: This endpoint is subject to change as NiFi and it's REST API evolve. *
  • Tags: ["flow"] *
  • @return model.ProcessorTypesEntity

func (Flow) GetRemoteProcessGroupStatus 

func (self Flow) GetRemoteProcessGroupStatus(nodewise bool, clusterNodeId string, id string) model.ProcessorStatusEntity

*

  • Gets status for a remote process group * *
  • Tags: ["flow"] *
  • @param nodewise Whether or not to include the breakdown per node. Optional, defaults to false
  • @param clusterNodeId The id of the node where to get the status.
  • @param id The remote process group id.
  • @return model.ProcessorStatusEntity

func (Flow) GetRemoteProcessGroupStatusHistory 

func (self Flow) GetRemoteProcessGroupStatusHistory(id string) model.StatusHistoryEntity

*

  • Gets the status history * *
  • Tags: ["flow"] *
  • @param id The remote process group id.
  • @return model.StatusHistoryEntity

func (Flow) GetReportingTaskTypes 

func (self Flow) GetReportingTaskTypes() model.ReportingTaskTypesEntity

*

  • 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. *
  • Tags: ["flow"] *
  • @return model.ReportingTaskTypesEntity

func (Flow) GetReportingTasks 

func (self Flow) GetReportingTasks() model.ReportingTasksEntity

*

  • Gets all reporting tasks * *
  • Tags: ["flow"] *
  • @return model.ReportingTasksEntity

func (Flow) GetTemplates 

func (self Flow) GetTemplates() model.TemplatesEntity

*

  • Gets all templates * *
  • Tags: ["flow"] *
  • @return model.TemplatesEntity

func (Flow) QueryHistory 

func (self Flow) QueryHistory(offset string, count string, sortColumn string, sortOrder string, startDate string, endDate string, userIdentity string, sourceId string) model.HistoryEntity

*

  • Gets configuration history *
  • Note: This endpoint is subject to change as NiFi and it's REST API evolve. *
  • Tags: ["flow"] *
  • @param offset The offset into the result set.
  • @param count The number of actions to return.
  • @param sortColumn The field to sort on.
  • @param sortOrder The direction to sort.
  • @param startDate Include actions after this date.
  • @param endDate Include actions before this date.
  • @param userIdentity Include actions performed by this user.
  • @param sourceId Include actions on this component.
  • @return model.HistoryEntity

func (Flow) ScheduleComponents 

func (self Flow) ScheduleComponents(id string, body model.ScheduleComponentsEntity) model.ScheduleComponentsEntity

*

  • Schedule or unschedule comopnents in the specified Process Group. * *
  • Tags: ["flow"] *
  • @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 model.ScheduleComponentsEntity

func (Flow) SearchCluster 

func (self Flow) SearchCluster(q string) model.ClusterSearchResultsEntity

*

  • 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. *
  • Tags: ["flow"] *
  • @param q Node address to search for.
  • @return model.ClusterSearchResultsEntity

func (Flow) SearchFlow 

func (self Flow) SearchFlow(q string) model.SearchResultsEntity

*

  • Performs a search against this NiFi using the specified search term *
  • Only search results from authorized components will be returned. *
  • Tags: ["flow"] *
  • @param q
  • @return model.SearchResultsEntity

type FlowfileQueues 

type FlowfileQueues struct {
}

func (FlowfileQueues) CreateDropRequest 

func (self FlowfileQueues) CreateDropRequest(id string) model.DropRequestEntity

*

  • Creates a request to drop the contents of the queue in this connection. * *
  • Tags: ["flowfile-queues"] *
  • @param id The connection id.
  • @return model.DropRequestEntity

func (FlowfileQueues) CreateFlowFileListing 

func (self FlowfileQueues) CreateFlowFileListing(id string) model.ListingRequestEntity

*

  • Lists the contents of the queue in this connection. * *
  • Tags: ["flowfile-queues"] *
  • @param id The connection id.
  • @return model.ListingRequestEntity

func (FlowfileQueues) DeleteListingRequest 

func (self FlowfileQueues) DeleteListingRequest(id string, listingRequestId string) model.DropRequestEntity

*

  • Cancels and/or removes a request to list the contents of this connection. * *
  • Tags: ["flowfile-queues"] *
  • @param id The connection id.
  • @param listingRequestId The listing request id.
  • @return model.DropRequestEntity

func (FlowfileQueues) DownloadFlowFileContent 

func (self FlowfileQueues) DownloadFlowFileContent(clientId string, id string, flowfileUuid string, clusterNodeId string)

*

  • Gets the content for a FlowFile in a Connection. * *
  • Tags: ["flowfile-queues"] *
  • @param clientId If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param id The connection id.
  • @param flowfileUuid The flowfile uuid.
  • @param clusterNodeId The id of the node where the content exists if clustered.
  • @return

func (FlowfileQueues) GetDropRequest 

func (self FlowfileQueues) GetDropRequest(id string, dropRequestId string) model.DropRequestEntity

*

  • Gets the current status of a drop request for the specified connection. * *
  • Tags: ["flowfile-queues"] *
  • @param id The connection id.
  • @param dropRequestId The drop request id.
  • @return model.DropRequestEntity

func (FlowfileQueues) GetFlowFile 

func (self FlowfileQueues) GetFlowFile(id string, flowfileUuid string, clusterNodeId string)

*

  • Gets a FlowFile from a Connection. * *
  • Tags: ["flowfile-queues"] *
  • @param id The connection id.
  • @param flowfileUuid The flowfile uuid.
  • @param clusterNodeId The id of the node where the content exists if clustered.
  • @return

func (FlowfileQueues) GetListingRequest 

func (self FlowfileQueues) GetListingRequest(id string, listingRequestId string) model.ListingRequestEntity

*

  • Gets the current status of a listing request for the specified connection. * *
  • Tags: ["flowfile-queues"] *
  • @param id The connection id.
  • @param listingRequestId The listing request id.
  • @return model.ListingRequestEntity

func (FlowfileQueues) RemoveDropRequest 

func (self FlowfileQueues) RemoveDropRequest(id string, dropRequestId string) model.DropRequestEntity

*

  • Cancels and/or removes a request to drop the contents of this connection. * *
  • Tags: ["flowfile-queues"] *
  • @param id The connection id.
  • @param dropRequestId The drop request id.
  • @return model.DropRequestEntity

type Funnels 

type Funnels struct {
}

func (Funnels) GetFunnel 

func (self Funnels) GetFunnel(id string) model.FunnelEntity

*

  • Gets a funnel * *
  • Tags: ["funnel"] *
  • @param id The funnel id.
  • @return model.FunnelEntity

func (Funnels) RemoveFunnel 

func (self Funnels) RemoveFunnel(version string, clientId string, id string) model.FunnelEntity

*

  • Deletes a funnel * *
  • Tags: ["funnel"] *
  • @param version The revision is used to verify the client is working with the latest version of the flow.
  • @param clientId If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param id The funnel id.
  • @return model.FunnelEntity

func (Funnels) UpdateFunnel 

func (self Funnels) UpdateFunnel(id string, body model.FunnelEntity) model.FunnelEntity

*

  • Updates a funnel * *
  • Tags: ["funnel"] *
  • @param id The funnel id.
  • @param body The funnel configuration details.
  • @return model.FunnelEntity

type InputPorts 

type InputPorts struct {
}

func (InputPorts) GetInputPort 

func (self InputPorts) GetInputPort(id string) model.PortEntity

*

  • Gets an input port * *
  • Tags: ["input-ports"] *
  • @param id The input port id.
  • @return model.PortEntity

func (InputPorts) RemoveInputPort 

func (self InputPorts) RemoveInputPort(version string, clientId string, id string) model.PortEntity

*

  • Deletes an input port * *
  • Tags: ["input-ports"] *
  • @param version The revision is used to verify the client is working with the latest version of the flow.
  • @param clientId If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param id The input port id.
  • @return model.PortEntity

func (InputPorts) UpdateInputPort 

func (self InputPorts) UpdateInputPort(id string, body model.PortEntity) model.PortEntity

*

  • Updates an input port * *
  • Tags: ["input-ports"] *
  • @param id The input port id.
  • @param body The input port configuration details.
  • @return model.PortEntity

type Labels 

type Labels struct {
}

func (Labels) GetLabel 

func (self Labels) GetLabel(id string) model.LabelEntity

*

  • Gets a label * *
  • Tags: ["labels"] *
  • @param id The label id.
  • @return model.LabelEntity

func (Labels) RemoveLabel 

func (self Labels) RemoveLabel(version string, clientId string, id string) model.LabelEntity

*

  • Deletes a label * *
  • Tags: ["labels"] *
  • @param version The revision is used to verify the client is working with the latest version of the flow.
  • @param clientId If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param id The label id.
  • @return model.LabelEntity

func (Labels) UpdateLabel 

func (self Labels) UpdateLabel(id string, body model.LabelEntity) model.LabelEntity

*

  • Updates a label * *
  • Tags: ["labels"] *
  • @param id The label id.
  • @param body The label configuration details.
  • @return model.LabelEntity

type OutputPorts 

type OutputPorts struct {
}

func (OutputPorts) GetOutputPort 

func (self OutputPorts) GetOutputPort(id string) model.PortEntity

*

  • Gets an output port * *
  • Tags: ["output-ports"] *
  • @param id The output port id.
  • @return model.PortEntity

func (OutputPorts) RemoveOutputPort 

func (self OutputPorts) RemoveOutputPort(version string, clientId string, id string) model.PortEntity

*

  • Deletes an output port * *
  • Tags: ["output-ports"] *
  • @param version The revision is used to verify the client is working with the latest version of the flow.
  • @param clientId If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param id The output port id.
  • @return model.PortEntity

func (OutputPorts) UpdateOutputPort 

func (self OutputPorts) UpdateOutputPort(id string, body model.PortEntity) model.PortEntity

*

  • Updates an output port * *
  • Tags: ["output-ports"] *
  • @param id The output port id.
  • @param body The output port configuration details.
  • @return model.PortEntity

type Policies 

type Policies struct {
}

func (Policies) CreateAccessPolicy 

func (self Policies) CreateAccessPolicy(body model.AccessPolicyEntity) model.AccessPolicyEntity

*

  • Creates an access policy * *
  • Tags: ["policies"] *
  • @param body The access policy configuration details.
  • @return model.AccessPolicyEntity

func (Policies) GetAccessPolicy 

func (self Policies) GetAccessPolicy(id string) model.AccessPolicyEntity

*

  • Gets an access policy * *
  • Tags: ["policies"] *
  • @param id The access policy id.
  • @return model.AccessPolicyEntity

func (Policies) GetAccessPolicyForResource 

func (self Policies) GetAccessPolicyForResource(action string, resource string) model.AccessPolicyEntity

*

  • 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. *
  • Tags: ["policies"] *
  • @param action The request action.
  • @param resource The resource of the policy.
  • @return model.AccessPolicyEntity

func (Policies) RemoveAccessPolicy 

func (self Policies) RemoveAccessPolicy(version string, clientId string, id string) model.AccessPolicyEntity

*

  • Deletes an access policy * *
  • Tags: ["policies"] *
  • @param version The revision is used to verify the client is working with the latest version of the flow.
  • @param clientId If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param id The access policy id.
  • @return model.AccessPolicyEntity

func (Policies) UpdateAccessPolicy 

func (self Policies) UpdateAccessPolicy(id string, body model.AccessPolicyEntity) model.AccessPolicyEntity

*

  • Updates a access policy * *
  • Tags: ["policies"] *
  • @param id The access policy id.
  • @param body The access policy configuration details.
  • @return model.AccessPolicyEntity

type ProcessGroups 

type ProcessGroups struct {
}

func (ProcessGroups) CopySnippet 

func (self ProcessGroups) CopySnippet(id string, body model.CopySnippetRequestEntity) model.FlowSnippetEntity

*

  • Copies a snippet * *
  • Tags: ["process-groups"] *
  • @param id The process group id.
  • @param body The copy snippet request.
  • @return model.FlowSnippetEntity

func (ProcessGroups) CreateConnection 

func (self ProcessGroups) CreateConnection(id string, body model.ConnectionEntity) model.ConnectionEntity

*

  • Creates a connection * *
  • Tags: ["process-groups"] *
  • @param id The process group id.
  • @param body The connection configuration details.
  • @return model.ConnectionEntity

func (ProcessGroups) CreateControllerService 

func (self ProcessGroups) CreateControllerService(id string, body model.ControllerServiceEntity) model.ControllerServiceEntity

*

  • Creates a new controller service * *
  • Tags: ["process-groups"] *
  • @param id The process group id.
  • @param body The controller service configuration details.
  • @return model.ControllerServiceEntity

func (ProcessGroups) CreateFunnel 

func (self ProcessGroups) CreateFunnel(id string, body model.FunnelEntity) model.FunnelEntity

*

  • Creates a funnel * *
  • Tags: ["process-groups"] *
  • @param id The process group id.
  • @param body The funnel configuration details.
  • @return model.FunnelEntity

func (ProcessGroups) CreateInputPort 

func (self ProcessGroups) CreateInputPort(id string, body model.PortEntity) model.PortEntity

*

  • Creates an input port * *
  • Tags: ["process-groups"] *
  • @param id The process group id.
  • @param body The input port configuration details.
  • @return model.PortEntity

func (ProcessGroups) CreateLabel 

func (self ProcessGroups) CreateLabel(id string, body model.LabelEntity) model.LabelEntity

*

  • Creates a label * *
  • Tags: ["process-groups"] *
  • @param id The process group id.
  • @param body The label configuration details.
  • @return model.LabelEntity

func (ProcessGroups) CreateOutputPort 

func (self ProcessGroups) CreateOutputPort(id string, body model.PortEntity) model.PortEntity

*

  • Creates an output port * *
  • Tags: ["process-groups"] *
  • @param id The process group id.
  • @param body The output port configuration.
  • @return model.PortEntity

func (ProcessGroups) CreateProcessGroup 

func (self ProcessGroups) CreateProcessGroup(id string, body model.ProcessGroupEntity) model.ProcessGroupEntity

*

  • Creates a process group * *
  • Tags: ["process-groups"] *
  • @param id The process group id.
  • @param body The process group configuration details.
  • @return model.ProcessGroupEntity

func (ProcessGroups) CreateProcessor 

func (self ProcessGroups) CreateProcessor(id string, body model.ProcessorEntity) model.ProcessorEntity

*

  • Creates a new processor * *
  • Tags: ["process-groups"] *
  • @param id The process group id.
  • @param body The processor configuration details.
  • @return model.ProcessorEntity

func (ProcessGroups) CreateRemoteProcessGroup 

func (self ProcessGroups) CreateRemoteProcessGroup(id string, body model.RemoteProcessGroupEntity) model.RemoteProcessGroupEntity

*

  • Creates a new process group * *
  • Tags: ["process-groups"] *
  • @param id The process group id.
  • @param body The remote process group configuration details.
  • @return model.RemoteProcessGroupEntity

func (ProcessGroups) CreateTemplate 

func (self ProcessGroups) CreateTemplate(id string, body model.CreateTemplateRequestEntity) model.TemplateEntity

*

  • Creates a template * *
  • Tags: ["process-groups"] *
  • @param id The process group id.
  • @param body The create template request.
  • @return model.TemplateEntity

func (ProcessGroups) GetConnections 

func (self ProcessGroups) GetConnections(id string) model.ConnectionsEntity

*

  • Gets all connections * *
  • Tags: ["process-groups"] *
  • @param id The process group id.
  • @return model.ConnectionsEntity

func (ProcessGroups) GetFunnels 

func (self ProcessGroups) GetFunnels(id string) model.FunnelsEntity

*

  • Gets all funnels * *
  • Tags: ["process-groups"] *
  • @param id The process group id.
  • @return model.FunnelsEntity

func (ProcessGroups) GetInputPorts 

func (self ProcessGroups) GetInputPorts(id string) model.InputPortsEntity

*

  • Gets all input ports * *
  • Tags: ["process-groups"] *
  • @param id The process group id.
  • @return model.InputPortsEntity

func (ProcessGroups) GetLabels 

func (self ProcessGroups) GetLabels(id string) model.LabelsEntity

*

  • Gets all labels * *
  • Tags: ["process-groups"] *
  • @param id The process group id.
  • @return model.LabelsEntity

func (ProcessGroups) GetOutputPorts 

func (self ProcessGroups) GetOutputPorts(id string) model.OutputPortsEntity

*

  • Gets all output ports * *
  • Tags: ["process-groups"] *
  • @param id The process group id.
  • @return model.OutputPortsEntity

func (ProcessGroups) GetProcessGroup 

func (self ProcessGroups) GetProcessGroup(id string) model.ProcessGroupEntity

*

  • Gets a process group * *
  • Tags: ["process-groups"] *
  • @param id The process group id.
  • @return model.ProcessGroupEntity

func (ProcessGroups) GetProcessGroups 

func (self ProcessGroups) GetProcessGroups(id string) model.ProcessorsEntity

*

  • Gets all process groups * *
  • Tags: ["process-groups"] *
  • @param id The process group id.
  • @return model.ProcessorsEntity

func (ProcessGroups) GetProcessors 

func (self ProcessGroups) GetProcessors(id string) model.ProcessorsEntity

*

  • Gets all processors * *
  • Tags: ["process-groups"] *
  • @param id The process group id.
  • @return model.ProcessorsEntity

func (ProcessGroups) GetRemoteProcessGroups 

func (self ProcessGroups) GetRemoteProcessGroups(id string) model.RemoteProcessGroupsEntity

*

  • Gets all remote process groups * *
  • Tags: ["process-groups"] *
  • @param id The process group id.
  • @return model.RemoteProcessGroupsEntity

func (ProcessGroups) ImportTemplate 

func (self ProcessGroups) ImportTemplate(id string) model.TemplateEntity

*

  • Imports a template * *
  • Tags: ["process-groups"] *
  • @param id The process group id.
  • @return model.TemplateEntity

func (ProcessGroups) InstantiateTemplate 

func (self ProcessGroups) InstantiateTemplate(id string, body model.InstantiateTemplateRequestEntity) model.FlowEntity

*

  • Instantiates a template * *
  • Tags: ["process-groups"] *
  • @param id The process group id.
  • @param body The instantiate template request.
  • @return model.FlowEntity

func (ProcessGroups) RemoveProcessGroup 

func (self ProcessGroups) RemoveProcessGroup(version string, clientId string, id string) model.ProcessGroupEntity

*

  • Deletes a process group * *
  • Tags: ["process-groups"] *
  • @param version The revision is used to verify the client is working with the latest version of the flow.
  • @param clientId If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param id The process group id.
  • @return model.ProcessGroupEntity

func (ProcessGroups) UpdateProcessGroup 

func (self ProcessGroups) UpdateProcessGroup(id string, body model.ProcessGroupEntity) model.ProcessGroupEntity

*

  • Updates a process group * *
  • Tags: ["process-groups"] *
  • @param id The process group id.
  • @param body The process group configuration details.
  • @return model.ProcessGroupEntity

type Processors 

type Processors struct {
}

func (Processors) ClearState 

func (self Processors) ClearState(id string) model.ComponentStateDTO

*

  • Clears the state for a processor * *
  • Tags: ["processors"] *
  • @param id The processor id.
  • @return model.ComponentStateDTO

func (Processors) DeleteProcessor 

func (self Processors) DeleteProcessor(version string, clientId string, id string) model.ProcessorEntity

*

  • Deletes a processor * *
  • Tags: ["processors"] *
  • @param version The revision is used to verify the client is working with the latest version of the flow.
  • @param clientId If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param id The processor id.
  • @return model.ProcessorEntity

func (Processors) GetProcessor 

func (self Processors) GetProcessor(id string) model.ProcessorEntity

*

  • Gets a processor * *
  • Tags: ["processors"] *
  • @param id The processor id.
  • @return model.ProcessorEntity

func (Processors) GetPropertyDescriptor 

func (self Processors) GetPropertyDescriptor(clientId string, id string, propertyName string) model.PropertyDescriptorEntity

*

  • Gets the descriptor for a processor property * *
  • Tags: ["processors"] *
  • @param clientId If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param id The processor id.
  • @param propertyName The property name.
  • @return model.PropertyDescriptorEntity

func (Processors) GetState 

func (self Processors) GetState(id string) model.ComponentStateDTO

*

  • Gets the state for a processor * *
  • Tags: ["processors"] *
  • @param id The processor id.
  • @return model.ComponentStateDTO

func (Processors) UpdateProcessor 

func (self Processors) UpdateProcessor(id string, body model.ProcessorEntity) model.ProcessorEntity

*

  • Updates a processor * *
  • Tags: ["processors"] *
  • @param id The processor id.
  • @param body The processor configuration details.
  • @return model.ProcessorEntity

type Provenance 

type Provenance struct {
}

func (Provenance) DeleteLineage 

func (self Provenance) DeleteLineage(clusterNodeId string, id string) model.LineageEntity

*

  • Deletes a lineage query * *
  • Tags: ["provenance"] *
  • @param clusterNodeId The id of the node where this query exists if clustered.
  • @param id The id of the lineage query.
  • @return model.LineageEntity

func (Provenance) DeleteProvenance 

func (self Provenance) DeleteProvenance(clusterNodeId string, id string) model.ProvenanceEntity

*

  • Deletes a provenance query * *
  • Tags: ["provenance"] *
  • @param clusterNodeId The id of the node where this query exists if clustered.
  • @param id The id of the provenance query.
  • @return model.ProvenanceEntity

func (Provenance) GetLineage 

func (self Provenance) GetLineage(clusterNodeId string, id string) model.LineageEntity

*

  • Gets a lineage query * *
  • Tags: ["provenance"] *
  • @param clusterNodeId The id of the node where this query exists if clustered.
  • @param id The id of the lineage query.
  • @return model.LineageEntity

func (Provenance) GetProvenance 

func (self Provenance) GetProvenance(clusterNodeId string, id string) model.ProvenanceEntity

*

  • Gets a provenance query * *
  • Tags: ["provenance"] *
  • @param clusterNodeId The id of the node where this query exists if clustered.
  • @param id The id of the provenance query.
  • @return model.ProvenanceEntity

func (Provenance) GetSearchOptions 

func (self Provenance) GetSearchOptions() model.ProvenanceOptionsEntity

*

  • Gets the searchable attributes for provenance events * *
  • Tags: ["provenance"] *
  • @return model.ProvenanceOptionsEntity

func (Provenance) SubmitLineageRequest 

func (self Provenance) SubmitLineageRequest(body model.LineageEntity) model.LineageEntity

*

  • 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. *
  • Tags: ["provenance"] *
  • @param body The lineage query details.
  • @return model.LineageEntity

func (Provenance) SubmitProvenanceRequest 

func (self Provenance) SubmitProvenanceRequest(body model.ProvenanceEntity) model.ProvenanceEntity

*

  • 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. *
  • Tags: ["provenance"] *
  • @param body The provenance query details.
  • @return model.ProvenanceEntity

type ProvenanceEvents 

type ProvenanceEvents struct {
}

func (ProvenanceEvents) GetInputContent 

func (self ProvenanceEvents) GetInputContent(clusterNodeId string, id string)

*

  • Gets the input content for a provenance event * *
  • Tags: ["provenance-events"] *
  • @param clusterNodeId The id of the node where the content exists if clustered.
  • @param id The provenance event id.
  • @return

func (ProvenanceEvents) GetOutputContent 

func (self ProvenanceEvents) GetOutputContent(clusterNodeId string, id string)

*

  • Gets the output content for a provenance event * *
  • Tags: ["provenance-events"] *
  • @param clusterNodeId The id of the node where the content exists if clustered.
  • @param id The provenance event id.
  • @return

func (ProvenanceEvents) GetProvenanceEvent 

func (self ProvenanceEvents) GetProvenanceEvent(clusterNodeId string, id string) model.ProvenanceEventEntity

*

  • Gets a provenance event * *
  • Tags: ["provenance-events"] *
  • @param clusterNodeId The id of the node where this event exists if clustered.
  • @param id The provenance event id.
  • @return model.ProvenanceEventEntity

func (ProvenanceEvents) SubmitReplay 

func (self ProvenanceEvents) SubmitReplay(body model.SubmitReplayRequestEntity) model.ProvenanceEventEntity

*

  • Replays content from a provenance event * *
  • Tags: ["provenance-events"] *
  • @param body The replay request.
  • @return model.ProvenanceEventEntity

type RemoteProcessGroups 

type RemoteProcessGroups struct {
}

func (RemoteProcessGroups) GetRemoteProcessGroup 

func (self RemoteProcessGroups) GetRemoteProcessGroup(id string) model.RemoteProcessGroupEntity

*

  • Gets a remote process group * *
  • Tags: ["remote-process-groups"] *
  • @param id The remote process group id.
  • @return model.RemoteProcessGroupEntity

func (RemoteProcessGroups) RemoveRemoteProcessGroup 

func (self RemoteProcessGroups) RemoveRemoteProcessGroup(version string, clientId string, id string) model.RemoteProcessGroupEntity

*

  • Deletes a remote process group * *
  • Tags: ["remote-process-groups"] *
  • @param version The revision is used to verify the client is working with the latest version of the flow.
  • @param clientId If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param id The remote process group id.
  • @return model.RemoteProcessGroupEntity

func (RemoteProcessGroups) UpdateRemoteProcessGroup 

func (self RemoteProcessGroups) UpdateRemoteProcessGroup(id string, body model.RemoteProcessGroupEntity) model.RemoteProcessGroupEntity

*

  • Updates a remote process group * *
  • Tags: ["remote-process-groups"] *
  • @param id The remote process group id.
  • @param body The remote process group.
  • @return model.RemoteProcessGroupEntity

func (RemoteProcessGroups) UpdateRemoteProcessGroupInputPort 

func (self RemoteProcessGroups) UpdateRemoteProcessGroupInputPort(id string, portId string, body model.RemoteProcessGroupPortEntity) model.RemoteProcessGroupPortEntity

*

  • Updates a remote port *
  • Note: This endpoint is subject to change as NiFi and it's REST API evolve. *
  • Tags: ["remote-process-groups"] *
  • @param id The remote process group id.
  • @param portId The remote process group port id.
  • @param body The remote process group port.
  • @return model.RemoteProcessGroupPortEntity

func (RemoteProcessGroups) UpdateRemoteProcessGroupOutputPort 

func (self RemoteProcessGroups) UpdateRemoteProcessGroupOutputPort(id string, portId string, body model.RemoteProcessGroupPortEntity) model.RemoteProcessGroupPortEntity

*

  • Updates a remote port *
  • Note: This endpoint is subject to change as NiFi and it's REST API evolve. *
  • Tags: ["remote-process-groups"] *
  • @param id The remote process group id.
  • @param portId The remote process group port id.
  • @param body The remote process group port.
  • @return model.RemoteProcessGroupPortEntity

type ReportingTasks 

type ReportingTasks struct {
}

func (ReportingTasks) ClearState 

func (self ReportingTasks) ClearState(id string) model.ComponentStateDTO

*

  • Clears the state for a reporting task * *
  • Tags: ["reporting-tasks"] *
  • @param id The reporting task id.
  • @return model.ComponentStateDTO

func (ReportingTasks) GetPropertyDescriptor 

func (self ReportingTasks) GetPropertyDescriptor(id string, propertyName string) model.PropertyDescriptorEntity

*

  • Gets a reporting task property descriptor * *
  • Tags: ["reporting-tasks"] *
  • @param id The reporting task id.
  • @param propertyName The property name.
  • @return model.PropertyDescriptorEntity

func (ReportingTasks) GetReportingTask 

func (self ReportingTasks) GetReportingTask(id string) model.ReportingTaskEntity

*

  • Gets a reporting task * *
  • Tags: ["reporting-tasks"] *
  • @param id The reporting task id.
  • @return model.ReportingTaskEntity

func (ReportingTasks) GetState 

func (self ReportingTasks) GetState(id string) model.ComponentStateDTO

*

  • Gets the state for a reporting task * *
  • Tags: ["reporting-tasks"] *
  • @param id The reporting task id.
  • @return model.ComponentStateDTO

func (ReportingTasks) RemoveReportingTask 

func (self ReportingTasks) RemoveReportingTask(version string, clientId string, id string) model.ReportingTaskEntity

*

  • Deletes a reporting task * *
  • Tags: ["reporting-tasks"] *
  • @param version The revision is used to verify the client is working with the latest version of the flow.
  • @param clientId If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param id The reporting task id.
  • @return model.ReportingTaskEntity

func (ReportingTasks) UpdateReportingTask 

func (self ReportingTasks) UpdateReportingTask(id string, body model.ReportingTaskEntity) model.ReportingTaskEntity

*

  • Updates a reporting task * *
  • Tags: ["reporting-tasks"] *
  • @param id The reporting task id.
  • @param body The reporting task configuration details.
  • @return model.ReportingTaskEntity

type Resources 

type Resources struct {
}

func (Resources) GetResources 

func (self Resources) GetResources() model.ResourcesEntity

*

  • Gets the available resources that support access/authorization policies * *
  • Tags: ["resources"] *
  • @return model.ResourcesEntity

type SiteToSite 

type SiteToSite struct {
}

func (SiteToSite) GetPeers 

func (self SiteToSite) GetPeers() model.PeersEntity

*

  • Returns the available Peers and its status of this NiFi * *
  • Tags: ["site-to-site"] *
  • @return model.PeersEntity

func (SiteToSite) GetSiteToSiteDetails 

func (self SiteToSite) GetSiteToSiteDetails() model.ControllerEntity

*

  • Returns the details about this NiFi necessary to communicate via site to site * *
  • Tags: ["site-to-site"] *
  • @return model.ControllerEntity

type Snippets 

type Snippets struct {
}

func (Snippets) CreateSnippet 

func (self Snippets) CreateSnippet(body model.SnippetEntity) model.SnippetEntity

*

  • Creates a snippet * *
  • Tags: ["snippets"] *
  • @param body The snippet configuration details.
  • @return model.SnippetEntity

func (Snippets) DeleteSnippet 

func (self Snippets) DeleteSnippet(id string) model.SnippetEntity

*

  • Deletes the components in a snippet and drops the snippet * *
  • Tags: ["snippets"] *
  • @param id The snippet id.
  • @return model.SnippetEntity

func (Snippets) UpdateSnippet 

func (self Snippets) UpdateSnippet(id string, body model.SnippetEntity) model.SnippetEntity

*

  • Move's the components in this Snippet into a new Process Group and drops the snippet * *
  • Tags: ["snippets"] *
  • @param id The snippet id.
  • @param body The snippet configuration details.
  • @return model.SnippetEntity

type SystemDiagnostics 

type SystemDiagnostics struct {
}

func (SystemDiagnostics) GetSystemDiagnostics 

func (self SystemDiagnostics) GetSystemDiagnostics(nodewise bool, clusterNodeId string) model.SystemDiagnosticsEntity

*

  • Gets the diagnostics for the system NiFi is running on * *
  • Tags: ["system-diagnostics"] *
  • @param nodewise Whether or not to include the breakdown per node. Optional, defaults to false
  • @param clusterNodeId The id of the node where to get the status.
  • @return model.SystemDiagnosticsEntity

type Templates 

type Templates struct {
}

func (Templates) ExportTemplate 

func (self Templates) ExportTemplate(id string) model.TemplateDTO

*

  • Exports a template * *
  • Tags: ["templates"] *
  • @param id The template id.
  • @return model.TemplateDTO

func (Templates) RemoveTemplate 

func (self Templates) RemoveTemplate(id string) model.TemplateEntity

*

  • Deletes a template * *
  • Tags: ["templates"] *
  • @param id The template id.
  • @return model.TemplateEntity

type Tenants 

type Tenants struct {
}

func (Tenants) CreateUser 

func (self Tenants) CreateUser(body model.UserEntity) model.UserEntity

*

  • Creates a user *
  • Note: This endpoint is subject to change as NiFi and it's REST API evolve. *
  • Tags: ["tenants"] *
  • @param body The user configuration details.
  • @return model.UserEntity

func (Tenants) CreateUserGroup 

func (self Tenants) CreateUserGroup(body model.UserGroupEntity) model.UserGroupEntity

*

  • Creates a user group *
  • Note: This endpoint is subject to change as NiFi and it's REST API evolve. *
  • Tags: ["tenants"] *
  • @param body The user group configuration details.
  • @return model.UserGroupEntity

func (Tenants) GetUser 

func (self Tenants) GetUser(id string) model.UserEntity

*

  • Gets a user *
  • Note: This endpoint is subject to change as NiFi and it's REST API evolve. *
  • Tags: ["tenants"] *
  • @param id The user id.
  • @return model.UserEntity

func (Tenants) GetUserGroup 

func (self Tenants) GetUserGroup(id string) model.UserGroupEntity

*

  • Gets a user group *
  • Note: This endpoint is subject to change as NiFi and it's REST API evolve. *
  • Tags: ["tenants"] *
  • @param id The user group id.
  • @return model.UserGroupEntity

func (Tenants) GetUserGroups 

func (self Tenants) GetUserGroups() model.UserGroupsEntity

*

  • Gets all user groups *
  • Note: This endpoint is subject to change as NiFi and it's REST API evolve. *
  • Tags: ["tenants"] *
  • @return model.UserGroupsEntity

func (Tenants) GetUsers 

func (self Tenants) GetUsers() model.UsersEntity

*

  • Gets all users *
  • Note: This endpoint is subject to change as NiFi and it's REST API evolve. *
  • Tags: ["tenants"] *
  • @return model.UsersEntity

func (Tenants) RemoveUser 

func (self Tenants) RemoveUser(version string, clientId string, id string) model.UserEntity

*

  • Deletes a user *
  • Note: This endpoint is subject to change as NiFi and it's REST API evolve. *
  • Tags: ["tenants"] *
  • @param version The revision is used to verify the client is working with the latest version of the flow.
  • @param clientId If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param id The user id.
  • @return model.UserEntity

func (Tenants) RemoveUserGroup 

func (self Tenants) RemoveUserGroup(version string, clientId string, id string) model.UserGroupEntity

*

  • Deletes a user group *
  • Note: This endpoint is subject to change as NiFi and it's REST API evolve. *
  • Tags: ["tenants"] *
  • @param version The revision is used to verify the client is working with the latest version of the flow.
  • @param clientId If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
  • @param id The user group id.
  • @return model.UserGroupEntity

func (Tenants) SearchCluster 

func (self Tenants) SearchCluster(q string) model.ClusterSearchResultsEntity

*

  • 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. *
  • Tags: ["tenants"] *
  • @param q Node address to search for.
  • @return model.ClusterSearchResultsEntity

func (Tenants) UpdateUser 

func (self Tenants) UpdateUser(id string, body model.UserEntity) model.UserEntity

*

  • Updates a user *
  • Note: This endpoint is subject to change as NiFi and it's REST API evolve. *
  • Tags: ["tenants"] *
  • @param id The user id.
  • @param body The user configuration details.
  • @return model.UserEntity

func (Tenants) UpdateUserGroup 

func (self Tenants) UpdateUserGroup(id string, body model.UserGroupEntity) model.UserGroupEntity

*

  • Updates a user group *
  • Note: This endpoint is subject to change as NiFi and it's REST API evolve. *
  • Tags: ["tenants"] *
  • @param id The user group id.
  • @param body The user group configuration details.
  • @return model.UserGroupEntity

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.