• 홈
• DataSift_Historic

PHP 클래스 DataSift_Historic

This software is the intellectual property of MediaSift Ltd., and is covered by retained intellectual property rights, including copyright. Distribution of this software is strictly forbidden under the terms of this license. The DataSift_Historic class represents a historic query. 파일 보기 프로젝트 열기: datasift/datasift-php 1 사용 예제들

보호된 프로퍼티들

프로퍼티	타입	설명
$_availability		Data availablility information.
$_created_at		Historics query creation time
$_deleted		Set to true if the Historics query has been deleted.
$_dpus		Number of DPUs consumed
$_end		End date and time
$_estimated_completion		The estimated completion timestamp
$_hash		The stream hash.
$_name		Historics query name.
$_playback_id		Playback ID
$_progress		Progress counter
$_sample		Sample size
$_sources		Data sources.
$_start		Start date and time
$_status		Historics query status
$_user		The user object.

공개 메소드들

메소드	설명
__construct ( DataSift_User $user, string $hash, integer $start = false, integer $end = false, array $sources = false, string $name = false, integer $sample = 100 )	Constructor. Pass all fields to create a new historic, or provide a User object and a playback_id as the $hash parameter to load an existing query from the API.
delete ( ) : void	Delete this historic query.
getAvailability ( ) : array	Returns the data availability information for this historic. If the historic has not yet been prepared that will be done automagically to obtain the cost.
getCreatedAt ( ) : integer	Returns the created at date. To refresh this from the server call reloadData().
getDPUs ( ) : integer	Returns the DPU cost of running this historic. If the historic has not yet been prepared that will be done automagically to obtain the cost.
getEndDate ( ) : integer	Returns the end date.
getEstimatedCompletion ( ) : integer	Returns the estimated completion in UTC timestamp
getHash ( ) : string	Returns the playback ID for this historic. If the historic has not yet been prepared that will be done automagically to obtain the ID.
getName ( ) : string	Returns the name.
getProgress ( ) : double	Returns the current progress.
getPushSubscriptions ( DataSift_User $user, integer $page = 1, integer $per_page = 20, String $order_by = self::ORDERBY_CREATED_AT, String $order_dir = self::ORDERDIR_ASC, boolean $include_finished = false )	Get a page of push subscriptions for this historic query, where each page contains up to $per_page items. Results will be returned in the order requested.
getSample ( ) : double	Returns the sample.
getSources ( ) : integer	Returns the sources.
getStartDate ( ) : integer	Returns the start date.
getStatus ( ) : string	Returns the status. To refresh this from the server call reloadData().
getStreamHash ( ) : string	Returns the stream hash.
listHistorics ( DataSift_User $user, integer $page = 1, integer $per_page = 20 )	List Historics queries.
pause ( string $reason = false ) : void	Pause this historic query.
prepare ( ) : void	Call the DataSift API to prepare this historic query.
reloadData ( )	Reload the data for this object from the API.
resume ( ) : void	Resumes this historic query.
setName ( string $name ) : void	Sets the name.
start ( ) : void	Start this historic query.
stop ( ) : void	Stop this historic query.

보호된 메소드들

메소드	설명
generateName ( ) : string	Generate a name based on the current date/time.
initFromArray ( array $data )	Initialise this object from the data in the given array.

메소드 상세

프로퍼티 상세