108 lines
2.2 KiB
YAML
108 lines
2.2 KiB
YAML
|
name: SqsJob
|
||
|
|
class_comment: null
|
||
|
|
dependencies:
|
||
|
|
- name: SqsClient
|
||
|
|
type: class
|
||
|
|
source: Aws\Sqs\SqsClient
|
||
|
|
- name: Container
|
||
|
|
type: class
|
||
|
|
source: Illuminate\Container\Container
|
||
|
|
- name: JobContract
|
||
|
|
type: class
|
||
|
|
source: Illuminate\Contracts\Queue\Job
|
||
|
|
properties:
|
||
|
|
- name: sqs
|
||
|
|
visibility: protected
|
||
|
|
comment: '# * The Amazon SQS client instance.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @var \Aws\Sqs\SqsClient'
|
||
|
|
- name: job
|
||
|
|
visibility: protected
|
||
|
|
comment: '# * The Amazon SQS job instance.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @var array'
|
||
|
|
methods:
|
||
|
|
- name: __construct
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: container
|
||
|
|
- name: sqs
|
||
|
|
- name: job
|
||
|
|
- name: connectionName
|
||
|
|
- name: queue
|
||
|
|
comment: "# * The Amazon SQS client instance.\n# *\n# * @var \\Aws\\Sqs\\SqsClient\n\
|
||
|
|
# */\n# protected $sqs;\n# \n# /**\n# * The Amazon SQS job instance.\n# *\n# *\
|
||
|
|
\ @var array\n# */\n# protected $job;\n# \n# /**\n# * Create a new job instance.\n\
|
||
|
|
# *\n# * @param \\Illuminate\\Container\\Container $container\n# * @param \\\
|
||
|
|
Aws\\Sqs\\SqsClient $sqs\n# * @param array $job\n# * @param string $connectionName\n\
|
||
|
|
# * @param string $queue\n# * @return void"
|
||
|
|
- name: release
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: delay
|
||
|
|
default: '0'
|
||
|
|
comment: '# * Release the job back into the queue after (n) seconds.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param int $delay
|
||
|
|
|
||
|
|
# * @return void'
|
||
|
|
- name: delete
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Delete the job from the queue.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return void'
|
||
|
|
- name: attempts
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Get the number of times the job has been attempted.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return int'
|
||
|
|
- name: getJobId
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Get the job identifier.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return string'
|
||
|
|
- name: getRawBody
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Get the raw body string for the job.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return string'
|
||
|
|
- name: getSqs
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Get the underlying SQS client instance.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return \Aws\Sqs\SqsClient'
|
||
|
|
- name: getSqsJob
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Get the underlying raw SQS job.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return array'
|
||
|
|
traits:
|
||
|
|
- Aws\Sqs\SqsClient
|
||
|
|
- Illuminate\Container\Container
|
||
|
|
interfaces:
|
||
|
|
- JobContract
|