package
0.15.3
Repository: https://github.com/768bit/firecracker-go-sdk.git
Documentation: pkg.go.dev

# Functions

New creates a new operations API client.
NewClient will return a new client with the given transport and formats.
NewCreateSyncActionBadRequest creates a CreateSyncActionBadRequest with default headers values.
NewCreateSyncActionDefault creates a CreateSyncActionDefault with default headers values.
NewCreateSyncActionNoContent creates a CreateSyncActionNoContent with default headers values.
NewCreateSyncActionParams creates a new CreateSyncActionParams object with the default values initialized.
NewCreateSyncActionParamsWithContext creates a new CreateSyncActionParams object with the default values initialized, and the ability to set a context for a request.
NewCreateSyncActionParamsWithHTTPClient creates a new CreateSyncActionParams object with the default values initialized, and the ability to set a custom HTTPClient for a request.
NewCreateSyncActionParamsWithTimeout creates a new CreateSyncActionParams object with the default values initialized, and the ability to set a timeout on a request.
NewDescribeInstanceDefault creates a DescribeInstanceDefault with default headers values.
NewDescribeInstanceOK creates a DescribeInstanceOK with default headers values.
NewDescribeInstanceParams creates a new DescribeInstanceParams object with the default values initialized.
NewDescribeInstanceParamsWithContext creates a new DescribeInstanceParams object with the default values initialized, and the ability to set a context for a request.
NewDescribeInstanceParamsWithHTTPClient creates a new DescribeInstanceParams object with the default values initialized, and the ability to set a custom HTTPClient for a request.
NewDescribeInstanceParamsWithTimeout creates a new DescribeInstanceParams object with the default values initialized, and the ability to set a timeout on a request.
NewGetMachineConfigurationDefault creates a GetMachineConfigurationDefault with default headers values.
NewGetMachineConfigurationOK creates a GetMachineConfigurationOK with default headers values.
NewGetMachineConfigurationParams creates a new GetMachineConfigurationParams object with the default values initialized.
NewGetMachineConfigurationParamsWithContext creates a new GetMachineConfigurationParams object with the default values initialized, and the ability to set a context for a request.
NewGetMachineConfigurationParamsWithHTTPClient creates a new GetMachineConfigurationParams object with the default values initialized, and the ability to set a custom HTTPClient for a request.
NewGetMachineConfigurationParamsWithTimeout creates a new GetMachineConfigurationParams object with the default values initialized, and the ability to set a timeout on a request.
NewGetMmdsBadRequest creates a GetMmdsBadRequest with default headers values.
NewGetMmdsDefault creates a GetMmdsDefault with default headers values.
NewGetMmdsOK creates a GetMmdsOK with default headers values.
NewGetMmdsParams creates a new GetMmdsParams object with the default values initialized.
NewGetMmdsParamsWithContext creates a new GetMmdsParams object with the default values initialized, and the ability to set a context for a request.
NewGetMmdsParamsWithHTTPClient creates a new GetMmdsParams object with the default values initialized, and the ability to set a custom HTTPClient for a request.
NewGetMmdsParamsWithTimeout creates a new GetMmdsParams object with the default values initialized, and the ability to set a timeout on a request.
NewPatchGuestDriveByIDBadRequest creates a PatchGuestDriveByIDBadRequest with default headers values.
NewPatchGuestDriveByIDDefault creates a PatchGuestDriveByIDDefault with default headers values.
NewPatchGuestDriveByIDNoContent creates a PatchGuestDriveByIDNoContent with default headers values.
NewPatchGuestDriveByIDParams creates a new PatchGuestDriveByIDParams object with the default values initialized.
NewPatchGuestDriveByIDParamsWithContext creates a new PatchGuestDriveByIDParams object with the default values initialized, and the ability to set a context for a request.
NewPatchGuestDriveByIDParamsWithHTTPClient creates a new PatchGuestDriveByIDParams object with the default values initialized, and the ability to set a custom HTTPClient for a request.
NewPatchGuestDriveByIDParamsWithTimeout creates a new PatchGuestDriveByIDParams object with the default values initialized, and the ability to set a timeout on a request.
NewPatchGuestNetworkInterfaceByIDBadRequest creates a PatchGuestNetworkInterfaceByIDBadRequest with default headers values.
NewPatchGuestNetworkInterfaceByIDDefault creates a PatchGuestNetworkInterfaceByIDDefault with default headers values.
NewPatchGuestNetworkInterfaceByIDNoContent creates a PatchGuestNetworkInterfaceByIDNoContent with default headers values.
NewPatchGuestNetworkInterfaceByIDParams creates a new PatchGuestNetworkInterfaceByIDParams object with the default values initialized.
NewPatchGuestNetworkInterfaceByIDParamsWithContext creates a new PatchGuestNetworkInterfaceByIDParams object with the default values initialized, and the ability to set a context for a request.
NewPatchGuestNetworkInterfaceByIDParamsWithHTTPClient creates a new PatchGuestNetworkInterfaceByIDParams object with the default values initialized, and the ability to set a custom HTTPClient for a request.
NewPatchGuestNetworkInterfaceByIDParamsWithTimeout creates a new PatchGuestNetworkInterfaceByIDParams object with the default values initialized, and the ability to set a timeout on a request.
NewPatchMachineConfigurationBadRequest creates a PatchMachineConfigurationBadRequest with default headers values.
NewPatchMachineConfigurationDefault creates a PatchMachineConfigurationDefault with default headers values.
NewPatchMachineConfigurationNoContent creates a PatchMachineConfigurationNoContent with default headers values.
NewPatchMachineConfigurationParams creates a new PatchMachineConfigurationParams object with the default values initialized.
NewPatchMachineConfigurationParamsWithContext creates a new PatchMachineConfigurationParams object with the default values initialized, and the ability to set a context for a request.
NewPatchMachineConfigurationParamsWithHTTPClient creates a new PatchMachineConfigurationParams object with the default values initialized, and the ability to set a custom HTTPClient for a request.
NewPatchMachineConfigurationParamsWithTimeout creates a new PatchMachineConfigurationParams object with the default values initialized, and the ability to set a timeout on a request.
NewPatchMmdsBadRequest creates a PatchMmdsBadRequest with default headers values.
NewPatchMmdsDefault creates a PatchMmdsDefault with default headers values.
NewPatchMmdsNoContent creates a PatchMmdsNoContent with default headers values.
NewPatchMmdsParams creates a new PatchMmdsParams object with the default values initialized.
NewPatchMmdsParamsWithContext creates a new PatchMmdsParams object with the default values initialized, and the ability to set a context for a request.
NewPatchMmdsParamsWithHTTPClient creates a new PatchMmdsParams object with the default values initialized, and the ability to set a custom HTTPClient for a request.
NewPatchMmdsParamsWithTimeout creates a new PatchMmdsParams object with the default values initialized, and the ability to set a timeout on a request.
NewPutGuestBootSourceBadRequest creates a PutGuestBootSourceBadRequest with default headers values.
NewPutGuestBootSourceDefault creates a PutGuestBootSourceDefault with default headers values.
NewPutGuestBootSourceNoContent creates a PutGuestBootSourceNoContent with default headers values.
NewPutGuestBootSourceParams creates a new PutGuestBootSourceParams object with the default values initialized.
NewPutGuestBootSourceParamsWithContext creates a new PutGuestBootSourceParams object with the default values initialized, and the ability to set a context for a request.
NewPutGuestBootSourceParamsWithHTTPClient creates a new PutGuestBootSourceParams object with the default values initialized, and the ability to set a custom HTTPClient for a request.
NewPutGuestBootSourceParamsWithTimeout creates a new PutGuestBootSourceParams object with the default values initialized, and the ability to set a timeout on a request.
NewPutGuestDriveByIDBadRequest creates a PutGuestDriveByIDBadRequest with default headers values.
NewPutGuestDriveByIDDefault creates a PutGuestDriveByIDDefault with default headers values.
NewPutGuestDriveByIDNoContent creates a PutGuestDriveByIDNoContent with default headers values.
NewPutGuestDriveByIDParams creates a new PutGuestDriveByIDParams object with the default values initialized.
NewPutGuestDriveByIDParamsWithContext creates a new PutGuestDriveByIDParams object with the default values initialized, and the ability to set a context for a request.
NewPutGuestDriveByIDParamsWithHTTPClient creates a new PutGuestDriveByIDParams object with the default values initialized, and the ability to set a custom HTTPClient for a request.
NewPutGuestDriveByIDParamsWithTimeout creates a new PutGuestDriveByIDParams object with the default values initialized, and the ability to set a timeout on a request.
NewPutGuestNetworkInterfaceByIDBadRequest creates a PutGuestNetworkInterfaceByIDBadRequest with default headers values.
NewPutGuestNetworkInterfaceByIDDefault creates a PutGuestNetworkInterfaceByIDDefault with default headers values.
NewPutGuestNetworkInterfaceByIDNoContent creates a PutGuestNetworkInterfaceByIDNoContent with default headers values.
NewPutGuestNetworkInterfaceByIDParams creates a new PutGuestNetworkInterfaceByIDParams object with the default values initialized.
NewPutGuestNetworkInterfaceByIDParamsWithContext creates a new PutGuestNetworkInterfaceByIDParams object with the default values initialized, and the ability to set a context for a request.
NewPutGuestNetworkInterfaceByIDParamsWithHTTPClient creates a new PutGuestNetworkInterfaceByIDParams object with the default values initialized, and the ability to set a custom HTTPClient for a request.
NewPutGuestNetworkInterfaceByIDParamsWithTimeout creates a new PutGuestNetworkInterfaceByIDParams object with the default values initialized, and the ability to set a timeout on a request.
NewPutGuestVsockByIDBadRequest creates a PutGuestVsockByIDBadRequest with default headers values.
NewPutGuestVsockByIDCreated creates a PutGuestVsockByIDCreated with default headers values.
NewPutGuestVsockByIDDefault creates a PutGuestVsockByIDDefault with default headers values.
NewPutGuestVsockByIDNoContent creates a PutGuestVsockByIDNoContent with default headers values.
NewPutGuestVsockByIDParams creates a new PutGuestVsockByIDParams object with the default values initialized.
NewPutGuestVsockByIDParamsWithContext creates a new PutGuestVsockByIDParams object with the default values initialized, and the ability to set a context for a request.
NewPutGuestVsockByIDParamsWithHTTPClient creates a new PutGuestVsockByIDParams object with the default values initialized, and the ability to set a custom HTTPClient for a request.
NewPutGuestVsockByIDParamsWithTimeout creates a new PutGuestVsockByIDParams object with the default values initialized, and the ability to set a timeout on a request.
NewPutLoggerBadRequest creates a PutLoggerBadRequest with default headers values.
NewPutLoggerDefault creates a PutLoggerDefault with default headers values.
NewPutLoggerNoContent creates a PutLoggerNoContent with default headers values.
NewPutLoggerParams creates a new PutLoggerParams object with the default values initialized.
NewPutLoggerParamsWithContext creates a new PutLoggerParams object with the default values initialized, and the ability to set a context for a request.
NewPutLoggerParamsWithHTTPClient creates a new PutLoggerParams object with the default values initialized, and the ability to set a custom HTTPClient for a request.
NewPutLoggerParamsWithTimeout creates a new PutLoggerParams object with the default values initialized, and the ability to set a timeout on a request.
NewPutMachineConfigurationBadRequest creates a PutMachineConfigurationBadRequest with default headers values.
NewPutMachineConfigurationDefault creates a PutMachineConfigurationDefault with default headers values.
NewPutMachineConfigurationNoContent creates a PutMachineConfigurationNoContent with default headers values.
NewPutMachineConfigurationParams creates a new PutMachineConfigurationParams object with the default values initialized.
NewPutMachineConfigurationParamsWithContext creates a new PutMachineConfigurationParams object with the default values initialized, and the ability to set a context for a request.
NewPutMachineConfigurationParamsWithHTTPClient creates a new PutMachineConfigurationParams object with the default values initialized, and the ability to set a custom HTTPClient for a request.
NewPutMachineConfigurationParamsWithTimeout creates a new PutMachineConfigurationParams object with the default values initialized, and the ability to set a timeout on a request.
NewPutMmdsBadRequest creates a PutMmdsBadRequest with default headers values.
NewPutMmdsDefault creates a PutMmdsDefault with default headers values.
NewPutMmdsNoContent creates a PutMmdsNoContent with default headers values.
NewPutMmdsParams creates a new PutMmdsParams object with the default values initialized.
NewPutMmdsParamsWithContext creates a new PutMmdsParams object with the default values initialized, and the ability to set a context for a request.
NewPutMmdsParamsWithHTTPClient creates a new PutMmdsParams object with the default values initialized, and the ability to set a custom HTTPClient for a request.
NewPutMmdsParamsWithTimeout creates a new PutMmdsParams object with the default values initialized, and the ability to set a timeout on a request.

