OperationInterface Interface Reference

Inheritance diagram for OperationInterface:

Public Member Functions
	getId ()
	setId ($id)
	getBulkUuid ()
	setBulkUuid ($bulkId)
	getTopicName ()
	setTopicName ($topic)
	getSerializedData ()
	setSerializedData ($serializedData)
	getResultSerializedData ()
	setResultSerializedData ($resultSerializedData)
	getStatus ()
	setStatus ($status)
	getResultMessage ()
	setResultMessage ($resultMessage)
	getErrorCode ()
	setErrorCode ($errorCode)

Data Fields
const	ID = 'id'
const	BULK_ID = 'bulk_uuid'
const	TOPIC_NAME = 'topic_name'
const	SERIALIZED_DATA = 'serialized_data'
const	RESULT_SERIALIZED_DATA = 'result_serialized_data'
const	STATUS = 'status'
const	RESULT_MESSAGE = 'result_message'
const	ERROR_CODE = 'error_code'
const	STATUS_TYPE_COMPLETE = 1
const	STATUS_TYPE_RETRIABLY_FAILED = 2
const	STATUS_TYPE_NOT_RETRIABLY_FAILED = 3
const	STATUS_TYPE_OPEN = 4
const	STATUS_TYPE_REJECTED = 5
Data Fields inherited from ExtensibleDataInterface
const	EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'

Detailed Description

Interface OperationInterface @api

Since

100.2.0

Definition at line 13 of file OperationInterface.php.

Member Function Documentation

getBulkUuid()

getBulkUuid

(

)

Get bulk uuid

Returns

string

Since

100.2.0

Implemented in Operation.

getErrorCode()

getErrorCode

(

)

Get error code

Returns

int

Since

100.2.0

Implemented in Operation.

getId()

getId

(

)

#- Operation id

Returns

int

Since

100.2.0

Implemented in Operation.

getResultMessage()

getResultMessage

(

)

Get result message

Returns

string

Since

100.2.0

Implemented in Operation.

getResultSerializedData()

getResultSerializedData

(

)

Result serialized Data

Returns

string

Since

100.3.0

Implemented in Operation.

getSerializedData()

getSerializedData

(

)

Serialized Data

Returns

string

Since

100.2.0

Implemented in Operation.

getStatus()

getStatus

(

)

Get operation status

OPEN | COMPLETE | RETRIABLY_FAILED | NOT_RETRIABLY_FAILED

Returns

int

Since

100.2.0

Implemented in Operation.

getTopicName()

getTopicName

(

)

Message Queue Topic

Returns

string

Since

100.2.0

Implemented in Operation.

setBulkUuid()

setBulkUuid

(

$bulkId

)

Set bulk uuid

Parameters

string

$bulkId

Returns

$this

Since

100.2.0

Implemented in Operation.

setErrorCode()

setErrorCode

(

$errorCode

)

Set error code

Parameters

int

$errorCode

Returns

$this

Since

100.2.0

Implemented in Operation.

setId()

setId

(

$id

)

Set operation id

Parameters

int

$id

Returns

$this

Since

100.2.0

Implemented in Operation.

setResultMessage()

setResultMessage

(

$resultMessage

)

Set result message

Parameters

string

$resultMessage

Returns

$this

Since

100.2.0

Implemented in Operation.

setResultSerializedData()

setResultSerializedData

(

$resultSerializedData

)

Set result serialized data

Parameters

string

$resultSerializedData

Returns

$this

Since

100.3.0

Implemented in Operation.

setSerializedData()

setSerializedData

(

$serializedData

)

Set serialized data

Parameters

string

$serializedData

Returns

$this

Since

100.2.0

Implemented in Operation.

setStatus()

setStatus

(

$status

)

Set status

Parameters

int

$status

Returns

$this

Since

100.2.0

Implemented in Operation.

setTopicName()

setTopicName

(

$topic

)

Set message queue topic

Parameters

string

$topic

Returns

$this

Since

100.2.0

Implemented in Operation.

Field Documentation

BULK_ID

const BULK_ID = 'bulk_uuid'

Definition at line 19 of file OperationInterface.php.

ERROR_CODE

const ERROR_CODE = 'error_code'

Definition at line 25 of file OperationInterface.php.

ID

const ID = 'id'

#+ Constants for keys of data array. Identical to the name of the getter in snake case

Definition at line 18 of file OperationInterface.php.

RESULT_MESSAGE

const RESULT_MESSAGE = 'result_message'

Definition at line 24 of file OperationInterface.php.

RESULT_SERIALIZED_DATA

const RESULT_SERIALIZED_DATA = 'result_serialized_data'

Definition at line 22 of file OperationInterface.php.

SERIALIZED_DATA

const SERIALIZED_DATA = 'serialized_data'

Definition at line 21 of file OperationInterface.php.

STATUS

const STATUS = 'status'

Definition at line 23 of file OperationInterface.php.

STATUS_TYPE_COMPLETE

const STATUS_TYPE_COMPLETE = 1

#- #+ Status types

Definition at line 31 of file OperationInterface.php.

STATUS_TYPE_NOT_RETRIABLY_FAILED

const STATUS_TYPE_NOT_RETRIABLY_FAILED = 3

Definition at line 33 of file OperationInterface.php.

STATUS_TYPE_OPEN

const STATUS_TYPE_OPEN = 4

Definition at line 34 of file OperationInterface.php.

STATUS_TYPE_REJECTED

const STATUS_TYPE_REJECTED = 5

Definition at line 35 of file OperationInterface.php.

STATUS_TYPE_RETRIABLY_FAILED

const STATUS_TYPE_RETRIABLY_FAILED = 2

Definition at line 32 of file OperationInterface.php.

TOPIC_NAME

const TOPIC_NAME = 'topic_name'

Definition at line 20 of file OperationInterface.php.

---

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

• vendor/magento/framework-bulk/OperationInterface.php