51 lines
1.6 KiB
Markdown
51 lines
1.6 KiB
Markdown
# <a id="importrequest"></a>`class ImportRequest(BaseRequest)`
|
|
|
|
Base class for requests using the request / response pattern.
|
|
|
|
Subclasses **must** set the ``RESPONSE_CLASS`` attribute to a subclass of
|
|
the :class:`BaseResponse` which defines the fields that the response will
|
|
use. They must also define additional attributes as :class:`Field`s.
|
|
|
|
For example::
|
|
|
|
class TLSResponse(BaseResponse):
|
|
key = Field('Private key for the cert')
|
|
cert = Field('Public cert info')
|
|
|
|
|
|
class TLSRequest(BaseRequest):
|
|
RESPONSE_CLASS = TLSResponse
|
|
|
|
common_name = Field('Common Name (CN) for the cert to be created')
|
|
sans = Field('List of Subject Alternative Names (SANs)')
|
|
|
|
## <a id="importrequest-egress_subnets"></a>`egress_subnets`
|
|
|
|
Subnets over which network traffic to the requester will flow.
|
|
|
|
## <a id="importrequest-ingress_address"></a>`ingress_address`
|
|
|
|
Address to use if a connection to the requester is required.
|
|
|
|
## <a id="importrequest-is_created"></a>`is_created`
|
|
|
|
Whether this request was created by this side of the relation.
|
|
|
|
## <a id="importrequest-is_received"></a>`is_received`
|
|
|
|
Whether this request was received by the other side of the relation.
|
|
|
|
## <a id="importrequest-respond"></a>`def respond(self, success, reason=None)`
|
|
|
|
Acknowledge this request, and indicate success or failure with an
|
|
optional explanation.
|
|
|
|
# <a id="importresponse"></a>`class ImportResponse(BaseResponse)`
|
|
|
|
Base class for responses using the request / response pattern.
|
|
|
|
## <a id="importresponse-name"></a>`name`
|
|
|
|
The name given when the import was requested.
|
|
|