Request object for fetching Binary data
Request object for fetching Binary data.
Extends
PagedRequest<BinaryRequestInput>
Constructors
Constructor
new BinaryRequest(
data):BinaryRequest
Parameters
data
BinaryRequestInput
Returns
BinaryRequest
Inherited from
Methods
transformInput()
transformInput(
input):PagedRequestInput&object&Required<PagedRequestInput>
Allows classes to transform input data (I) into data of type T. This is useful when defaulting certain parameters or otherwise providing a different public api than what the internal api requries
This is the default no-op version of the method that should be overriden when types T and I are not the same or input and output data differ
Parameters
input
BinaryRequestInput
user provided data to transform to type T
Returns
PagedRequestInput & object & Required<PagedRequestInput>
Inherited from
data()
data():
PagedRequestInput&object&Required<PagedRequestInput>
Returns data encapsulated by the Request
Returns
PagedRequestInput & object & Required<PagedRequestInput>
Inherited from
toJSON()
toJSON():
PagedRequestInput&object&Required<PagedRequestInput>
Method to allow JSON serializers to only serialize the wrapped request data without serializing any of the Request object data
Returns
PagedRequestInput & object & Required<PagedRequestInput>
See
Inherited from
validate()
validate():
BWellTransactionResult<null,ValidationError>
Validate the request.
Returns
BWellTransactionResult<null, ValidationError>
a BWellTransactionResult describing any validation errors found