v1

Documentation

Index

• Constants
• type AndroidCIBuild
• type AndroidCIBuildSource
• type AndroidCIBundle
• type ArtifactsBundleType
• type BuildSource
• type CVD
  • func (c *CVD) ID() string
• type CreateCVDRequest
• type CreateCVDResponse
• type CreateSnapshotResponse
• type EmptyResponse
• type FetchArtifactsRequest
• type FetchArtifactsResponse
• type ListCVDsResponse
• type ListOperationsResponse
• type ListUploadDirectoriesResponse
• type Operation
• type StartCVDRequest
• type StopCVDResponse
• type UploadDirectory

Constants

const EnvConfigUserArtifactsVar = "@user_artifacts"

Prefix for specifying user artifact path while creating CVD with CreateCVDRequest.EnvConfig.

Types

type AndroidCIBuild

type AndroidCIBuild struct {
	// The branch name. If omitted the passed `BuildID` will determine the branch.
	Branch string `json:"branch"`
	// Uniquely identifies a branch's snapshot. If empty, the latest green snapshot of the used branch will
	// be used.
	BuildID string `json:"build_id"`
	// A string to determine the specific product and flavor from the set of builds.
	Target string `json:"target"`
}

Represents a build from ci.android.com.

type AndroidCIBuildSource

type AndroidCIBuildSource struct {
	// Main build. If omitted, defaults to branch "aosp-main" and target `aosp_cf_x86_64_phone-trunk_staging-userdebug`.
	MainBuild *AndroidCIBuild `json:"main_build,omitempty"`
	// Uses this specific kernel build target if set.
	KernelBuild *AndroidCIBuild `json:"kernel_build,omitempty"`
	// Uses this specific bootloader build target if set.
	BootloaderBuild *AndroidCIBuild `json:"bootloader_build,omitempty"`
	// Uses this specific system image build target if set.
	SystemImageBuild *AndroidCIBuild `json:"system_image_build,omitempty"`
}

type AndroidCIBundle

type AndroidCIBundle struct {
	// If omitted, defaults to branch "aosp-main" and target `aosp_cf_x86_64_phone-trunk_staging-userdebug`.
	Build *AndroidCIBuild `json:"build,omitempty"`
	// If omitted, it defaults to the `main` bundle type.
	Type ArtifactsBundleType `json:"type"`
}

type ArtifactsBundleType

type ArtifactsBundleType int64

const (
	MainBundleType ArtifactsBundleType = iota
	KernelBundleType
	BootloaderBundleType
	SystemImageBundleType
)

type BuildSource

type BuildSource struct {
	// A build from ci.android.com
	AndroidCIBuildSource *AndroidCIBuildSource `json:"android_ci_build_source,omitempty"`
}

Represents the artifacts source to build the CVD.

type CVD

type CVD struct {
	// [Output Only] The group name the instance belongs to.
	Group string `json:"group"`
	// [Output Only] Identifier within a group.
	Name string `json:"name"`
	// [Input Only]
	BuildSource *BuildSource `json:"build_source,omitempty"`
	// [Output Only]
	Status string `json:"status"`
	// [Output Only]
	Displays []string `json:"displays"`
	// [Output Only]
	WebRTCDeviceID string `json:"webrtc_device_id"`
	// [Output Only]
	ADBSerial string `json:"adb_serial"`
}

func (*CVD) ID

func (c *CVD) ID() string

Identifier within the whole fleet. Format: "{group}/{name}".

type CreateCVDRequest

type CreateCVDRequest struct {
	// Environment canonical configuration.
	// Structure: https://android.googlesource.com/device/google/cuttlefish/+/8bbd3b9cd815f756f332791d45c4f492b663e493/host/commands/cvd/parser/README.md
	// Example: https://cs.android.com/android/platform/superproject/main/+/main:device/google/cuttlefish/host/cvd_test_configs/main_phone-main_watch.json;drc=b2e8f4f014abb7f9cb56c0ae199334aacb04542d
	// NOTE: Using this as a black box for now as its content is unstable. Use the test configs pointed
	// above as reference to build your config object.
	EnvConfig map[string]interface{} `json:"env_config"`

	// [DEPRECATED]. Use `EnvConfig` field.
	CVD *CVD `json:"cvd"`
	// [DEPRECATED]. Use `EnvConfig` field.
	// Use to create multiple homogeneous instances.
	AdditionalInstancesNum uint32 `json:"additional_instances_num,omitempty"`
}

Use `X-Cutf-Host-Orchestrator-BuildAPI-Creds` http header to pass the Build API credentials.

type CreateCVDResponse

type CreateCVDResponse struct {
	CVDs []*CVD `json:"cvds"`
}

type CreateSnapshotResponse

type CreateSnapshotResponse struct {
	SnapshotID string `json:"snapshot_id"`
}

type EmptyResponse

type EmptyResponse struct{}

type FetchArtifactsRequest

type FetchArtifactsRequest struct {
	AndroidCIBundle *AndroidCIBundle `json:"android_ci_bundle"`
}

type FetchArtifactsResponse

type FetchArtifactsResponse struct {
	AndroidCIBundle *AndroidCIBundle `json:"android_ci_bundle"`
}

type ListCVDsResponse

type ListCVDsResponse struct {
	CVDs []*CVD `json:"cvds"`
}

type ListOperationsResponse

type ListOperationsResponse struct {
	Operations []Operation `json:"operations"`
}

type ListUploadDirectoriesResponse

type ListUploadDirectoriesResponse struct {
	Items []*UploadDirectory `json:"items"`
}

type Operation

type Operation struct {
	Name string `json:"name"`
	// If the value is `false`, it means the operation is still in progress.
	// If `true`, the operation is completed, and either `error` or `response` is
	// available.
	Done bool `json:"done"`
}

type StartCVDRequest

type StartCVDRequest struct {
	// Start from the relevant snaphost if not empty.
	SnapshotID string `json:"snapshot_id,omitempty"`
}

type StopCVDResponse

type StopCVDResponse = EmptyResponse

type UploadDirectory

type UploadDirectory struct {
	// [Output Only]
	Name string `json:"name"`
}