Protocol Documentation

Table of Contents

• skaffold.proto

  • BuildEvent
  • BuildState
  • BuildState.ArtifactsEntry
  • DeployEvent
  • DeployState
  • Event
  • FileSyncEvent
  • FileSyncState
  • Intent
  • LogEntry
  • MetaEvent
  • PortEvent
  • Request
  • ResourceStatusCheckEvent
  • Response
  • State
  • State.ForwardedPortsEntry
  • StateResponse
  • StatusCheckEvent
  • StatusCheckState
  • StatusCheckState.ResourcesEntry

  • UserIntentRequest

  • SkaffoldService

• Scalar Value Types

Top

skaffold.proto

BuildEvent

Field	Type	Label	Description
artifact	string
status	string
err	string

BuildState

BuildState contains a map of all skaffold artifacts to their current build states

Field	Type	Label	Description
artifacts	BuildState.ArtifactsEntry	repeated

BuildState.ArtifactsEntry

Field	Type	Label	Description
key	string
value	string

DeployEvent

Field	Type	Label	Description
status	string
err	string

DeployState

DeployState contains the status of the current deploy

Field	Type	Label	Description
status	string

Event

Field	Type	Label	Description
metaEvent	MetaEvent
buildEvent	BuildEvent
deployEvent	DeployEvent
portEvent	PortEvent
statusCheckEvent	StatusCheckEvent
resourceStatusCheckEvent	ResourceStatusCheckEvent
fileSyncEvent	FileSyncEvent

FileSyncEvent

Field	Type	Label	Description
fileCount	int32
image	string
status	string
err	string

FileSyncState

FileSyncState contains the status of the current file sync

Field	Type	Label	Description
status	string

Intent

Field	Type	Label	Description
build	bool
sync	bool
deploy	bool

LogEntry

Field	Type	Label	Description
timestamp	google.protobuf.Timestamp
event	Event
entry	string

MetaEvent

Field	Type	Label	Description
entry	string

PortEvent

Field	Type	Label	Description
localPort	int32
remotePort	int32
podName	string
containerName	string
namespace	string
portName	string
resourceType	string
resourceName	string

Request

Field	Type	Label	Description
name	string

ResourceStatusCheckEvent

Field	Type	Label	Description
resource	string
status	string
message	string
err	string

Response

Field	Type	Label	Description
msg	string

State

Field	Type	Label	Description
buildState	BuildState
deployState	DeployState
forwardedPorts	State.ForwardedPortsEntry	repeated
statusCheckState	StatusCheckState
fileSyncState	FileSyncState

State.ForwardedPortsEntry

Field	Type	Label	Description
key	int32
value	PortEvent

StateResponse

Field	Type	Label	Description
state	State

StatusCheckEvent

Field	Type	Label	Description
status	string
message	string
err	string

StatusCheckState

StatusCheckState contains the state of status check of current deployed resources.

Field	Type	Label	Description
status	string
resources	StatusCheckState.ResourcesEntry	repeated

StatusCheckState.ResourcesEntry

Field	Type	Label	Description
key	string
value	string

UserIntentRequest

Field	Type	Label	Description
intent	Intent

SkaffoldService

Method Name	Request Type	Response Type	Description
GetState	.google.protobuf.Empty	State
EventLog	LogEntry stream	LogEntry stream
Events	LogEntry stream	LogEntry stream
Handle	Event	.google.protobuf.Empty
Execute	UserIntentRequest	.google.protobuf.Empty

Scalar Value Types

.proto Type	Notes	C++ Type	Java Type	Python Type
double		double	double	float
float		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
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
uint32	Uses variable-length encoding.	uint32	int	int/long
uint64	Uses variable-length encoding.	uint64	long	int/long
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long
sfixed32	Always four bytes.	int32	int	int
sfixed64	Always eight bytes.	int64	long	int/long
bool		bool	boolean	boolean
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str