1description: >
2    Implement to provide Dump attributes.
3
4    Object which implements this interface must implement
5    xyz.openbmc_project.Time.EpochTime for the Dump
6    creation time.
7    Object which implements this interface should implement
8    xyz.openbmc_project.Object.Delete to allow the deletion of
9    individual Dump objects.
10
11methods:
12    - name: InitiateOffload
13      description: >
14          This method initiates the offload of the dump from the dump storage.
15          The transfer will be initiated to the target provide. The caller of
16          this function should set up a method to transfer and pass the URI to
17          to this function. If there is no exceptions the caller can assume the
18          transfer is successfully initiated. Once the transfer is completed.
19          The application which is transferring the dump should set offloaded
20          property to true to indicate offload is completed.
21      parameters:
22          - name: OffloadUri
23            type: string
24            description: >
25                The location to offload dump file, error InvalidArgument will be
26                returned if the URI is not well formated.
27      errors:
28          - xyz.openbmc_project.Common.File.Error.Open
29          - xyz.openbmc_project.Common.File.Error.Write
30          - xyz.openbmc_project.Common.Error.InvalidArgument
31          - xyz.openbmc_project.Common.Error.NotAllowed
32
33properties:
34    - name: Size
35      type: uint64
36      description: >
37          Size of the Dump.
38    - name: Offloaded
39      type: boolean
40      description: >
41          Indicates whether the dump is offloaded to a client.
42          The BMC application which knows the status of the offload
43          operation should set this to true once the entire dump is
44          offloaded.
45    - name: OffloadUri
46      type: string
47      description: >
48          The URI to write the dump file.
49