api/laravel/Queue/Failed/DynamoDbFailedJobProvider.yaml
2024-09-26 02:03:21 -07:00

140 lines
2.8 KiB
YAML

name: DynamoDbFailedJobProvider
class_comment: null
dependencies:
- name: DynamoDbClient
type: class
source: Aws\DynamoDb\DynamoDbClient
- name: DateTimeInterface
type: class
source: DateTimeInterface
- name: Exception
type: class
source: Exception
- name: Carbon
type: class
source: Illuminate\Support\Carbon
- name: Date
type: class
source: Illuminate\Support\Facades\Date
properties:
- name: dynamo
visibility: protected
comment: '# * The DynamoDB client instance.
# *
# * @var \Aws\DynamoDb\DynamoDbClient'
- name: applicationName
visibility: protected
comment: '# * The application name.
# *
# * @var string'
- name: table
visibility: protected
comment: '# * The table name.
# *
# * @var string'
methods:
- name: __construct
visibility: public
parameters:
- name: dynamo
- name: applicationName
- name: table
comment: "# * The DynamoDB client instance.\n# *\n# * @var \\Aws\\DynamoDb\\DynamoDbClient\n\
# */\n# protected $dynamo;\n# \n# /**\n# * The application name.\n# *\n# * @var\
\ string\n# */\n# protected $applicationName;\n# \n# /**\n# * The table name.\n\
# *\n# * @var string\n# */\n# protected $table;\n# \n# /**\n# * Create a new DynamoDb\
\ failed job provider.\n# *\n# * @param \\Aws\\DynamoDb\\DynamoDbClient $dynamo\n\
# * @param string $applicationName\n# * @param string $table\n# * @return\
\ void"
- name: log
visibility: public
parameters:
- name: connection
- name: queue
- name: payload
- name: exception
comment: '# * Log a failed job into storage.
# *
# * @param string $connection
# * @param string $queue
# * @param string $payload
# * @param \Throwable $exception
# * @return string|int|null'
- name: ids
visibility: public
parameters:
- name: queue
default: 'null'
comment: '# * Get the IDs of all of the failed jobs.
# *
# * @param string|null $queue
# * @return array'
- name: all
visibility: public
parameters: []
comment: '# * Get a list of all of the failed jobs.
# *
# * @return array'
- name: find
visibility: public
parameters:
- name: id
comment: '# * Get a single failed job.
# *
# * @param mixed $id
# * @return object|null'
- name: forget
visibility: public
parameters:
- name: id
comment: '# * Delete a single failed job from storage.
# *
# * @param mixed $id
# * @return bool'
- name: flush
visibility: public
parameters:
- name: hours
default: 'null'
comment: '# * Flush all of the failed jobs from storage.
# *
# * @param int|null $hours
# * @return void
# *
# * @throws \Exception'
traits:
- Aws\DynamoDb\DynamoDbClient
- DateTimeInterface
- Exception
- Illuminate\Support\Carbon
- Illuminate\Support\Facades\Date
interfaces:
- FailedJobProviderInterface