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 (and its dump object manager should
10    implement xyz.openbmc_project.Collection.DeleteAll).
11
12methods:
13    - name: InitiateOffload
14      description: >
15          This method initiates the offload of the dump from the dump storage.
16          The transfer will be initiated to the target provide. The caller of
17          this function should set up a method to transfer and pass the URI to
18          to this function. If there is no exceptions the caller can assume the
19          transfer is successfully initiated. Once the transfer is completed.
20          The application which is transferring the dump should set offloaded
21          property to true to indicate offload is completed.
22      parameters:
23          - name: OffloadUri
24            type: string
25            description: >
26                The location to offload dump file, error InvalidArgument will be
27                returned if the URI is not well formated.
28      errors:
29          - xyz.openbmc_project.Common.File.Error.Open
30          - xyz.openbmc_project.Common.File.Error.Write
31          - xyz.openbmc_project.Common.Error.InvalidArgument
32          - xyz.openbmc_project.Common.Error.NotAllowed
33          - xyz.openbmc_project.Common.Error.Unavailable
34
35properties:
36    - name: Size
37      type: uint64
38      description: >
39          Size of the Dump.
40    - name: Offloaded
41      type: boolean
42      description: >
43          Indicates whether the dump is offloaded to a client.
44          The BMC application which knows the status of the offload
45          operation should set this to true once the entire dump is
46          offloaded.
47    - name: OffloadUri
48      type: string
49      description: >
50          The URI to write the dump file.
51