Task v1 API reference
proto source
CachedOperation
CachedOperation defines if request can return it's result from cache or should compute its result live.
| Field | Type | Label | Description |
|---|
| cached | bool | | |
Cluster
Cluster is a group for similiar nodes.
Cluster.EndpointsEntry
Endpoint
Endpoint is a abtract definition of an endpoint address
| Field | Type | Label | Description |
|---|
| fqdn | string | | FQDN of this endpoint, if known. |
| ip | string | | IP of this endpoint, if known. |
Endpoints
| Field | Type | Label | Description |
|---|
| targets | Endpoint | repeated | |
EvictNodeRequest
EvictNodeResponse
EvictServiceRequest
EvictServiceResponse
GetClusterHealthRequest
GetClusterHealthResponse
GetNodeHealthRequest
GetNodeHealthResponse
GetServiceHealthRequest
GetServiceHealthResponse
InitNodeRequest
InitNodeResponse
InitServiceRequest
InitServiceResponse
InitServiceResponse.DataEntry
Metadata contains fields which all resources share. It allows a resource to be uniquely identified and contain labels
and annotations. Name + Namespace can uniquely identify a resource for the current type at present. Uid can uniquely
identify a resource for the current type in time and space.
| Field | Type | Label | Description |
|---|
| name | string | | Name of the object. |
| namespace | string | | Namespace of the object. |
| uid | string | | UID of the object. (not called UUID as kubernetes also uses only the term UID) |
| labels | Metadata.LabelsEntry | repeated | Labels is a defined key-value map. Per key there is a mutual definition by the key owner. These fields are searchable and thus value content is limited. |
| annotations | Metadata.AnnotationsEntry | repeated | Annotations is a unstructured key-value map holding arbitrary metadata. |
Metadata.AnnotationsEntry
Metadata.LabelsEntry
Node
Node is a member of a cluster.
| Field | Type | Label | Description |
|---|
| metadata | Metadata | | |
| endpoint | Endpoint | | Endpoint address of this node, if known. |
RebootClusterRequest
RebootClusterResponse
RebootNodeRequest
RebootNodeResponse
RebootServiceRequest
| Field | Type | Label | Description |
|---|
| service | Metadata | | |
RebootServiceResponse
RemovedNodeRequest
RemovedNodeResponse
RemovedServiceRequest
RemovedServiceResponse
Service
Service is an instance of a specific ServiceDefinition.
Service.EndpointsEntry
ServiceDefinition
ServiceDefinition holds constant and settings of a specific version.
| Field | Type | Label | Description |
|---|
| metadata | Metadata | | |
| Version | string | | Version of this ServiceDefinition. |
SetupNodeRequest
SetupNodeResponse
SetupServiceRequest
SetupServiceResponse
VersionRequest
VersionResponse
| Field | Type | Label | Description |
|---|
| version | string | | Version of the event API the handler listens to. |
| handler_name | string | | Name of the handler. |
| handler_version | string | | Version of the handler. |
| handler_procedure_type | string | | ProcedureType the handler consumes. |
EventTask
EventTask service defines the public APIs for the task handler
| Method Name | Request Type | Response Type | Description |
|---|
| Version | VersionRequest | Version returns some information about the environment. | |
| InitService | InitServiceRequest | InitService informs about the upcoming new service. There are no resources deployed yet and won't continue until this request has been responded. This is the time where passwords, pre-shared keys, etc. should be created. Not implemented yet, but returned data map can be used as input to initialize the service definition. Not implemented yet, but if there's no operator yet deployed, would deploy it before this message is sent. | |
| SetupService | SetupServiceRequest | SetupService informs that the service and all related resources are deployed and endpoints exist. Resources still can be doing configuration and might not have finished yet. By responding to this request, all credentials and other instance data have to been savely stored. | |
| EvictService | EvictServiceRequest | EvictService informs that the service and all related resources are going to be deleted and won't continue until this request has been responded. | |
| RemovedService | RemovedServiceRequest | RemovedService informs that the service and all related resources have been deleted. Any credentials and other instance data should now be deleted. | |
| InitNode | InitNodeRequest | InitNode informs about the upcoming node which is going to be added to a cluster. There are no resources deployed yet and won't continue until this request has been responded. | |
| SetupNode | SetupNodeRequest | SetupNode informs that the node has been deployed and its endpoint exists. Can still be doing configuration and might not have finished yet. | |
| EvictNode | EvictNodeRequest | EvictNode informs that the node is going to be deleted and won't continue until this request has been responded. | |
| RemovedNode | RemovedNodeRequest | RemovedNode informs that the node has been removed. Any data related to this node should now be deleted. | |
| GetServiceHealth | GetServiceHealthRequest | GetServiceHealth should return the current health state of the service. | |
| GetClusterHealth | GetClusterHealthRequest | GetClusterHealth should return the current health state of the cluster. | |
| GetNodeHealth | GetNodeHealthRequest | GetNodeHealth should return the current health state of the node. | |
| RebootService | RebootServiceRequest | RebootService requests the whole service has to be rebooted. The implementation should reboot application-aware. | |
| RebootCluster | RebootClusterRequest | RebootCluster requests a whole cluster has to be rebooted. The implementation should reboot application-aware. | |
| RebootNode | RebootNodeRequest | RebootNode requests a node has to be rebooted. The implementation should reboot application-aware. | |
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) |