HerdApi

Abstract Value Members

abstract def getAllNamespaces: NamespaceKeys

Retrieve all namespace keys.
Retrieve all namespace keys.
returns
List of namespace keys
abstract def getBusinessObjectByName(namespace: String, businessObjectName: String): BusinessObjectDefinition

Retrieve the business object definition by the namespace and business object values.
Retrieve the business object definition by the namespace and business object values.
namespace
The namespace name
businessObjectName
The business object definition name
returns
The business object definition
abstract def getBusinessObjectData(namespace: String, businessObjectName: String, formatUsage: String, formatFileType: String, formatVersion: Integer, partitionKey: String, partitionValue: String, subPartitionValues: Seq[String], dataVersion: Integer): BusinessObjectData

Get the business object data based on the specified parameters
Get the business object data based on the specified parameters
namespace
The namespace
businessObjectName
The business object definition name
formatUsage
The business object format usage (e.g. PRC).
formatFileType
The business object format file type (e.g. GZ).
formatVersion
The version of the business object format (e.g. 0).
partitionKey
The business object format partition key.
partitionValue
The partition value that the data is associated with (e.g. a specific trade date such as 20140401).
subPartitionValues
list of sub partition values
dataVersion
The version of the business object data (e.g. 0).
returns
the business object data
abstract def getBusinessObjectDataAvailability(namespace: String, businessObjectName: String, formatUsage: String, formatFileType: String, partitionKey: String, firstPartitionValue: String, lastPartitionValue: String): BusinessObjectDataAvailability

Retrieves the business object data availability
Retrieves the business object data availability
namespace
The namespace
businessObjectName
The business object definition name
formatUsage
The business object format usage (e.g. PRC).
formatFileType
The business object format file type (e.g. GZ).
partitionKey
The business object format partition key.
firstPartitionValue
The first partition value
lastPartitionValue
The last partition value
returns
The business object data availability
abstract def getBusinessObjectDataGenerateDdl(namespace: String, businessObjectName: String, formatUsage: String, formatFileType: String, formatVersion: Integer, partitionKey: String, partitionValues: Seq[String], dataVersion: Integer): BusinessObjectDataDdl

