Documentation ¶
Index ¶
- Constants
- type Artifact
- type BuildCompleted
- type BuildFailed
- type BuildStarted
- type LogGeneral
- type LogRequest
- type Message
- type PkgBuildCompleted
- type PkgBuildFailed
- type PkgBuildSkipped
- type PkgBuildStarted
- type StatusMessageEnvelope
- type TaskCompleted
- type TaskFailed
- type TaskScheduled
- type TaskSkipped
- type TaskStarted
Constants ¶
const ( // ArtifactBuildStateBlocked captures enum value "blocked" ArtifactBuildStateBlocked string = "blocked" // ArtifactBuildStateDoomed captures enum value "doomed" ArtifactBuildStateDoomed string = "doomed" // ArtifactBuildStateFailed captures enum value "failed" ArtifactBuildStateFailed string = "failed" // ArtifactBuildStateReady captures enum value "ready" ArtifactBuildStateReady string = "ready" // ArtifactBuildStateRunning captures enum value "running" ArtifactBuildStateRunning string = "running" // ArtifactBuildStateStarting captures enum value "starting" ArtifactBuildStateStarting string = "starting" // ArtifactBuildStateSucceeded captures enum value "succeeded" ArtifactBuildStateSucceeded string = "succeeded" )
const ( // LogGeneralFacilityDIE captures enum value "DIE" LogGeneralFacilityDIE string = "DIE" // LogGeneralFacilityDUMP captures enum value "DUMP" LogGeneralFacilityDUMP string = "DUMP" // LogGeneralFacilityERROR captures enum value "ERROR" LogGeneralFacilityERROR string = "ERROR" // LogGeneralFacilityINFO captures enum value "INFO" LogGeneralFacilityINFO string = "INFO" // LogGeneralFacilityLOG captures enum value "LOG" LogGeneralFacilityLOG string = "LOG" // LogGeneralFacilityWARN captures enum value "WARN" LogGeneralFacilityWARN string = "WARN" )
const ( // StatusMessageEnvelopeTypeBuildCompleted captures enum value "build_completed" StatusMessageEnvelopeTypeBuildCompleted string = "build_completed" // StatusMessageEnvelopeTypeBuildFailed captures enum value "build_failed" StatusMessageEnvelopeTypeBuildFailed string = "build_failed" // StatusMessageEnvelopeTypeBuildStarted captures enum value "build_started" StatusMessageEnvelopeTypeBuildStarted string = "build_started" // StatusMessageEnvelopeTypeHeartbeat captures enum value "heartbeat" StatusMessageEnvelopeTypeHeartbeat string = "heartbeat" // StatusMessageEnvelopeTypeLogGeneral captures enum value "log_general" StatusMessageEnvelopeTypeLogGeneral string = "log_general" // StatusMessageEnvelopeTypePkgBuildCompleted captures enum value "pkg_build_completed" StatusMessageEnvelopeTypePkgBuildCompleted string = "pkg_build_completed" // StatusMessageEnvelopeTypePkgBuildFailed captures enum value "pkg_build_failed" StatusMessageEnvelopeTypePkgBuildFailed string = "pkg_build_failed" // StatusMessageEnvelopeTypePkgBuildSkipped captures enum value "pkg_build_skipped" StatusMessageEnvelopeTypePkgBuildSkipped string = "pkg_build_skipped" // StatusMessageEnvelopeTypePkgBuildStarted captures enum value "pkg_build_started" StatusMessageEnvelopeTypePkgBuildStarted string = "pkg_build_started" // StatusMessageEnvelopeTypeTaskCompleted captures enum value "task_completed" StatusMessageEnvelopeTypeTaskCompleted string = "task_completed" // StatusMessageEnvelopeTypeTaskFailed captures enum value "task_failed" StatusMessageEnvelopeTypeTaskFailed string = "task_failed" // StatusMessageEnvelopeTypeTaskScheduled captures enum value "task_scheduled" StatusMessageEnvelopeTypeTaskScheduled string = "task_scheduled" // StatusMessageEnvelopeTypeTaskSkipped captures enum value "task_skipped" StatusMessageEnvelopeTypeTaskSkipped string = "task_skipped" // StatusMessageEnvelopeTypeTaskStarted captures enum value "task_started" StatusMessageEnvelopeTypeTaskStarted string = "task_started" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Artifact ¶
type Artifact struct { // Artifact ID // Required: true // Format: uuid ArtifactID *strfmt.UUID `json:"artifact_id"` // Indicates where in the build process the artifact currently is. // Required: true // Enum: [blocked doomed failed ready running starting succeeded] BuildState *string `json:"build_state"` // Timestamp for when the artifact was created // Required: true // Format: date-time BuildTimestamp *strfmt.DateTime `json:"build_timestamp"` // dependency ids DependencyIds []strfmt.UUID `json:"dependency_ids"` // The error that happened which caused the artifact to fail to build. Only non-null if 'build_state' is 'failed'. Error string `json:"error,omitempty"` // Ingredient Version ID // // Source Ingredient Version ID for the artifact. Null if the artifact was not built directly from an ingredient (i.e. a packager artifact) // Format: uuid IngredientVersionID strfmt.UUID `json:"ingredient_version_id,omitempty"` // Platform ID for the artifact // Required: true // Format: uuid PlatformID *strfmt.UUID `json:"platform_id"` // URI for the storage location of the artifact. Only non-null if 'build_state' is 'succeeded'. // Format: uri URI strfmt.URI `json:"uri,omitempty"` }
Artifact Artifact
The result of building a single ingredient is an artifact, which contains the files created by the build.
swagger:model Artifact
func (*Artifact) MarshalBinary ¶
MarshalBinary interface implementation
func (*Artifact) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type BuildCompleted ¶
type BuildCompleted struct { // An array containing all the artifacts that make up this build. // Required: true Artifacts []*Artifact `json:"artifacts"` // An S3 URI containing the log for this build. // Format: uri LogURI strfmt.URI `json:"log_uri,omitempty"` // A user-facing message describing the build results. Message string `json:"message,omitempty"` }
BuildCompleted Build Completed
A message indicating that a requested build has been completed.
swagger:model BuildCompleted
func (*BuildCompleted) MarshalBinary ¶
func (m *BuildCompleted) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BuildCompleted) UnmarshalBinary ¶
func (m *BuildCompleted) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BuildFailed ¶
type BuildFailed struct { // All of the errors from the failed build. Note that these errors may not be suitable for presenting to users and should simply be logged for further investigation. // Required: true Errors []string `json:"errors"` // If true this failed build can be retried and it may succeed. If false, retrying this failed build will not change the outcome. This field's value is only valid when type is build_failed. // Required: true IsRetryable bool `json:"is_retryable"` // An S3 URI containing the log for this build. // Format: uri LogURI strfmt.URI `json:"log_uri,omitempty"` // A user-facing message describing the build results. Message string `json:"message,omitempty"` }
BuildFailed Build Failed
A message indicating that a build failed.
swagger:model BuildFailed
func (*BuildFailed) MarshalBinary ¶
func (m *BuildFailed) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BuildFailed) UnmarshalBinary ¶
func (m *BuildFailed) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BuildStarted ¶
type BuildStarted struct { // A user-facing message describing the build event. Message string `json:"message,omitempty"` }
BuildStarted Build Started
A message indicating that a requested build has been started.
swagger:model BuildStarted
func (*BuildStarted) MarshalBinary ¶
func (m *BuildStarted) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BuildStarted) UnmarshalBinary ¶
func (m *BuildStarted) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LogGeneral ¶
type LogGeneral struct { // facility // Required: true // Enum: [DIE DUMP ERROR INFO LOG WARN] Facility *string `json:"facility"` // message // Required: true Message *string `json:"message"` }
LogGeneral General log message
A general status message ¶
swagger:model logGeneral
func (*LogGeneral) MarshalBinary ¶
func (m *LogGeneral) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LogGeneral) UnmarshalBinary ¶
func (m *LogGeneral) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type LogRequest ¶
type LogRequest struct { // Request log lines from the build of the specified artifact. Only supported for builds executed by builders. // Format: uuid ArtifactID strfmt.UUID `json:"artifactID,omitempty"` // Request build events and log lines from the specified build request. Only supported for builds executed by camel. // Format: uuid BuildRequestID strfmt.UUID `json:"buildRequestID,omitempty"` // Request build events from the specified recipe. Only supported for builds executed by builders. // Format: uuid RecipeID strfmt.UUID `json:"recipeID,omitempty"` }
LogRequest log request
swagger:model LogRequest
func (*LogRequest) MarshalBinary ¶
func (m *LogRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*LogRequest) UnmarshalBinary ¶
func (m *LogRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Message ¶
type Message struct { // code // Required: true Code *int64 `json:"code"` // message // Required: true Message *string `json:"message"` }
Message message
swagger:model Message
func (*Message) MarshalBinary ¶
MarshalBinary interface implementation
func (*Message) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PkgBuildCompleted ¶
type PkgBuildCompleted struct { // artifact // Required: true Artifact *Artifact `json:"artifact"` // ingredient id // Required: true // Format: uuid IngredientID *strfmt.UUID `json:"ingredient_id"` // ingredient version // Required: true IngredientVersion *string `json:"ingredient_version"` // The percentage through the total number of packages to be built in the current tast // Maximum: 100 // Minimum: 0 Percent *int64 `json:"percent,omitempty"` // The current position in the list of packages to be built in the current task // Minimum: 0 Sequence *int64 `json:"sequence,omitempty"` // The current total number of packages to be built in the current task // Minimum: 0 Total *int64 `json:"total,omitempty"` }
PkgBuildCompleted Package Build Completed
A message indicating that a requested package build has completed.
swagger:model pkgBuildCompleted
func (*PkgBuildCompleted) MarshalBinary ¶
func (m *PkgBuildCompleted) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PkgBuildCompleted) UnmarshalBinary ¶
func (m *PkgBuildCompleted) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PkgBuildFailed ¶
type PkgBuildFailed struct { // All of the errors from the failed build. // Required: true Errors []string `json:"errors"` // ingredient id // Required: true // Format: uuid IngredientID *strfmt.UUID `json:"ingredient_id"` // ingredient version // Required: true IngredientVersion *string `json:"ingredient_version"` // The percentage through the total number of packages to be built in the current tast // Maximum: 100 // Minimum: 0 Percent *int64 `json:"percent,omitempty"` // The current position in the list of packages to be built in the current task // Minimum: 0 Sequence *int64 `json:"sequence,omitempty"` // The current total number of packages to be built in the current task // Minimum: 0 Total *int64 `json:"total,omitempty"` }
PkgBuildFailed Package Build Failed
A message indicating that a requested package build failed.
swagger:model pkgBuildFailed
func (*PkgBuildFailed) MarshalBinary ¶
func (m *PkgBuildFailed) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PkgBuildFailed) UnmarshalBinary ¶
func (m *PkgBuildFailed) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PkgBuildSkipped ¶
type PkgBuildSkipped struct { // ingredient id // Required: true // Format: uuid IngredientID *strfmt.UUID `json:"ingredient_id"` // ingredient version // Required: true IngredientVersion *string `json:"ingredient_version"` // reason // Required: true Reason *string `json:"reason"` }
PkgBuildSkipped Package Build Skipped
A message indicating that a requested package build has been skipped.
swagger:model pkgBuildSkipped
func (*PkgBuildSkipped) MarshalBinary ¶
func (m *PkgBuildSkipped) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PkgBuildSkipped) UnmarshalBinary ¶
func (m *PkgBuildSkipped) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PkgBuildStarted ¶
type PkgBuildStarted struct { // ingredient id // Required: true // Format: uuid IngredientID *strfmt.UUID `json:"ingredient_id"` // ingredient version // Required: true IngredientVersion *string `json:"ingredient_version"` // The percentage through the total number of packages to be built in the current tast // Maximum: 100 // Minimum: 0 Percent *int64 `json:"percent,omitempty"` // The current position in the list of packages to be built in the current task // Minimum: 0 Sequence *int64 `json:"sequence,omitempty"` // The current total number of packages to be built in the current task // Minimum: 0 Total *int64 `json:"total,omitempty"` }
PkgBuildStarted Package Build Started
A message indicating that a requested package build has been started.
swagger:model pkgBuildStarted
func (*PkgBuildStarted) MarshalBinary ¶
func (m *PkgBuildStarted) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PkgBuildStarted) UnmarshalBinary ¶
func (m *PkgBuildStarted) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StatusMessageEnvelope ¶
type StatusMessageEnvelope struct { // The actual message. Body interface{} `json:"body,omitempty"` // build request id // Required: true // Format: uuid BuildRequestID *strfmt.UUID `json:"build_request_id"` // The timestamp for the message. // Required: true // Format: date-time Timestamp *strfmt.DateTime `json:"timestamp"` // Indicates the type of the contained message. // Required: true // Enum: [build_completed build_failed build_started heartbeat log_general pkg_build_completed pkg_build_failed pkg_build_skipped pkg_build_started task_completed task_failed task_scheduled task_skipped task_started] Type *string `json:"type"` }
StatusMessageEnvelope Status Message Envelope
A message that contains one status message plus an indicator of that message's type.
swagger:model statusMessageEnvelope
func (*StatusMessageEnvelope) MarshalBinary ¶
func (m *StatusMessageEnvelope) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StatusMessageEnvelope) UnmarshalBinary ¶
func (m *StatusMessageEnvelope) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskCompleted ¶
type TaskCompleted struct { // task // Required: true Task *string `json:"task"` }
TaskCompleted Task Completed
A message indicating that a requested task for a build has completed.
swagger:model taskCompleted
func (*TaskCompleted) MarshalBinary ¶
func (m *TaskCompleted) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskCompleted) UnmarshalBinary ¶
func (m *TaskCompleted) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskFailed ¶
type TaskFailed struct { // All of the errors from the failed task. // Required: true Errors []string `json:"errors"` // task // Required: true Task *string `json:"task"` }
TaskFailed Task Failed
A message indicating that a requested task for a build failed.
swagger:model taskFailed
func (*TaskFailed) MarshalBinary ¶
func (m *TaskFailed) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskFailed) UnmarshalBinary ¶
func (m *TaskFailed) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskScheduled ¶
type TaskScheduled struct { // task // Required: true Task *string `json:"task"` }
TaskScheduled Task Scheduled
A message indicating that a task will run as part of a build.
swagger:model taskScheduled
func (*TaskScheduled) MarshalBinary ¶
func (m *TaskScheduled) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskScheduled) UnmarshalBinary ¶
func (m *TaskScheduled) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskSkipped ¶
type TaskSkipped struct { // reason // Required: true Reason *string `json:"reason"` // task // Required: true Task *string `json:"task"` }
TaskSkipped Task Skipped
A message indicating that a requested task for a build has been skipped.
swagger:model taskSkipped
func (*TaskSkipped) MarshalBinary ¶
func (m *TaskSkipped) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskSkipped) UnmarshalBinary ¶
func (m *TaskSkipped) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TaskStarted ¶
type TaskStarted struct { // task // Required: true Task *string `json:"task"` }
TaskStarted Task Started
A message indicating that a requested task for a build has been started.
swagger:model taskStarted
func (*TaskStarted) MarshalBinary ¶
func (m *TaskStarted) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TaskStarted) UnmarshalBinary ¶
func (m *TaskStarted) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation