gRPC API

Mon, 01 Jan 0001 00:00:00 +0000

This is a generated reference for the Skaffold API gRPC layer.

v1/skaffold.proto

You can find the source for v1/skaffold.proto on Github.

Describes all the methods for the Skaffold API

Method Name	Request Type	Response Type	Description
GetState	.google.protobuf.Empty	State	Returns the state of the current Skaffold execution
EventLog	LogEntry stream	LogEntry stream	DEPRECATED. Events should be used instead. TODO remove (https://github.com/GoogleContainerTools/skaffold/issues/3168)
Events	.google.protobuf.Empty	LogEntry stream	Returns all the events of the current Skaffold execution from the start
Execute	UserIntentRequest	.google.protobuf.Empty	Allows for a single execution of some or all of the phases (build, sync, deploy) in case autoBuild, autoDeploy or autoSync are disabled.
AutoBuild	TriggerRequest	.google.protobuf.Empty	Allows for enabling or disabling automatic build trigger
AutoSync	TriggerRequest	.google.protobuf.Empty	Allows for enabling or disabling automatic sync trigger
AutoDeploy	TriggerRequest	.google.protobuf.Empty	Allows for enabling or disabling automatic deploy trigger
Handle	Event	.google.protobuf.Empty	EXPERIMENTAL. It allows for custom events to be implemented in custom builders for example.

Mon, 01 Jan 0001 00:00:00 +0000

This is a generated reference for the Skaffold API HTTP layer.