# Structs

Client for operations API */.
CreateSyncActionBadRequest handles this case with default header values.
CreateSyncActionDefault handles this case with default header values.
CreateSyncActionNoContent handles this case with default header values.
CreateSyncActionParams contains all the parameters to send to the API endpoint for the create sync action operation typically these are written to a http.Request */.
CreateSyncActionReader is a Reader for the CreateSyncAction structure.
DescribeInstanceDefault handles this case with default header values.
DescribeInstanceOK handles this case with default header values.
DescribeInstanceParams contains all the parameters to send to the API endpoint for the describe instance operation typically these are written to a http.Request */.
DescribeInstanceReader is a Reader for the DescribeInstance structure.
GetMachineConfigurationDefault handles this case with default header values.
GetMachineConfigurationOK handles this case with default header values.
GetMachineConfigurationParams contains all the parameters to send to the API endpoint for the get machine configuration operation typically these are written to a http.Request */.
GetMachineConfigurationReader is a Reader for the GetMachineConfiguration structure.
GetMmdsBadRequest handles this case with default header values.
GetMmdsDefault handles this case with default header values.
GetMmdsOK handles this case with default header values.
GetMmdsParams contains all the parameters to send to the API endpoint for the get mmds operation typically these are written to a http.Request */.
GetMmdsReader is a Reader for the GetMmds structure.
PatchGuestDriveByIDBadRequest handles this case with default header values.
PatchGuestDriveByIDDefault handles this case with default header values.
PatchGuestDriveByIDNoContent handles this case with default header values.
PatchGuestDriveByIDParams contains all the parameters to send to the API endpoint for the patch guest drive by ID operation typically these are written to a http.Request */.
PatchGuestDriveByIDReader is a Reader for the PatchGuestDriveByID structure.
PatchGuestNetworkInterfaceByIDBadRequest handles this case with default header values.
PatchGuestNetworkInterfaceByIDDefault handles this case with default header values.
PatchGuestNetworkInterfaceByIDNoContent handles this case with default header values.
PatchGuestNetworkInterfaceByIDParams contains all the parameters to send to the API endpoint for the patch guest network interface by ID operation typically these are written to a http.Request */.
PatchGuestNetworkInterfaceByIDReader is a Reader for the PatchGuestNetworkInterfaceByID structure.
PatchMachineConfigurationBadRequest handles this case with default header values.
PatchMachineConfigurationDefault handles this case with default header values.
PatchMachineConfigurationNoContent handles this case with default header values.
PatchMachineConfigurationParams contains all the parameters to send to the API endpoint for the patch machine configuration operation typically these are written to a http.Request */.
PatchMachineConfigurationReader is a Reader for the PatchMachineConfiguration structure.
PatchMmdsBadRequest handles this case with default header values.
PatchMmdsDefault handles this case with default header values.
PatchMmdsNoContent handles this case with default header values.
PatchMmdsParams contains all the parameters to send to the API endpoint for the patch mmds operation typically these are written to a http.Request */.
PatchMmdsReader is a Reader for the PatchMmds structure.
PutGuestBootSourceBadRequest handles this case with default header values.
PutGuestBootSourceDefault handles this case with default header values.
PutGuestBootSourceNoContent handles this case with default header values.
PutGuestBootSourceParams contains all the parameters to send to the API endpoint for the put guest boot source operation typically these are written to a http.Request */.
PutGuestBootSourceReader is a Reader for the PutGuestBootSource structure.
PutGuestDriveByIDBadRequest handles this case with default header values.
PutGuestDriveByIDDefault handles this case with default header values.
PutGuestDriveByIDNoContent handles this case with default header values.
PutGuestDriveByIDParams contains all the parameters to send to the API endpoint for the put guest drive by ID operation typically these are written to a http.Request */.
PutGuestDriveByIDReader is a Reader for the PutGuestDriveByID structure.
PutGuestNetworkInterfaceByIDBadRequest handles this case with default header values.
PutGuestNetworkInterfaceByIDDefault handles this case with default header values.
PutGuestNetworkInterfaceByIDNoContent handles this case with default header values.
PutGuestNetworkInterfaceByIDParams contains all the parameters to send to the API endpoint for the put guest network interface by ID operation typically these are written to a http.Request */.
PutGuestNetworkInterfaceByIDReader is a Reader for the PutGuestNetworkInterfaceByID structure.
PutGuestVsockByIDBadRequest handles this case with default header values.
PutGuestVsockByIDCreated handles this case with default header values.
PutGuestVsockByIDDefault handles this case with default header values.
PutGuestVsockByIDNoContent handles this case with default header values.
PutGuestVsockByIDParams contains all the parameters to send to the API endpoint for the put guest vsock by ID operation typically these are written to a http.Request */.
PutGuestVsockByIDReader is a Reader for the PutGuestVsockByID structure.
PutLoggerBadRequest handles this case with default header values.
PutLoggerDefault handles this case with default header values.
PutLoggerNoContent handles this case with default header values.
PutLoggerParams contains all the parameters to send to the API endpoint for the put logger operation typically these are written to a http.Request */.
PutLoggerReader is a Reader for the PutLogger structure.
PutMachineConfigurationBadRequest handles this case with default header values.
PutMachineConfigurationDefault handles this case with default header values.
PutMachineConfigurationNoContent handles this case with default header values.
PutMachineConfigurationParams contains all the parameters to send to the API endpoint for the put machine configuration operation typically these are written to a http.Request */.
PutMachineConfigurationReader is a Reader for the PutMachineConfiguration structure.
PutMmdsBadRequest handles this case with default header values.
PutMmdsDefault handles this case with default header values.
PutMmdsNoContent handles this case with default header values.
PutMmdsParams contains all the parameters to send to the API endpoint for the put mmds operation typically these are written to a http.Request */.
PutMmdsReader is a Reader for the PutMmds structure.

# Interfaces

ClientIface is an interface that can be used to mock out a Firecracker agent for testing purposes.