Retrieves the DDL to initialize the specified type of the database system (e.
Retrieves the DDL to initialize the specified type of the database system (e.g. Hive) to perform queries for a range of requested business object data in the optionally specified storage of the S3 storage platform type.
namespace
The namespace
businessObjectName
The business object definition name
formatUsage
The business object format usage (e.g. PRC).
formatFileType
The business object format file type (e.g. GZ).
formatVersion
The version of the business object format (e.g. 0).
partitionKey
The business object format partition key.
partitionValues
The list of partition values that the data is associated with (e.g. a specific trade date such as 20140401).
dataVersion
The version of the business object data (e.g. 0).
returns
The business object data DDL
abstract def getBusinessObjectFormat(namespace: String, businessObjectName: String, formatUsage: String, formatFileType: String, formatVersion: Integer): BusinessObjectFormat

Retrieve a single business object format
Retrieve a single business object format
namespace
The namespace value
businessObjectName
The business object definition name
formatUsage
The business object format usage (e.g. PRC).
formatFileType
The business object format file type (e.g. GZ).
formatVersion
The version of the business object format (e.g. 0).
returns
single business object format
abstract def getBusinessObjectFormats(namespace: String, businessObjectName: String, latestBusinessObjectFormatVersion: Boolean = true): BusinessObjectFormatKeys

Retrieve list of business object formats based on the namespace and business object definition
Retrieve list of business object formats based on the namespace and business object definition
namespace
The namespace
businessObjectName
The business object definition name
returns
list of business object formats
abstract def getBusinessObjectPartitions(namespace: String, businessObjectName: String, formatUsage: String, formatFileType: String, formatVersion: Integer, partitionFilter: Option[PartitionFilter]): Seq[(Integer, String, Seq[String], Integer)]

Retrieve all available partitions
Retrieve all available partitions
namespace
The namespace
businessObjectName
The business object definition name
formatUsage
The business object format usage (e.g. PRC).
formatFileType
The business object format file type (e.g. GZ).
formatVersion
The version of the business object format (e.g. 0).
partitionFilter
the partition filter
returns
list of partitions
abstract def getBusinessObjectsByNamespace(namespace: String): BusinessObjectDefinitionKeys

Retrieve all business object definitions by namespace.
Retrieve all business object definitions by namespace.
namespace
The namespace name
returns
List of business object definition keys
abstract def getNamespaceByNamespaceCode(namespaceCode: String): Namespace

Retrieve namespace by namespace code.
Retrieve namespace by namespace code.
namespaceCode
The namespace code
returns
The namespace.
abstract def getStorage(name: String): Storage

Gets information about an existing storage.
Gets information about an existing storage.
name
storage name
returns
The storage
abstract def registerBusinessObject(namespace: String, businessObjectName: String, dataProvider: String): Unit

Create a business object definition
Create a business object definition
namespace
The namespace value
businessObjectName
The business object definition
dataProvider
The name of a valid data provider known by the system.
abstract def registerBusinessObjectData(namespace: String, businessObjectName: String, formatUsage: String, formatFileType: String, formatVersion: Integer, partitionKey: String, partitionValue: String, subPartitionValues: Seq[String], status: ObjectStatus.Value, storageName: String, storageDirectory: Option[String] = None): (Integer, Seq[StorageUnit])

Create a business object data based on the specified parameters
Create a business object data based on the specified parameters
namespace
namespace
businessObjectName
business object definition name
formatUsage
The business object format usage (e.g. PRC).
formatFileType
The business object format file type (e.g. GZ).
formatVersion
The version of the business object format (e.g. 0).
partitionKey
The business object format partition key.
partitionValue
The partition value that the data is associated with (e.g. a specific trade date such as 20140401).
subPartitionValues
list of sub partitions
status
the status of the business object data(UPLOADING, VALID, INVALID...etc)
storageName
the storage name
storageDirectory
the storage directory
returns
the business object data
abstract def registerBusinessObjectFormat(namespace: String, businessObjectName: String, formatUsage: String, formatFileType: String, partitionKey: String, schema: Option[Schema]): Integer

Create a new business object format
Create a new business object format
namespace
The namespace
businessObjectName
The business object definition name
formatUsage
The business object format usage (e.g. PRC).
formatFileType
The business object format file type (e.g. GZ).
partitionKey
The business object format partition key.
schema
An optional schema associated with this business object format.
returns
business object format version
abstract def removeBusinessObjectData(namespace: String, businessObjectName: String, formatUsage: String, formatFileType: String, formatVersion: Integer, partitionKey: String, partitionValue: String, subPartitionValues: Seq[String], dataVersion: Integer): Unit

Deletes an existing business object data based on the specified parameters.
Deletes an existing business object data based on the specified parameters.
namespace
The namespace
businessObjectName
The business object definition name
formatUsage
The business object format usage (e.g. PRC).
formatFileType
The business object format file type (e.g. GZ).
formatVersion
The version of the business object format (e.g. 0).
partitionKey
The business object format partition key.
partitionValue
The partition value that the data is associated with (e.g. a specific trade date such as 20140401).
subPartitionValues
The list of subpartition values of the business object data.
dataVersion
The version of the business object data (e.g. 0).
abstract def removeBusinessObjectDefinition(namespace: String, businessObjectName: String): Unit

Deletes an existing business object definition based on the specified parameters.
Deletes an existing business object definition based on the specified parameters.
namespace
The namespace
businessObjectName
The business object definition name
abstract def removeBusinessObjectFormat(namespace: String, businessObjectName: String, formatUsage: String, formatFileType: String, formatVersion: Integer): Unit

Deletes an existing business object format based on the specified parameters.
Deletes an existing business object format based on the specified parameters.
namespace
The namespace
businessObjectName
The business object definition name
formatUsage
The business object format usage (e.g. PRC).
formatFileType
The business object format file type (e.g. GZ).
formatVersion
The version of the business object format (e.g. 0).
abstract def searchBusinessObjectData(businessObjectDataSearchRequest: BusinessObjectDataSearchRequest, pageNum: Integer = 1, pageSize: Integer = 1000): BusinessObjectDataSearchResult

Search the business object data based on the specified parameters
Search the business object data based on the specified parameters
businessObjectDataSearchRequest
The search request
pageNum
The page number
pageSize
The page size
returns
the business object data search result
abstract def setStorageFiles(namespace: String, businessObjectName: String, formatUsage: String, formatFileType: String, formatVersion: Integer, partitionKey: String, partitionValue: String, subPartitionValues: Seq[String], dataVersion: Integer, storageName: String, files: Seq[(String, Long)]): Unit

Add storage files to an existing storage unit in a business object data
Add storage files to an existing storage unit in a business object data
namespace
namespace
businessObjectName
business object definition name
formatUsage
The business object format usage (e.g. PRC).
formatFileType
The business object format file type (e.g. GZ).
formatVersion
The version of the business object format (e.g. 0).
partitionKey
The business object format partition key.
partitionValue
The partition value that the data is associated with (e.g. a specific trade date such as 20140401).
subPartitionValues
The list of subpartition values of the business object data.
dataVersion
The version of the business object data (e.g. 0).
storageName
The storage name
files
The list of storage files that need to be added to the storage unit
abstract def updateBusinessObjectData(namespace: String, businessObjectName: String, formatUsage: String, formatFileType: String, formatVersion: Integer, partitionKey: String, partitionValue: String, subPartitionValues: Seq[String], dataVersion: Integer, status: ObjectStatus.Value): Unit

Updates an existing business object data based on the specified parameters.
Updates an existing business object data based on the specified parameters.
namespace
The namespace
businessObjectName
The business object definition name
formatUsage
The business object format usage (e.g. PRC).
formatFileType
The business object format file type (e.g. GZ).
formatVersion
The version of the business object format (e.g. 0).
partitionKey
The business object format partition key.
partitionValue
The partition value that the data is associated with (e.g. a specific trade date such as 20140401).
subPartitionValues
The list of subpartition values of the business object data.
dataVersion
The version of the business object data (e.g. 0).
status
The business object data status

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

trait HerdApi extends AnyRef

Abstract Value Members

abstract def getAllNamespaces: NamespaceKeys

abstract def getBusinessObjectByName(namespace: String, businessObjectName: String): BusinessObjectDefinition

abstract def getBusinessObjectData(namespace: String, businessObjectName: String, formatUsage: String, formatFileType: String, formatVersion: Integer, partitionKey: String, partitionValue: String, subPartitionValues: Seq[String], dataVersion: Integer): BusinessObjectData

abstract def getBusinessObjectDataAvailability(namespace: String, businessObjectName: String, formatUsage: String, formatFileType: String, partitionKey: String, firstPartitionValue: String, lastPartitionValue: String): BusinessObjectDataAvailability

abstract def getBusinessObjectDataGenerateDdl(namespace: String, businessObjectName: String, formatUsage: String, formatFileType: String, formatVersion: Integer, partitionKey: String, partitionValues: Seq[String], dataVersion: Integer): BusinessObjectDataDdl

abstract def getBusinessObjectFormat(namespace: String, businessObjectName: String, formatUsage: String, formatFileType: String, formatVersion: Integer): BusinessObjectFormat

abstract def getBusinessObjectFormats(namespace: String, businessObjectName: String, latestBusinessObjectFormatVersion: Boolean = true): BusinessObjectFormatKeys

abstract def getBusinessObjectPartitions(namespace: String, businessObjectName: String, formatUsage: String, formatFileType: String, formatVersion: Integer, partitionFilter: Option[PartitionFilter]): Seq[(Integer, String, Seq[String], Integer)]

abstract def getBusinessObjectsByNamespace(namespace: String): BusinessObjectDefinitionKeys

abstract def getNamespaceByNamespaceCode(namespaceCode: String): Namespace

abstract def getStorage(name: String): Storage

abstract def registerBusinessObject(namespace: String, businessObjectName: String, dataProvider: String): Unit

abstract def registerBusinessObjectFormat(namespace: String, businessObjectName: String, formatUsage: String, formatFileType: String, partitionKey: String, schema: Option[Schema]): Integer

abstract def removeBusinessObjectData(namespace: String, businessObjectName: String, formatUsage: String, formatFileType: String, formatVersion: Integer, partitionKey: String, partitionValue: String, subPartitionValues: Seq[String], dataVersion: Integer): Unit

abstract def removeBusinessObjectDefinition(namespace: String, businessObjectName: String): Unit

abstract def removeBusinessObjectFormat(namespace: String, businessObjectName: String, formatUsage: String, formatFileType: String, formatVersion: Integer): Unit

abstract def searchBusinessObjectData(businessObjectDataSearchRequest: BusinessObjectDataSearchRequest, pageNum: Integer = 1, pageSize: Integer = 1000): BusinessObjectDataSearchResult

abstract def updateBusinessObjectData(namespace: String, businessObjectName: String, formatUsage: String, formatFileType: String, formatVersion: Integer, partitionKey: String, partitionValue: String, subPartitionValues: Seq[String], dataVersion: Integer, status: ObjectStatus.Value): Unit

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped