class documentation

class R_2_instances_name_shutdown(baserlib.OpcodeResource):

View In Hierarchy

/2/instances/[instance_name]/shutdown resource.

Implements an instance shutdown.

Method GetPutOpInput Shutdown an instance.

Inherited from OpcodeResource:

Class Variable DELETE_FORBIDDEN Set this to disable listed parameters and optionally specific values from being set through the DELETE handler (see baserlib.InspectParams)
Class Variable DELETE_OPCODE Set this to a class derived from opcodes.OpCode to automatically generate a DELETE handler submitting the opcode
Class Variable DELETE_RENAME Set this to rename parameters in the DELETE handler (see baserlib.FillOpcode)
Class Variable GET_ALIASES Set this to duplicate return values in GET results (see baserlib.GetHandler)
Class Variable GET_FORBIDDEN Set this to disable listed parameters and optionally specific values from being set through the GET handler (see baserlib.InspectParams)
Class Variable GET_OPCODE Set this to a class derived from opcodes.OpCode to automatically generate a GET handler submitting the opcode
Class Variable GET_RENAME Set this to rename parameters in the GET handler (see baserlib.FillOpcode)
Class Variable POST_FORBIDDEN Set this to disable listed parameters and optionally specific values from being set through the POST handler (see baserlib.InspectParams)
Class Variable POST_OPCODE Set this to a class derived from opcodes.OpCode to automatically generate a POST handler submitting the opcode
Class Variable POST_RENAME Set this to rename parameters in the POST handler (see baserlib.FillOpcode)
Class Variable PUT_FORBIDDEN Set this to disable listed parameters and optionally specific values from being set through the PUT handler (see baserlib.InspectParams)
Class Variable PUT_OPCODE Set this to a class derived from opcodes.OpCode to automatically generate a PUT handler submitting the opcode
Class Variable PUT_RENAME Set this to rename parameters in the PUT handler (see baserlib.FillOpcode)
Instance Variable GetDeleteOpInput Define this to override the default method for getting opcode parameters (see baserlib.OpcodeResource._GetDefaultData)
Instance Variable GetGetOpInput Define this to override the default method for getting opcode parameters (see baserlib.OpcodeResource._GetDefaultData)
Instance Variable GetPostOpInput Define this to override the default method for getting opcode parameters (see baserlib.OpcodeResource._GetDefaultData)
Method _ForbiddenHandler Examines provided parameters for forbidden values.
Method _GenericHandler Undocumented
Method _GetCommonStatic Return the static parameters common to all the RAPI calls
Method _GetDefaultData Undocumented
Method _GetDepends Undocumented
Method _GetRapiOpName Extracts the name of the RAPI operation from the class name

Inherited from ResourceBase (via OpcodeResource):

Method __init__ Generic resource constructor.
Method dryRun Check if the request specifies dry-run mode.
Method getBodyParameter Check and return the value for a given parameter.
Method GetClient Wrapper for luxi.Client with HTTP-specific error handling.
Method SubmitJob Generic wrapper for submit job, for better http compatibility.
Method useBulk Check if the request specifies bulk querying.
Method useForce Check if the request specifies a forced operation.
Method useLocking Check if the request specifies locking.
Constant DELETE_ACCESS Undocumented
Constant GET_ACCESS Undocumented
Constant POST_ACCESS Undocumented
Constant PUT_ACCESS Undocumented
Class Variable request_body Undocumented
Instance Variable items Undocumented
Instance Variable queryargs Undocumented
Method _checkIntVariable Return the parsed value of an int argument.
Method _checkStringVariable Return the parsed value of a string argument.
Method _GetRequestBody Returns the body data.
Instance Variable _client_cls Undocumented
Instance Variable _req Undocumented
def GetPutOpInput(self):

Shutdown an instance.