BulkSummary Class Reference

Inheritance diagram for BulkSummary:

Public Member Functions
	getBulkId ()
	setBulkId ($bulkUuid)
	getDescription ()
	setDescription ($description)
	getStartTime ()
	setStartTime ($timestamp)
	getUserId ()
	setUserId ($userId)
	getUserType ()
	setUserType ($userType)
	getOperationCount ()
	setOperationCount ($operationCount)
	getExtensionAttributes ()
	setExtensionAttributes (\Magento\AsynchronousOperations\Api\Data\BulkSummaryExtensionInterface $extensionAttributes)
Public Member Functions inherited from DataObject
	__construct (array $data=[])
	addData (array $arr)
	setData ($key, $value=null)
	unsetData ($key=null)
	getData ($key='', $index=null)
	getDataByPath ($path)
	getDataByKey ($key)
	setDataUsingMethod ($key, $args=[])
	getDataUsingMethod ($key, $args=null)
	hasData ($key='')
	toArray (array $keys=[])
	convertToArray (array $keys=[])
	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	toJson (array $keys=[])
	convertToJson (array $keys=[])
	toString ($format='')
	__call ($method, $args)
	isEmpty ()
	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
	debug ($data=null, &$objects=[])
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	offsetGet ($offset)

Additional Inherited Members
Data Fields inherited from BulkSummaryInterface
const	BULK_ID = 'uuid'
const	DESCRIPTION = 'description'
const	START_TIME = 'start_time'
const	USER_ID = 'user_id'
const	OPERATION_COUNT = 'operation_count'
const	NOT_STARTED = 0
const	IN_PROGRESS = 1
const	FINISHED_SUCCESSFULLY = 2
const	FINISHED_WITH_FAILURE = 3
Data Fields inherited from ExtensibleDataInterface
const	EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)
Protected Attributes inherited from DataObject
	$_data = []
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Class BulkSummary

Definition at line 15 of file BulkSummary.php.

Member Function Documentation

getBulkId()

getBulkId

(

)

@inheritDoc

Implements BulkSummaryInterface.

Definition at line 20 of file BulkSummary.php.

    {
        return $this->getData(self::BULK_ID);
    }

getDescription()

getDescription

(

)

@inheritDoc

Implements BulkSummaryInterface.

Definition at line 36 of file BulkSummary.php.

    {
        return $this->getData(self::DESCRIPTION);
    }

getExtensionAttributes()

getExtensionAttributes

(

)

Retrieve existing extension attributes object.

Returns

\Magento\AsynchronousOperations\Api\Data\BulkSummaryExtensionInterface|null

Definition at line 118 of file BulkSummary.php.

    {
        return $this->getData(self::EXTENSION_ATTRIBUTES_KEY);
    }

getOperationCount()

getOperationCount

(

)

@inheritDoc

Implements BulkSummaryInterface.

Definition at line 100 of file BulkSummary.php.

    {
        return $this->getData(self::OPERATION_COUNT);
    }

getStartTime()

getStartTime

(

)

@inheritDoc

Implements BulkSummaryInterface.

Definition at line 52 of file BulkSummary.php.

    {
        return $this->getData(self::START_TIME);
    }

getUserId()

getUserId

(

)

@inheritDoc

Implements BulkSummaryInterface.

Definition at line 68 of file BulkSummary.php.

    {
        return $this->getData(self::USER_ID);
    }

getUserType()

getUserType

(

)

@inheritDoc

Definition at line 84 of file BulkSummary.php.

    {
        return $this->getData(self::USER_TYPE);
    }

setBulkId()

setBulkId

(

$bulkUuid

)

@inheritDoc

Implements BulkSummaryInterface.

Definition at line 28 of file BulkSummary.php.

    {
        return $this->setData(self::BULK_ID, $bulkUuid);
    }

setDescription()

setDescription

(

$description

)

@inheritDoc

Implements BulkSummaryInterface.

Definition at line 44 of file BulkSummary.php.

    {
        return $this->setData(self::DESCRIPTION, $description);
    }

setExtensionAttributes()

setExtensionAttributes

(

\Magento\AsynchronousOperations\Api\Data\BulkSummaryExtensionInterface

$extensionAttributes

)

Set an extension attributes object.

Parameters

\Magento\AsynchronousOperations\Api\Data\BulkSummaryExtensionInterface

$extensionAttributes

Returns

$this

Definition at line 129 of file BulkSummary.php.

      {
        return $this->setData(self::EXTENSION_ATTRIBUTES_KEY, $extensionAttributes);
    }

setOperationCount()

setOperationCount

(

$operationCount

)

@inheritDoc

Implements BulkSummaryInterface.

Definition at line 108 of file BulkSummary.php.

    {
        return $this->setData(self::OPERATION_COUNT, $operationCount);
    }

setStartTime()

setStartTime

(

$timestamp

)

@inheritDoc

Implements BulkSummaryInterface.

Definition at line 60 of file BulkSummary.php.

    {
        return $this->setData(self::START_TIME, $timestamp);
    }

setUserId()

setUserId

(

$userId

)

@inheritDoc

Implements BulkSummaryInterface.

Definition at line 76 of file BulkSummary.php.

    {
        return $this->setData(self::USER_ID, $userId);
    }

setUserType()

setUserType

(

$userType

)

@inheritDoc

Definition at line 92 of file BulkSummary.php.

    {
        return $this->setData(self::USER_TYPE, $userType);
    }

---

The documentation for this class was generated from the following file:

• vendor/magento/module-asynchronous-operations/Model/BulkSummary.php