Package co.cask.cdap.proto

Interface Summary

Interface	Description
Containers	Containers define methods to get and add information about YARN containers.

Class Summary

Class	Description
ApplicationDetail	Represents an application returned for /apps/{app-id}.
ApplicationRecord	Represents item in the list from /apps
BasicThrowable	Maintains basic information about a Throwable, for easy serialization/deserialization.
BatchProgram	Array components of the batch status request to POST /namespaces/{namespace}/status.
BatchProgramResult	Describes the results returned by the batch stop/start endpoints POST /namespaces/{namespace}/stop|start.
BatchProgramStart	Array components of the batch start request to POST /namespaces/{namespace}/start.
BatchProgramStatus	Describes the status of a program, as returned by the batch status endpoint POST /namespaces/{namespace}/status.
BatchRunnable	Array components of the batch status request to POST /namespaces/{namespace}/instances.
BatchRunnableInstances	Describes the instances of a program, as returned by the batch instances endpoint POST /namespaces/{namespace}/instances.
ColumnDesc	Represents a column inside a query result.
ConfigEntry	Represents an entry in Configuration or co.cask.cdap.common.conf.CConfiguration.
Containers.ContainerInfo	POJO holding information about container running in YARN.
DatasetDetail	Represents a dataset in an HTTP response.
DatasetInstanceConfiguration	POJO that carries dataset type and properties information for create dataset request
DatasetMeta	Dataset instance metadata.
DatasetModuleMeta	Dataset module meta data
DatasetRecord	Represents a dataset in an HTTP response.
DatasetSpecificationSummary	Summary of a DatasetSpecification.
DatasetTypeMeta	Dataset type meta data
DistributedProgramLiveInfo	Live info for distributed mode, adds yarn app id and container information.
Id	Deprecated As of 3.3.0, use EntityId.
Id.Application	Deprecated As of 3.3.0, use ApplicationId.
Id.Artifact	Deprecated As of 3.3.0, use ArtifactId.
Id.DatasetInstance	Deprecated As of 3.3.0, use DatasetId.
Id.DatasetModule	Deprecated As of 3.3.0, use DatasetModuleId.
Id.DatasetType	Deprecated As of 3.3.0, use DatasetTypeId.
Id.Flow	Deprecated As of 3.3.0, use ProgramId.
Id.Flow.Flowlet	Deprecated As of 3.3.0, use FlowletId.
Id.Flow.Flowlet.Queue	Deprecated As of 3.3.0, use FlowletQueueId.
Id.Namespace	Deprecated As of 3.3.0, use NamespaceId.
Id.NamespacedId	Deprecated As of 3.3.0, use NamespacedId.
Id.NotificationFeed	Deprecated As of 3.3.0, use NotificationFeedId.
Id.NotificationFeed.Builder	Deprecated
Id.Program	Deprecated As of 3.3.0, use ProgramId.
Id.QueryHandle	Deprecated As of 3.3.0, use QueryId.
Id.Run	Deprecated As of 3.3.0, use ProgramRunId.
Id.Schedule	Deprecated As of 3.3.0, use ScheduleId.
Id.Service	Deprecated As of 3.3.0, use ProgramId.
Id.Stream	Deprecated As of 3.3.0, use StreamId.
Id.Stream.View	Deprecated As of 3.3.0, use StreamViewId.
Id.SystemService	Deprecated As of 3.3.0, use SystemServiceId.
Id.Worker	Deprecated As of 3.3.0, use ProgramId.
Id.Workflow	Deprecated As of 3.3.0, use ProgramId.
InMemoryProgramLiveInfo	A live info for in-memory runtime envirnment.
Instances	Represents the number of instances a program currently is running with.
MetricQueryRequest	Metrics Query Request format
MetricQueryResult	Represents metric query result.
MetricQueryResult.TimeSeries	Represents time series of a metric.
MetricQueryResult.TimeValue	Represents time value of a metric.
MetricTagValue	Represents tag and its value associated with metrics data points.
MRJobInfo	Simplified (filtered) representation of a MapReduce Job.
MRTaskInfo	Simplified (filtered) representation of a MapReduce Task
NamespaceConfig	Represents the configuration of a namespace.
NamespaceMeta	Represents metadata for namespaces
NamespaceMeta.Builder	Builder used to build NamespaceMeta
NotRunningProgramLiveInfo
PercentileInformation	This class keeps track of the percentiles, and run ids for a particular percentile.
PluginDetail	Represents a plugin id and name in an HTTP response.
PluginInstanceDetail	Represents a plugin instance in an HTTP Response
ProgramLiveInfo	Represents information about running programs.
ProgramRecord	Represents a program in an HTTP response.
ProgramTypes	Provides mapping from ProgramSpecification to ProgramType.
QueryHandle	Represents a submitted query operation.
QueryInfo	Information about the query.
QueryResult	Represents query result.
QueryStatus	Represents the status of a submitted query operation.
RestartServiceInstancesStatus	Class to describe status of restart instances of service request.
RunRecord	This class records information for a particular run.
ScheduledRuntime	Represents scheduled run time.
ServiceInstances	Represents the number of instances a service currently is running with.
StreamDetail	Represents a stream in an HTTP response.
StreamProperties	Represents the properties of a stream.
SystemServiceLiveInfo	Live info for a system service.
SystemServiceLiveInfo.Builder
SystemServiceMeta	Metadata about a CDAP system service.
TableInfo	Schema and other extended information about a Hive table.
TableInfo.ColumnInfo	Column information, containing name, type and comment.
TableNameInfo	Basic information about a Hive table.
Version	Represents the current software version.
ViewDetail	Represents a view in an HTTP response.
ViewSpecification	Represents the configuration of a stream view, used when creating or updating a view.
WorkflowNodeStateDetail	Class to represent the state of the node in the Workflow.
WorkflowStatistics	Class that is used to return the statistics of a workflow
WorkflowStatsComparison	Returns an object that has a map from WorkflowRunId to time and a list of metrics per ProgramRun which are further divided into run that the action took in a specific workflow.
WorkflowStatsComparison.ProgramNodes	Contains information about a Program and the statistics that correspond to it divided per run of the workflow that the program ran in.
WorkflowStatsComparison.ProgramNodes.WorkflowProgramDetails	Contains information of Workflow Runs and the metrics of the program associated with it.
WorkflowTokenDetail	Class to represent WorkflowToken for a give workflow run.
WorkflowTokenDetail.NodeValueDetail	Class to represent node -> value mapping for a given key in a WorkflowToken.
WorkflowTokenNodeDetail	Class to represent WorkflowToken for a given workflow run at a given node.

Enum Summary

Enum	Description
Containers.ContainerType	ContainerTypes - System Service, and for various program types
ProgramRunStatus	Program Status Types used to query program runs
ProgramStatus	Program level status types.
ProgramType	Defines types of programs supported by the system.
QueryStatus.OpStatus	Represents the status of an operation.
RestartServiceInstancesStatus.RestartStatus	Defining the status of the restart instances request.