The identity and technical contract details declared by the specification.
Error
object
An object returned on an error.
2 properties
ServiceMeta
object
Metadata about a service
5 properties
5 required
EventSummary
object
An event summary
6 properties
5 required
Event
object
An event
16 properties
6 required
MetricValue
object
A metric value
2 properties
2 required
MetricChartData
object
Chart data of metrics
6 properties
5 required
MetricChartFrequencyTolerance
object
Frequency tolerance for a metric chart
2 properties
2 required
MetricChartAlert
object
Thresholds associated with a metric
3 properties
1 required
MetricChart
object
A metric chart
7 properties
6 required
MetricUnit
object
Metric unit
7 properties
3 required
AlertCondition
object
Alert condition
4 properties
4 required
AlertFrequencyUnit
object
Alert frequency unit
3 properties
3 required
MetricSummary
object
Metric summary
13 properties
2 required
ProjectMeta
object
Metadata about a project.
3 properties
3 required
ImportFlowDefinitionRequest
object
Request object for ImportFlowDefinition
6 properties
2 required
ImportFlowDefinitionResponse
object
Response object for ImportFlowDefinition
10 properties
3 required
ImportFlowDefinitionVersionRequest
object
Request object for ImportFlowDefinitionVersion
4 properties
2 required
ImportFlowDefinitionVersionResponse
object
Response object for ImportFlowDefinitionVersion
8 properties
1 required
FlowSummary
object
A summarized version of a flow, mostly useful in listing flows
7 properties
4 required
Flow
object
A representation of a versioned data flow.
10 properties
3 required
ArtifactVersion
object
A representation of a artifact detail version
8 properties
5 required
FlowVersion
object
A representation of a flow detail version
9 properties
1 required
ListFlowDefinitionsRequest
object
Request object for the ListFlowDefinitions method.
5 properties
ListFlowDefinitionsResponse
object
Response object for the ListFlowDefinitions method.
2 properties
DeleteFlowRequest
object
Request object for the DeleteFlow method
1 property
1 required
DeleteFlowResponse
object
Response object for the DeleteFlow method
1 property
DescribeFlowRequest
object
Request object for the DescribeFlow method
1 property
1 required
DescribeFlowResponse
object
Response object for the DescribeFlow method
1 property
ReadyflowSummary
object
A summarized version of a ready flow, mostly useful in listing flows
8 properties
2 required
ReadyflowDetails
object
A detailed representation of a ready flow.
13 properties
3 required
ListReadyflowsRequest
object
Request object for the ListReadyflows method.
3 properties
ListReadyflowsResponse
object
Response object for the ListReadyflows method.
2 properties
DescribeReadyflowRequest
object
Request object for the DescribeReadyflow method
1 property
1 required
DescribeReadyflowResponse
object
Response object for the DescribeReadyflow method
1 property
AddedReadyflowDetails
object
A detailed representation of a ready flow as added by the current account
3 properties
1 required
DescribeAddedReadyflowRequest
object
Request object for the DescribeAddedReadyflow method
1 property
1 required
DescribeAddedReadyflowResponse
object
Response object for the DescribeAddedReadyflow method
1 property
AddReadyflowRequest
object
Request object for the AddReadyflow method
1 property
1 required
AddReadyflowResponse
object
Response object for the AddReadyflow method
1 property
DeleteAddedReadyflowRequest
object
Request object for the DeleteAddedReadyFlow method
1 property
1 required
DeleteAddedReadyflowResponse
object
Response object for the DeleteAddedReadyflow method
1 property
GetFlowVersionRequest
object
Request object for the GetFlowVersion method.
1 property
1 required
GetFlowVersionResponse
object
Response object for the GetFlowVersion method.
1 property
CreateFlowVersionTagRequest
object
Request object for the CreateFlowVersionTag method.
3 properties
2 required
CreateFlowVersionTagResponse
object
Response object for the CreateVersionTag method.
1 property
1 required
DeleteFlowVersionTagRequest
object
Request object for the DeleteFlowVersionTag method.
2 properties
2 required
DeleteFlowVersionTagResponse
object
Response object for the DeleteVersionTag method.
1 property
1 required
FlowDefinitionTagData
object
A representation of an artifact version tag.
2 properties
1 required
FlowDefinitionVersionTagData
object
A representation of an artifact version tag.
2 properties
1 required
FlowVersionTag
object
A representation of an artifact version tag.
2 properties
1 required
ListFlowVersionTagsRequest
object
Request object for the ListFlowVersionTags method.
1 property
1 required
ListFlowVersionTagsResponse
object
Response object for the ListFlowVersionTags method.
1 property
ListFlowDefinitionVersionsRequest
object
Request object for the ListFlowDefinitionVersions method.
2 properties
1 required
ListFlowDefinitionVersionsResponse
object
Response object for the ListFlowDefinitionVersions method.
1 property
CatalogCollection
object
A catalog collection.
5 properties
DeleteCollectionRequest
object
Request object when deleting a catalog collection.
1 property
1 required
DeleteCollectionResponse
object
Response object when deleting a catalog collection.
1 property
DescribeCollectionRequest
object
Request object when describing a catalog collection.
1 property
1 required
DescribeCollectionResponse
object
Response object when describing a catalog collection.
1 property
CreateCollectionRequest
object
Request object when creating a catalog collection.
2 properties
1 required
CreateCollectionResponse
object
Response object when creating a catalog collection.
1 property
ListCollectionsRequest
object
Request object when listing collections.
4 properties
ListCollectionsResponse
object
Response object when listing collections.
2 properties
UpdateCollectionRequest
object
Request object when updating a catalog collection.
3 properties
1 required
UpdateCollectionResponse
object
Response object when updating a catalog collection.
1 property
AssignToCollectionRequest
object
Request object when assigning a flow to a catalog collection.
2 properties
1 required
AssignToCollectionResponse
object
Response object when assigning a flow to a catalog collection.
1 property
InitiateDeploymentRequest
object
A request to initiate a deployment.
3 properties
2 required
InitiateDeploymentResponse
object
A response from initiating a deployment.
2 properties
2 required
InitiateFlowInDeploymentRequest
object
A request to initiate the flow creation process in a deployment.
4 properties
3 required
InitiateFlowInDeploymentResponse
object
A response from initiating the flow creation process in a deployment.
2 properties
2 required
DeploymentState
string
The state that the deployment is currently in.
DeploymentStatus
object
The status of a deployment.
3 properties
3 required
DeploymentSummary
object
A deployment summary.
9 properties
5 required
Deployment
object
A deployment.
27 properties
6 required
FilterOption
object
A filter option.
3 properties
2 required
ListFilterOptionsRequest
object
A request to list filter options.
1 property
1 required
ListFilterOptionsResponse
object
A response to list filter options.
1 property
ListDeploymentsRequest
object
A request to list deployments.
5 properties
ListDeploymentsResponse
object
A response from listing deployments.
2 properties
DescribeFlowInDeploymentRequest
object
A request to describe a flow in a deployment.
2 properties
2 required
DescribeFlowInDeploymentResponse
object
A response to describe a flow in a deployment.
1 property
DescribeDeploymentRequest
object
A request to describe a deployment.
1 property
1 required
DescribeDeploymentResponse
object
A response to describe a deployment.
1 property
ListDeploymentKPIsRequest
object
A request to list deployment KPIs.
2 properties
2 required
ListDeploymentKPIsResponse
object
A response to list deployment KPIs.
1 property
ListDeploymentSystemMetricsRequest
object
A request to list deployment system metrics.
2 properties
2 required
ListDeploymentSystemMetricsResponse
object
A response to list deployment system metrics.
1 property
ListDeploymentActiveAlertsRequest
object
A request to list active alerts for deployment.
2 properties
1 required
ListDeploymentActiveAlertsResponse
object
A response to list active alerts for deployment.
1 property
ListDeploymentEventsRequest
object
A request to list event history for deployment.
6 properties
1 required
ListDeploymentEventsResponse
object
A response to list event history for deployment.
2 properties
ListFlowEventsInDeploymentRequest
object
A request to list flow event history in a deployment.
6 properties
2 required
ListFlowEventsInDeploymentResponse
object
A response to list flow event history in a deployment.
2 properties
ListFlowKpisInDeploymentRequest
object
A request to list KPI metrics for a flow in a deployment.
3 properties
3 required
ListFlowKpisInDeploymentResponse
object
A response to list KPI metrics for a flow in a deployment.
1 property
ListFlowActiveAlertsInDeploymentRequest
object
A request to list active alerts for a flow in a deployment.
3 properties
2 required
ListFlowActiveAlertsInDeploymentResponse
object
A response to list active alerts for a flow in a deployment.
1 property
DescribeDeploymentEventDetailRequest
object
A request to describe event details for deployment.
2 properties
2 required
DescribeDeploymentEventDetailResponse
object
A response to describe event details for deployment.
1 property
DescribeFlowEventDetailInDeploymentRequest
object
A request to describe flow event details in a deployment.
3 properties
3 required
DescribeFlowEventDetailInDeploymentResponse
object
A response to describe flow event details in a deployment.
1 property
EventDetail
object
Event details.
2 properties
DeployedFlowState
string
The state that the deployed flow is currently in. "DEPLOYING" indicates that the flow is in the process of being deployed. "GOODHEALTH" indicates that the flow…
DeployedFlowStatus
object
The status of the flow being deployed.
3 properties
2 required
DeployedFlow
object
A flow, potentially one of many, deployed inside a deployment.
15 properties
4 required
DeployedFlowSummary
object
A deployed flow summary.
8 properties
4 required
ListFlowsInDeploymentRequest
object
A request to list the flows in a deployment.
6 properties
1 required
ListFlowsInDeploymentResponse
object
A response from listing flows in a deployment.
2 properties
DiagnosticsDestination
string
DiagnosticsDestination enum.
DiagnosticsCollectionScope
string
DiagnosticsCollectionScope enum.
DiagnosticsEnvironmentComponent
string
DiagnosticsEnvironmentComponent enum.
EncryptionParameters
object
The encryption parameters used by the DataFlow service for K8s secret encryption and EBS volume encryption.
2 properties
1 required
EncryptionStrategy
string
The encryption strategy used by the DataFlow service.
ServiceState
string
The state of the service.
ServiceStatus
object
The status of a DataFlow enabled service.
3 properties
1 required
ServiceSummary
object
The summary of the DF Service enabled in a CDP Environment
19 properties
9 required
Service
object
The DataFlow view of a CDP service.
36 properties
10 required
ListServicesRequest
object
Request object for the ListServices method.
4 properties
ListServicesResponse
object
Response object for the ListServices method.
2 properties
ListDeployableServicesForNewDeploymentsRequest
object
Request object for the ListDeployableServicesForNewDeploymentsRequest method.
ListDeployableServicesForNewDeploymentsResponse
object
Response object for the ListDeployableServicesForNewDeploymentsRequest method.
1 property
DescribeServiceRequest
object
Request object for the DescribeService method.
1 property
1 required
DescribeServiceResponse
object
Response object for the DescribeService method.
1 property
ListServiceSystemMetricsRequest
object
A request to list service system metrics
2 properties
2 required
ListServiceSystemMetricsResponse
object
A response to list service system metrics
1 property
EnableServiceRequest
object
Request object for EnableService
16 properties
4 required
EnableServiceResponse
object
Response object for EnableService
1 property
DisableServiceRequest
object
Request object for DisableService
3 properties
1 required
DisableServiceResponse
object
Response object for DisableService
1 property
UpdateServiceRequest
object
Request object for UpdateService
6 properties
3 required
UpdateServiceResponse
object
Response object for UpdateService
1 property
RenewCertificatesRequest
object
Request object for RenewCertificates
1 property
1 required
RenewCertificatesResponse
object
Response object for RenewCertificates
RotatePasswordRequest
object
Request object for RotatePassword
1 property
1 required
RotatePasswordResponse
object
Response object for RotatePassword
UpdateNodeImagesRequest
object
Request object for UpdateNodeImages
1 property
1 required
UpdateNodeImagesResponse
object
Response object for UpdateNodeImages
ListServiceActiveAlertsRequest
object
Request object for ListServiceActiveAlerts
2 properties
1 required
ListServiceActiveAlertsResponse
object
Response object for ListServiceActiveAlerts
1 property
ListServiceEventsRequest
object
Request object for ListServiceEvents
4 properties
1 required
ListServiceEventsResponse
object
Response object for ListServiceEvents
1 property
DescribeServiceEventDetailRequest
object
Request object for DescribeServiceEventDetail
2 properties
2 required
DescribeServiceEventDetailResponse
object
Response object for DescribeServiceEventDetail
1 property
ResetServiceRequest
object
Request object for ResetService
1 property
1 required
ResetServiceResponse
object
Response object for ResetService
GrantUserKubernetesAccessRequest
object
The request for granting access
2 properties
2 required
GrantUserKubernetesAccessResponse
object
The response for granting access
1 property
1 required
ListUserKubernetesAccessRequest
object
The request for listing the users that have access to a cluster
1 property
1 required
ListUserKubernetesAccessResponse
object
The response for listing the users that have access to a cluster
1 property
RevokeUserKubernetesAccessRequest
object
The request for revoking access
2 properties
2 required
RevokeUserKubernetesAccessResponse
object
The response for revoking access
1 property
1 required
UpgradeServiceRequest
object
Request object for UpgradeService
3 properties
1 required
UpgradeServiceResponse
object
Response object for UpgradeService
1 property
ListDiagnosticsRequest
object
A request to list past and present diagnostics for a given DataFlow Service.
4 properties
1 required
DiagnosticsStatus
string
Diagnostics status enum.
ListDiagnosticsResponseItem
object
Object representation of a diagnostics request list item.
13 properties
4 required
ListDiagnosticsResponse
object
Response object for ListDiagnostics.
2 properties
StartGetDiagnosticsCollectionRequest
object
Request to start DataFlow diagnostics bundle creation.
10 properties
3 required
StartGetDiagnosticsCollectionResponse
object
Response object for StartGetDiagnosticsCollection.
1 property
1 required
GetKubeconfigRequest
object
Request object for GetKubeconfig.
1 property
1 required
GetKubeconfigResponse
object
Response object for GetKubeconfig.
1 property
1 required
ListNotificationsRequest
object
The request for retrieving notifications
1 property
1 required
ListNotificationsResponse
object
The response for retrieving notifications
1 property
Notification
object
A notification for an event
8 properties
8 required
Project
object
A Project
8 properties
6 required
CreateProjectRequest
object
A request to create a Project
3 properties
2 required
CreateProjectResponse
object
A response to create a Project
1 property
ProjectFilterOption
object
A filter option
3 properties
2 required
ListProjectFilterOptionsRequest
object
A request to list filter options
1 property
1 required
ListProjectFilterOptionsResponse
object
A response to list filter options
1 property
ListProjectsRequest
object
A request to list Projects
4 properties
ListProjectsResponse
object
A response to list Projects
2 properties
DescribeProjectRequest
object
A request to describe a Project
1 property
1 required
DescribeProjectResponse
object
A response to describe a Project
1 property
1 required
UpdateProjectRequest
object
A request to describe a Project
4 properties
2 required
UpdateProjectResponse
object
A response to describe a Project
1 property
1 required
DeleteProjectRequest
object
A request to delete a Project
2 properties
2 required
DeleteProjectResponse
object
A response to delete a Project
CancelDeleteProjectRequest
object
A request to cancel the deletion of a Project that is deleting
2 properties
2 required
CancelDeleteProjectResponse
object
A response to cancelling the deletion of a Project
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Cloudera publishes across the network.