Skip to content

Latest commit

 

History

History
392 lines (268 loc) · 11.3 KB

FlowfilequeuesApi.md

File metadata and controls

392 lines (268 loc) · 11.3 KB
Raw

FlowfilequeuesApi

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

Method HTTP request Description
createDropRequest POST /flowfile-queues/{id}/drop-requests Creates a request to drop the contents of the queue in this connection.
createFlowFileListing POST /flowfile-queues/{id}/listing-requests Lists the contents of the queue in this connection.
deleteListingRequest DELETE /flowfile-queues/{id}/listing-requests/{listing-request-id} Cancels and/or removes a request to list the contents of this connection.
downloadFlowFileContent GET /flowfile-queues/{id}/flowfiles/{flowfile-uuid}/content Gets the content for a FlowFile in a Connection.
getDropRequest GET /flowfile-queues/{id}/drop-requests/{drop-request-id} Gets the current status of a drop request for the specified connection.
getFlowFile GET /flowfile-queues/{id}/flowfiles/{flowfile-uuid} Gets a FlowFile from a Connection.
getListingRequest GET /flowfile-queues/{id}/listing-requests/{listing-request-id} Gets the current status of a listing request for the specified connection.
removeDropRequest DELETE /flowfile-queues/{id}/drop-requests/{drop-request-id} Cancels and/or removes a request to drop the contents of this connection.

createDropRequest

DropRequestEntity createDropRequest(id)

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

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowfilequeuesApi;


FlowfilequeuesApi apiInstance = new FlowfilequeuesApi();
String id = "id_example"; // String | The connection id.
try {
    DropRequestEntity result = apiInstance.createDropRequest(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowfilequeuesApi#createDropRequest");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String The connection id.

Return type

DropRequestEntity

Authorization

No authorization required

HTTP request headers

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

createFlowFileListing

ListingRequestEntity createFlowFileListing(id)

Lists the contents of the queue in this connection.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowfilequeuesApi;


FlowfilequeuesApi apiInstance = new FlowfilequeuesApi();
String id = "id_example"; // String | The connection id.
try {
    ListingRequestEntity result = apiInstance.createFlowFileListing(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowfilequeuesApi#createFlowFileListing");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String The connection id.

Return type

ListingRequestEntity

Authorization

No authorization required

HTTP request headers

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

deleteListingRequest

DropRequestEntity deleteListingRequest(id, listingRequestId)

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

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowfilequeuesApi;


FlowfilequeuesApi apiInstance = new FlowfilequeuesApi();
String id = "id_example"; // String | The connection id.
String listingRequestId = "listingRequestId_example"; // String | The listing request id.
try {
    DropRequestEntity result = apiInstance.deleteListingRequest(id, listingRequestId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowfilequeuesApi#deleteListingRequest");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String The connection id.
listingRequestId String The listing request id.

Return type

DropRequestEntity

Authorization

No authorization required

HTTP request headers

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

downloadFlowFileContent

downloadFlowFileContent(id, flowfileUuid, clientId, clusterNodeId)

Gets the content for a FlowFile in a Connection.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowfilequeuesApi;


FlowfilequeuesApi apiInstance = new FlowfilequeuesApi();
String id = "id_example"; // String | The connection id.
String flowfileUuid = "flowfileUuid_example"; // String | The flowfile uuid.
String clientId = "clientId_example"; // String | If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response.
String clusterNodeId = "clusterNodeId_example"; // String | The id of the node where the content exists if clustered.
try {
    apiInstance.downloadFlowFileContent(id, flowfileUuid, clientId, clusterNodeId);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowfilequeuesApi#downloadFlowFileContent");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String The connection id.
flowfileUuid String The flowfile uuid.
clientId String If the client id is not specified, new one will be generated. This value (whether specified or generated) is included in the response. [optional]
clusterNodeId String The id of the node where the content exists if clustered. [optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: /
  • Accept: /

getDropRequest

DropRequestEntity getDropRequest(id, dropRequestId)

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

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowfilequeuesApi;


FlowfilequeuesApi apiInstance = new FlowfilequeuesApi();
String id = "id_example"; // String | The connection id.
String dropRequestId = "dropRequestId_example"; // String | The drop request id.
try {
    DropRequestEntity result = apiInstance.getDropRequest(id, dropRequestId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowfilequeuesApi#getDropRequest");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String The connection id.
dropRequestId String The drop request id.

Return type

DropRequestEntity

Authorization

No authorization required

HTTP request headers

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

getFlowFile

getFlowFile(id, flowfileUuid, clusterNodeId)

Gets a FlowFile from a Connection.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowfilequeuesApi;


FlowfilequeuesApi apiInstance = new FlowfilequeuesApi();
String id = "id_example"; // String | The connection id.
String flowfileUuid = "flowfileUuid_example"; // String | The flowfile uuid.
String clusterNodeId = "clusterNodeId_example"; // String | The id of the node where the content exists if clustered.
try {
    apiInstance.getFlowFile(id, flowfileUuid, clusterNodeId);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowfilequeuesApi#getFlowFile");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String The connection id.
flowfileUuid String The flowfile uuid.
clusterNodeId String The id of the node where the content exists if clustered. [optional]

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

getListingRequest

ListingRequestEntity getListingRequest(id, listingRequestId)

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

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowfilequeuesApi;


FlowfilequeuesApi apiInstance = new FlowfilequeuesApi();
String id = "id_example"; // String | The connection id.
String listingRequestId = "listingRequestId_example"; // String | The listing request id.
try {
    ListingRequestEntity result = apiInstance.getListingRequest(id, listingRequestId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowfilequeuesApi#getListingRequest");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String The connection id.
listingRequestId String The listing request id.

Return type

ListingRequestEntity

Authorization

No authorization required

HTTP request headers

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

removeDropRequest

DropRequestEntity removeDropRequest(id, dropRequestId)

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

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.FlowfilequeuesApi;


FlowfilequeuesApi apiInstance = new FlowfilequeuesApi();
String id = "id_example"; // String | The connection id.
String dropRequestId = "dropRequestId_example"; // String | The drop request id.
try {
    DropRequestEntity result = apiInstance.removeDropRequest(id, dropRequestId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FlowfilequeuesApi#removeDropRequest");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String The connection id.
dropRequestId String The drop request id.

Return type

DropRequestEntity

Authorization

No authorization required

HTTP request headers

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