microvm.services.api.v1alpha1
Table of Contents
services/microvm/v1alpha1/microvms.proto
CreateMicroVMRequest
| Field | Type | Label | Description |
|---|---|---|---|
| microvm | flintlock.types.MicroVMSpec | ||
| metadata | CreateMicroVMRequest.MetadataEntry | repeated |
CreateMicroVMRequest.MetadataEntry
| Field | Type | Label | Description |
|---|---|---|---|
| key | string | ||
| value | google.protobuf.Any |
CreateMicroVMResponse
| Field | Type | Label | Description |
|---|---|---|---|
| microvm | flintlock.types.MicroVM |
DeleteMicroVMRequest
| Field | Type | Label | Description |
|---|---|---|---|
| uid | string |
GetMicroVMRequest
| Field | Type | Label | Description |
|---|---|---|---|
| uid | string |
GetMicroVMResponse
| Field | Type | Label | Description |
|---|---|---|---|
| microvm | flintlock.types.MicroVM |
GuestAgentServiceInfo
GuestAgentServiceInfo describes an optional gRPC service that shares the main API listener. address is only populated when enabled is true.
| Field | Type | Label | Description |
|---|---|---|---|
| enabled | bool | ||
| address | string |
ListMessage
| Field | Type | Label | Description |
|---|---|---|---|
| microvm | flintlock.types.MicroVM |
ListMicroVMsRequest
| Field | Type | Label | Description |
|---|---|---|---|
| namespace | string | ||
| name | string | optional |
ListMicroVMsResponse
| Field | Type | Label | Description |
|---|---|---|---|
| microvm | flintlock.types.MicroVM | repeated |
ServerInfoResponse
| Field | Type | Label | Description |
|---|---|---|---|
| version | VersionInfo | ||
| uptime | google.protobuf.Duration | ||
| exec | GuestAgentServiceInfo | ||
| ssh_proxy | GuestAgentServiceInfo |
VersionInfo
| Field | Type | Label | Description |
|---|---|---|---|
| version | string | ||
| build_date | string | ||
| commit_hash | string |
MicroVM
MicroVM providers a service to create and manage the lifecycle of microvms.
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| CreateMicroVM | CreateMicroVMRequest | CreateMicroVMResponse | |
| DeleteMicroVM | DeleteMicroVMRequest | .google.protobuf.Empty | |
| GetMicroVM | GetMicroVMRequest | GetMicroVMResponse | |
| ListMicroVMs | ListMicroVMsRequest | ListMicroVMsResponse | |
| ListMicroVMsStream | ListMicroVMsRequest | ListMessage stream | |
| ServerInfo | .google.protobuf.Empty | ServerInfoResponse |
Scalar Value Types
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
|---|---|---|---|---|---|---|---|---|
| double | double | double | float | float64 | double | float | Float | |
| float | float | float | float | float32 | float | float | Float | |
| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| bool | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |