All URIs are relative to http://localhost/nifi-api
Method | HTTP request | Description |
---|---|---|
CreateVersionControlRequest | Post /versions/active-requests | Create a version control request |
DeleteRevertRequest | Delete /versions/revert-requests/{id} | Deletes the Revert Request with the given ID |
DeleteUpdateRequest | Delete /versions/update-requests/{id} | Deletes the Update Request with the given ID |
DeleteVersionControlRequest | Delete /versions/active-requests/{id} | Deletes the version control request with the given ID |
ExportFlowVersion | Get /versions/process-groups/{id}/download | Gets the latest version of a Process Group for download |
GetRevertRequest | Get /versions/revert-requests/{id} | Returns the Revert Request with the given ID |
GetUpdateRequest | Get /versions/update-requests/{id} | Returns the Update Request with the given ID |
GetVersionInformation | Get /versions/process-groups/{id} | Gets the Version Control information for a process group |
InitiateRevertFlowVersion | Post /versions/revert-requests/process-groups/{id} | Initiate the Revert Request of a Process Group with the given ID |
InitiateVersionControlUpdate | Post /versions/update-requests/process-groups/{id} | Initiate the Update Request of a Process Group with the given ID |
SaveToFlowRegistry | Post /versions/process-groups/{id} | Save the Process Group with the given ID |
StopVersionControl | Delete /versions/process-groups/{id} | Stops version controlling the Process Group with the given ID |
UpdateFlowVersion | Put /versions/process-groups/{id} | Update the version of a Process Group with the given ID |
UpdateVersionControlRequest | Put /versions/active-requests/{id} | Updates the request with the given ID |
string CreateVersionControlRequest(ctx).Body(body).Execute()
Create a version control request
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
body := *openapiclient.NewCreateActiveRequestEntity() // CreateActiveRequestEntity | The versioned flow details.
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.VersionsApi.CreateVersionControlRequest(context.Background()).Body(body).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `VersionsApi.CreateVersionControlRequest``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateVersionControlRequest`: string
fmt.Fprintf(os.Stdout, "Response from `VersionsApi.CreateVersionControlRequest`: %v\n", resp)
}
Other parameters are passed through a pointer to a apiCreateVersionControlRequestRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
body | CreateActiveRequestEntity | The versioned flow details. |
string
No authorization required
- Content-Type: application/json
- Accept: text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VersionedFlowUpdateRequestEntity DeleteRevertRequest(ctx, id).DisconnectedNodeAcknowledged(disconnectedNodeAcknowledged).Execute()
Deletes the Revert Request with the given ID
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | The ID of the Revert Request
disconnectedNodeAcknowledged := true // bool | Acknowledges that this node is disconnected to allow for mutable requests to proceed. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.VersionsApi.DeleteRevertRequest(context.Background(), id).DisconnectedNodeAcknowledged(disconnectedNodeAcknowledged).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `VersionsApi.DeleteRevertRequest``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeleteRevertRequest`: VersionedFlowUpdateRequestEntity
fmt.Fprintf(os.Stdout, "Response from `VersionsApi.DeleteRevertRequest`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | The ID of the Revert Request |
Other parameters are passed through a pointer to a apiDeleteRevertRequestRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
disconnectedNodeAcknowledged | bool | Acknowledges that this node is disconnected to allow for mutable requests to proceed. | [default to false]
VersionedFlowUpdateRequestEntity
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VersionedFlowUpdateRequestEntity DeleteUpdateRequest(ctx, id).DisconnectedNodeAcknowledged(disconnectedNodeAcknowledged).Execute()
Deletes the Update Request with the given ID
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | The ID of the Update Request
disconnectedNodeAcknowledged := true // bool | Acknowledges that this node is disconnected to allow for mutable requests to proceed. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.VersionsApi.DeleteUpdateRequest(context.Background(), id).DisconnectedNodeAcknowledged(disconnectedNodeAcknowledged).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `VersionsApi.DeleteUpdateRequest``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `DeleteUpdateRequest`: VersionedFlowUpdateRequestEntity
fmt.Fprintf(os.Stdout, "Response from `VersionsApi.DeleteUpdateRequest`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | The ID of the Update Request |
Other parameters are passed through a pointer to a apiDeleteUpdateRequestRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
disconnectedNodeAcknowledged | bool | Acknowledges that this node is disconnected to allow for mutable requests to proceed. | [default to false]
VersionedFlowUpdateRequestEntity
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteVersionControlRequest(ctx, id).DisconnectedNodeAcknowledged(disconnectedNodeAcknowledged).Execute()
Deletes the version control request with the given ID
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | The request ID.
disconnectedNodeAcknowledged := true // bool | Acknowledges that this node is disconnected to allow for mutable requests to proceed. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.VersionsApi.DeleteVersionControlRequest(context.Background(), id).DisconnectedNodeAcknowledged(disconnectedNodeAcknowledged).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `VersionsApi.DeleteVersionControlRequest``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | The request ID. |
Other parameters are passed through a pointer to a apiDeleteVersionControlRequestRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
disconnectedNodeAcknowledged | bool | Acknowledges that this node is disconnected to allow for mutable requests to proceed. | [default to false]
(empty response body)
No authorization required
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string ExportFlowVersion(ctx, id).Execute()
Gets the latest version of a Process Group for download
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | The process group id.
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.VersionsApi.ExportFlowVersion(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `VersionsApi.ExportFlowVersion``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `ExportFlowVersion`: string
fmt.Fprintf(os.Stdout, "Response from `VersionsApi.ExportFlowVersion`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | The process group id. |
Other parameters are passed through a pointer to a apiExportFlowVersionRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
string
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VersionedFlowUpdateRequestEntity GetRevertRequest(ctx, id).Execute()
Returns the Revert Request with the given ID
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | The ID of the Revert Request
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.VersionsApi.GetRevertRequest(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `VersionsApi.GetRevertRequest``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetRevertRequest`: VersionedFlowUpdateRequestEntity
fmt.Fprintf(os.Stdout, "Response from `VersionsApi.GetRevertRequest`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | The ID of the Revert Request |
Other parameters are passed through a pointer to a apiGetRevertRequestRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
VersionedFlowUpdateRequestEntity
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VersionedFlowUpdateRequestEntity GetUpdateRequest(ctx, id).Execute()
Returns the Update Request with the given ID
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | The ID of the Update Request
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.VersionsApi.GetUpdateRequest(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `VersionsApi.GetUpdateRequest``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetUpdateRequest`: VersionedFlowUpdateRequestEntity
fmt.Fprintf(os.Stdout, "Response from `VersionsApi.GetUpdateRequest`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | The ID of the Update Request |
Other parameters are passed through a pointer to a apiGetUpdateRequestRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
VersionedFlowUpdateRequestEntity
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VersionControlInformationEntity GetVersionInformation(ctx, id).Execute()
Gets the Version Control information for a process group
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | The process group id.
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.VersionsApi.GetVersionInformation(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `VersionsApi.GetVersionInformation``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetVersionInformation`: VersionControlInformationEntity
fmt.Fprintf(os.Stdout, "Response from `VersionsApi.GetVersionInformation`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | The process group id. |
Other parameters are passed through a pointer to a apiGetVersionInformationRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
VersionControlInformationEntity
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VersionedFlowUpdateRequestEntity InitiateRevertFlowVersion(ctx, id).Body(body).Execute()
Initiate the Revert Request of a Process Group with the given ID
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | The process group id.
body := *openapiclient.NewVersionControlInformationEntity() // VersionControlInformationEntity | The controller service configuration details.
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.VersionsApi.InitiateRevertFlowVersion(context.Background(), id).Body(body).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `VersionsApi.InitiateRevertFlowVersion``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `InitiateRevertFlowVersion`: VersionedFlowUpdateRequestEntity
fmt.Fprintf(os.Stdout, "Response from `VersionsApi.InitiateRevertFlowVersion`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | The process group id. |
Other parameters are passed through a pointer to a apiInitiateRevertFlowVersionRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
body | VersionControlInformationEntity | The controller service configuration details. |
VersionedFlowUpdateRequestEntity
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VersionedFlowUpdateRequestEntity InitiateVersionControlUpdate(ctx, id).Body(body).Execute()
Initiate the Update Request of a Process Group with the given ID
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | The process group id.
body := *openapiclient.NewVersionControlInformationEntity() // VersionControlInformationEntity | The controller service configuration details.
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.VersionsApi.InitiateVersionControlUpdate(context.Background(), id).Body(body).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `VersionsApi.InitiateVersionControlUpdate``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `InitiateVersionControlUpdate`: VersionedFlowUpdateRequestEntity
fmt.Fprintf(os.Stdout, "Response from `VersionsApi.InitiateVersionControlUpdate`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | The process group id. |
Other parameters are passed through a pointer to a apiInitiateVersionControlUpdateRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
body | VersionControlInformationEntity | The controller service configuration details. |
VersionedFlowUpdateRequestEntity
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VersionControlInformationEntity SaveToFlowRegistry(ctx, id).Body(body).Execute()
Save the Process Group with the given ID
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | The process group id.
body := *openapiclient.NewStartVersionControlRequestEntity() // StartVersionControlRequestEntity | The versioned flow details.
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.VersionsApi.SaveToFlowRegistry(context.Background(), id).Body(body).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `VersionsApi.SaveToFlowRegistry``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `SaveToFlowRegistry`: VersionControlInformationEntity
fmt.Fprintf(os.Stdout, "Response from `VersionsApi.SaveToFlowRegistry`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | The process group id. |
Other parameters are passed through a pointer to a apiSaveToFlowRegistryRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
body | StartVersionControlRequestEntity | The versioned flow details. |
VersionControlInformationEntity
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VersionControlInformationEntity StopVersionControl(ctx, id).Version(version).ClientId(clientId).DisconnectedNodeAcknowledged(disconnectedNodeAcknowledged).Execute()
Stops version controlling the Process Group with the given ID
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | The process group id.
version := "version_example" // string | The version is used to verify the client is working with the latest version of the flow. (optional)
clientId := "clientId_example" // 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. (optional)
disconnectedNodeAcknowledged := true // bool | Acknowledges that this node is disconnected to allow for mutable requests to proceed. (optional) (default to false)
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.VersionsApi.StopVersionControl(context.Background(), id).Version(version).ClientId(clientId).DisconnectedNodeAcknowledged(disconnectedNodeAcknowledged).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `VersionsApi.StopVersionControl``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `StopVersionControl`: VersionControlInformationEntity
fmt.Fprintf(os.Stdout, "Response from `VersionsApi.StopVersionControl`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | The process group id. |
Other parameters are passed through a pointer to a apiStopVersionControlRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
version | string | The version is used to verify the client is working with the latest version of the flow. | clientId | 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. | disconnectedNodeAcknowledged | bool | Acknowledges that this node is disconnected to allow for mutable requests to proceed. | [default to false]
VersionControlInformationEntity
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VersionControlInformationEntity UpdateFlowVersion(ctx, id).Body(body).Execute()
Update the version of a Process Group with the given ID
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | The process group id.
body := *openapiclient.NewVersionedFlowSnapshotEntity() // VersionedFlowSnapshotEntity | The controller service configuration details.
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.VersionsApi.UpdateFlowVersion(context.Background(), id).Body(body).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `VersionsApi.UpdateFlowVersion``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UpdateFlowVersion`: VersionControlInformationEntity
fmt.Fprintf(os.Stdout, "Response from `VersionsApi.UpdateFlowVersion`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | The process group id. |
Other parameters are passed through a pointer to a apiUpdateFlowVersionRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
body | VersionedFlowSnapshotEntity | The controller service configuration details. |
VersionControlInformationEntity
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
VersionControlInformationEntity UpdateVersionControlRequest(ctx, id).Body(body).Execute()
Updates the request with the given ID
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "id_example" // string | The request ID.
body := *openapiclient.NewVersionControlComponentMappingEntity() // VersionControlComponentMappingEntity | The version control component mapping.
configuration := openapiclient.NewConfiguration()
api_client := openapiclient.NewAPIClient(configuration)
resp, r, err := api_client.VersionsApi.UpdateVersionControlRequest(context.Background(), id).Body(body).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `VersionsApi.UpdateVersionControlRequest``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UpdateVersionControlRequest`: VersionControlInformationEntity
fmt.Fprintf(os.Stdout, "Response from `VersionsApi.UpdateVersionControlRequest`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | The request ID. |
Other parameters are passed through a pointer to a apiUpdateVersionControlRequestRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
body | VersionControlComponentMappingEntity | The version control component mapping. |
VersionControlInformationEntity
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]