class Hoodoo::Client::Endpoint::HTTPBased::DescriptionOfRequest
Describe a request for HTTP-like endpoints.
Attributes
The action to perform - a Symbol from Hoodoo::Services::Middleware::ALLOWED_ACTIONS.
Optional Hash of body data for actions :create
and :update
.
An optional String indicating a relative or absolute file path to the location of a .pem format Certificate Authority file (trust store), which may include multliple certificates. The certificates in the file will be used by Net::HTTP to validate the SSL Ceritificate Chain presented by remote servers, when calling endpoints over HTTPS with Hoodoo::Client
.
Default nil
value should be used in nearly all cases and uses Ruby OpenSSL defaults which are generally Operating System provided.
A Hoodoo::Services::Discovery
“For…” family member instance giving information required to ‘find’ the target resource. The required class instance depends upon the endpoint in use.
Optional Float indicating the Net::HTTP open timeout value.
This is a value in seconds (default 60) for which the client will wait while attempting to connect to a server.
If the connection attempt is still running after the timeout, the request is aborted and a platform.timeout
error returned.
See also http_timeout
.
This operates at the HTTP
transport level and is independent of any higher level timeouts that might be set up.
Optional Float indicating the Net::HTTP read timeout value.
This is a value in seconds (default 60) for which the client will wait while attempting to read data from a server in any individual TCP read operation. The timeout becomes active immediately after a server connection is established.
If a read attempt is still running after the timeout, the request is aborted and a platform.timeout
error returned.
See also http_open_timeout
.
This operates at the HTTP
transport level and is independent of any higher level timeouts that might be set up.
Optional resource identifier for actions :show
, :update
and :delete
:
Full URI (as a URI object) of an HTTP
proxy to use as an override to ENV['HTTP_PROXY']
which Ruby itself will otherwise read. Will be nil
for no proxy override.
Optional Hash of query data.