Sha256: 42f19476e3ff24048c7a647eabe7a4a231fa8bdcdf58e28c15559042b369f8eb
Contents?: true
Size: 1.83 KB
Versions: 24
Compression:
Stored size: 1.83 KB
Contents
# frozen_string_literal: true
# An [apply action](applying_manifest_blocks.md#return-value-of-apply-action)
# returns an `ApplyResult`. An `ApplyResult` is part of a `ResultSet` object and
# contains information about the apply action.
#
# @param report
# The Puppet report from the apply action. Equivalent to calling `ApplyResult.value['report']`.
# The report is a hash representation of the [`Puppet::Transaction::Report`
# object](https://puppet.com/docs/puppet/latest/format_report.html), where each property
# corresponds to a key in the report hash. For more information, see [Result
# keys](applying_manifest_blocks.md#result-keys).
# @param target
# The target the result is from.
#
# @!method action
# The action performed. `ApplyResult.action` always returns the string `apply`.
# @!method error
# Returns an Error object constructed from the `_error` field of the result's value.
# @!method message
# The `_output` field of the result's value.
# @!method ok
# Whether the result was successful.
# @!method to_data
# A serialized representation of `ApplyResult`.
# @!method value
# A hash including the Puppet report from the apply action under a `report` key.
#
Puppet::DataTypes.create_type('ApplyResult') do
interface <<-PUPPET
attributes => {
'report' => Hash[String[1], Data],
'target' => Target
},
functions => {
error => Callable[[], Optional[Error]],
ok => Callable[[], Boolean],
message => Callable[[], Optional[String]],
action => Callable[[], String],
to_data => Callable[[], Hash],
value => Callable[[], Hash]
}
PUPPET
load_file('bolt/apply_result')
# Needed for Puppet to recognize Bolt::ApplyResult as a Puppet object when deserializing
Bolt::ApplyResult.include(Puppet::Pops::Types::PuppetObject)
implementation_class Bolt::ApplyResult
end
Version data entries
24 entries across 24 versions & 1 rubygems