/ 
Net-RDAP-0.30
River stage one • 2 direct dependents • 2 total dependents
/ Net::RDAP::Redaction

NAME

Net::RDAP::Redaction - a module representing a redacted field in an RDAP response.

DESCRIPTION

Any RDAP object which inherits from Net::RDAP::Object has a redactions() method which will return an array of Net::RDAP::Redaction objects representing the fields identified by the server as being redacted (if any).

METHODS

Redacted Field Name

$name = $field->name;

Returns the logical name for the redacted field, which may be registered or unregistered (see Section 4.2 of RFC 9537).

Redaction Method

$method = $field->method;

Returns one of removal, emptyValue, partialValue or replacementValue.

JSON Path Expression Language

$lang = $field->pathLang;

Returns the JSON path expression language used, which is jsonpath by default.

JSON Paths

$prePath = $field->prePath;

Returns the path expression referencing the redacted field in the pre-redacted response (if any).

$postPath = $field->postPath;

Returns the path expression referencing a redacted field in the redacted (post-redacted) response (if any).

$replacementPath = $field->replacementPath;

Returns the path expression of the replacement field of the redacted field when the redaction method is replacementValue.

Reason

$reason = $field->reason;
$lang = $field->reasonLang;

$field->reason returns the human-readable reason(s) why the field has been redacted. $field->reasonLang returns the language of the reason, which is en by default.

COPYRIGHT

Copyright 2024 Gavin Brown. All rights reserved.

LICENSE

Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of the author not be used in advertising or publicity pertaining to distribution of the software without specific prior written permission.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.