Documentation
¶
Index ¶
- type APIListRunsResponse
- type APIParameter
- type APIPipelineRuntime
- type APIPipelineSpec
- type APIReadArtifactResponse
- type APIRelationship
- type APIReportRunMetricsRequest
- type APIReportRunMetricsResponse
- type APIResourceKey
- type APIResourceReference
- type APIResourceType
- type APIRun
- type APIRunDetail
- type APIRunMetric
- type APIStatus
- type ProtobufAny
- type ReportRunMetricsResponseReportRunMetricResult
- type ReportRunMetricsResponseReportRunMetricResultStatus
- type RunMetricFormat
- type RunStorageState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIListRunsResponse ¶
type APIListRunsResponse struct {
// next page token
NextPageToken string `json:"next_page_token,omitempty"`
// runs
Runs []*APIRun `json:"runs"`
// total size
TotalSize int32 `json:"total_size,omitempty"`
}
APIListRunsResponse api list runs response swagger:model apiListRunsResponse
func (*APIListRunsResponse) MarshalBinary ¶
func (m *APIListRunsResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIListRunsResponse) UnmarshalBinary ¶
func (m *APIListRunsResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIParameter ¶
type APIParameter struct {
// name
Name string `json:"name,omitempty"`
// value
Value string `json:"value,omitempty"`
}
APIParameter api parameter swagger:model apiParameter
func (*APIParameter) MarshalBinary ¶
func (m *APIParameter) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIParameter) UnmarshalBinary ¶
func (m *APIParameter) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIPipelineRuntime ¶
type APIPipelineRuntime struct {
// Output. The runtime JSON manifest of the pipeline, including the status
// of pipeline steps and fields need for UI visualization etc.
PipelineManifest string `json:"pipeline_manifest,omitempty"`
// Output. The runtime JSON manifest of the argo workflow.
// This is deprecated after pipeline_runtime_manifest is in use.
WorkflowManifest string `json:"workflow_manifest,omitempty"`
}
APIPipelineRuntime api pipeline runtime swagger:model apiPipelineRuntime
func (*APIPipelineRuntime) MarshalBinary ¶
func (m *APIPipelineRuntime) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIPipelineRuntime) UnmarshalBinary ¶
func (m *APIPipelineRuntime) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIPipelineSpec ¶
type APIPipelineSpec struct {
// The parameter user provide to inject to the pipeline JSON.
// If a default value of a parameter exist in the JSON,
// the value user provided here will replace.
Parameters []*APIParameter `json:"parameters"`
// Optional input field. The ID of the pipeline user uploaded before.
PipelineID string `json:"pipeline_id,omitempty"`
// Optional input field. The raw pipeline JSON spec.
PipelineManifest string `json:"pipeline_manifest,omitempty"`
// Optional output field. The name of the pipeline.
// Not empty if the pipeline id is not empty.
PipelineName string `json:"pipeline_name,omitempty"`
// Optional input field. The marshalled raw argo JSON workflow.
// This will be deprecated when pipeline_manifest is in use.
WorkflowManifest string `json:"workflow_manifest,omitempty"`
}
APIPipelineSpec api pipeline spec swagger:model apiPipelineSpec
func (*APIPipelineSpec) MarshalBinary ¶
func (m *APIPipelineSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIPipelineSpec) UnmarshalBinary ¶
func (m *APIPipelineSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIReadArtifactResponse ¶
type APIReadArtifactResponse struct {
// The bytes of the artifact content.
// Format: byte
Data strfmt.Base64 `json:"data,omitempty"`
}
APIReadArtifactResponse api read artifact response swagger:model apiReadArtifactResponse
func (*APIReadArtifactResponse) MarshalBinary ¶
func (m *APIReadArtifactResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIReadArtifactResponse) UnmarshalBinary ¶
func (m *APIReadArtifactResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIRelationship ¶
type APIRelationship string
APIRelationship api relationship swagger:model apiRelationship
const ( // APIRelationshipUNKNOWNRELATIONSHIP captures enum value "UNKNOWN_RELATIONSHIP" APIRelationshipUNKNOWNRELATIONSHIP APIRelationship = "UNKNOWN_RELATIONSHIP" // APIRelationshipOWNER captures enum value "OWNER" APIRelationshipOWNER APIRelationship = "OWNER" // APIRelationshipCREATOR captures enum value "CREATOR" APIRelationshipCREATOR APIRelationship = "CREATOR" )
type APIReportRunMetricsRequest ¶
type APIReportRunMetricsRequest struct {
// List of metrics to report.
Metrics []*APIRunMetric `json:"metrics"`
// Required. The parent run ID of the metric.
RunID string `json:"run_id,omitempty"`
}
APIReportRunMetricsRequest api report run metrics request swagger:model apiReportRunMetricsRequest
func (*APIReportRunMetricsRequest) MarshalBinary ¶
func (m *APIReportRunMetricsRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIReportRunMetricsRequest) UnmarshalBinary ¶
func (m *APIReportRunMetricsRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIReportRunMetricsResponse ¶
type APIReportRunMetricsResponse struct {
// results
Results []*ReportRunMetricsResponseReportRunMetricResult `json:"results"`
}
APIReportRunMetricsResponse api report run metrics response swagger:model apiReportRunMetricsResponse
func (*APIReportRunMetricsResponse) MarshalBinary ¶
func (m *APIReportRunMetricsResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIReportRunMetricsResponse) UnmarshalBinary ¶
func (m *APIReportRunMetricsResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIResourceKey ¶
type APIResourceKey struct {
// The ID of the resource that referred to.
ID string `json:"id,omitempty"`
// The type of the resource that referred to.
Type APIResourceType `json:"type,omitempty"`
}
APIResourceKey api resource key swagger:model apiResourceKey
func (*APIResourceKey) MarshalBinary ¶
func (m *APIResourceKey) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIResourceKey) UnmarshalBinary ¶
func (m *APIResourceKey) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIResourceReference ¶
type APIResourceReference struct {
// key
Key *APIResourceKey `json:"key,omitempty"`
// The name of the resource that referred to.
Name string `json:"name,omitempty"`
// Required field. The relationship from referred resource to the object.
Relationship APIRelationship `json:"relationship,omitempty"`
}
APIResourceReference api resource reference swagger:model apiResourceReference
func (*APIResourceReference) MarshalBinary ¶
func (m *APIResourceReference) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIResourceReference) UnmarshalBinary ¶
func (m *APIResourceReference) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIResourceType ¶
type APIResourceType string
APIResourceType api resource type swagger:model apiResourceType
const ( // APIResourceTypeUNKNOWNRESOURCETYPE captures enum value "UNKNOWN_RESOURCE_TYPE" APIResourceTypeUNKNOWNRESOURCETYPE APIResourceType = "UNKNOWN_RESOURCE_TYPE" // APIResourceTypeEXPERIMENT captures enum value "EXPERIMENT" APIResourceTypeEXPERIMENT APIResourceType = "EXPERIMENT" // APIResourceTypeJOB captures enum value "JOB" APIResourceTypeJOB APIResourceType = "JOB" // APIResourceTypePIPELINE captures enum value "PIPELINE" APIResourceTypePIPELINE APIResourceType = "PIPELINE" // APIResourceTypePIPELINEVERSION captures enum value "PIPELINE_VERSION" APIResourceTypePIPELINEVERSION APIResourceType = "PIPELINE_VERSION" // APIResourceTypeNAMESPACE captures enum value "NAMESPACE" APIResourceTypeNAMESPACE APIResourceType = "NAMESPACE" )
type APIRun ¶
type APIRun struct {
// Output. The time that the run created.
// Format: date-time
CreatedAt strfmt.DateTime `json:"created_at,omitempty"`
// Optional input field. Describing the purpose of the run
Description string `json:"description,omitempty"`
// In case any error happens retrieving a run field, only run ID
// and the error message is returned. Client has the flexibility of choosing
// how to handle error. This is especially useful during listing call.
Error string `json:"error,omitempty"`
// Output. The time this run is finished.
// Format: date-time
FinishedAt strfmt.DateTime `json:"finished_at,omitempty"`
// Output. Unique run ID. Generated by API server.
ID string `json:"id,omitempty"`
// Output. The metrics of the run. The metrics are reported by ReportMetrics
// API.
Metrics []*APIRunMetric `json:"metrics"`
// Required input field. Name provided by user,
// or auto generated if run is created by scheduled job. Not unique.
Name string `json:"name,omitempty"`
// Required input field.
// Describing what the pipeline manifest and parameters to use for the run.
PipelineSpec *APIPipelineSpec `json:"pipeline_spec,omitempty"`
// Optional input field. Specify which resource this run belongs to.
ResourceReferences []*APIResourceReference `json:"resource_references"`
// Output. When this run is scheduled to run. This could be different from
// created_at. For example, if a run is from a backfilling job that was
// supposed to run 2 month ago, the scheduled_at is 2 month ago,
// v.s. created_at is the current time.
// Format: date-time
ScheduledAt strfmt.DateTime `json:"scheduled_at,omitempty"`
// Optional input field. Specify which Kubernetes service account this run uses.
ServiceAccount string `json:"service_account,omitempty"`
// Output. The status of the run.
// One of [Pending, Running, Succeeded, Skipped, Failed, Error]
Status string `json:"status,omitempty"`
// storage state
StorageState RunStorageState `json:"storage_state,omitempty"`
}
APIRun api run swagger:model apiRun
func (*APIRun) MarshalBinary ¶
MarshalBinary interface implementation
func (*APIRun) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type APIRunDetail ¶
type APIRunDetail struct {
// pipeline runtime
PipelineRuntime *APIPipelineRuntime `json:"pipeline_runtime,omitempty"`
// run
Run *APIRun `json:"run,omitempty"`
}
APIRunDetail api run detail swagger:model apiRunDetail
func (*APIRunDetail) MarshalBinary ¶
func (m *APIRunDetail) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIRunDetail) UnmarshalBinary ¶
func (m *APIRunDetail) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIRunMetric ¶
type APIRunMetric struct {
// The display format of metric.
Format RunMetricFormat `json:"format,omitempty"`
// Required. The user defined name of the metric. It must between 1 and 63
// characters long and must conform to the following regular expression:
// `[a-z]([-a-z0-9]*[a-z0-9])?`.
Name string `json:"name,omitempty"`
// Required. The runtime node ID which reports the metric. The node ID can be
// found in the RunDetail.workflow.Status. Metric with same (node_id, name)
// are considerd as duplicate. Only the first reporting will be recorded. Max
// length is 128.
NodeID string `json:"node_id,omitempty"`
// The number value of the metric.
NumberValue float64 `json:"number_value,omitempty"`
}
APIRunMetric api run metric swagger:model apiRunMetric
func (*APIRunMetric) MarshalBinary ¶
func (m *APIRunMetric) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIRunMetric) UnmarshalBinary ¶
func (m *APIRunMetric) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIStatus ¶
type APIStatus struct {
// code
Code int32 `json:"code,omitempty"`
// details
Details []*ProtobufAny `json:"details"`
// error
Error string `json:"error,omitempty"`
}
APIStatus api status swagger:model apiStatus
func (*APIStatus) MarshalBinary ¶
MarshalBinary interface implementation
func (*APIStatus) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ProtobufAny ¶
type ProtobufAny struct {
// A URL/resource name that uniquely identifies the type of the serialized
// protocol buffer message. The last segment of the URL's path must represent
// the fully qualified name of the type (as in
// `path/google.protobuf.Duration`). The name should be in a canonical form
// (e.g., leading "." is not accepted).
//
// In practice, teams usually precompile into the binary all types that they
// expect it to use in the context of Any. However, for URLs which use the
// scheme `http`, `https`, or no scheme, one can optionally set up a type
// server that maps type URLs to message definitions as follows:
//
// * If no scheme is provided, `https` is assumed.
// * An HTTP GET on the URL must yield a [google.protobuf.Type][]
// value in binary format, or produce an error.
// * Applications are allowed to cache lookup results based on the
// URL, or have them precompiled into a binary to avoid any
// lookup. Therefore, binary compatibility needs to be preserved
// on changes to types. (Use versioned type names to manage
// breaking changes.)
//
// Note: this functionality is not currently available in the official
// protobuf release, and it is not used for type URLs beginning with
// type.googleapis.com.
//
// Schemes other than `http`, `https` (or the empty scheme) might be
// used with implementation specific semantics.
TypeURL string `json:"type_url,omitempty"`
// Must be a valid serialized protocol buffer of the above specified type.
// Format: byte
Value strfmt.Base64 `json:"value,omitempty"`
}
ProtobufAny `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.
Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.
Example 1: Pack and unpack a message in C++.
Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}
Example 2: Pack and unpack a message in Java.
Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
foo = any.unpack(Foo.class);
}
Example 3: Pack and unpack a message in Python.
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
any.Unpack(foo)
...
Example 4: Pack and unpack a message in Go
foo := &pb.Foo{...}
any, err := ptypes.MarshalAny(foo)
...
foo := &pb.Foo{}
if err := ptypes.UnmarshalAny(any, foo); err != nil {
...
}
The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".
JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example:
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}
{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]):
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
swagger:model protobufAny
func (*ProtobufAny) MarshalBinary ¶
func (m *ProtobufAny) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProtobufAny) UnmarshalBinary ¶
func (m *ProtobufAny) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ReportRunMetricsResponseReportRunMetricResult ¶
type ReportRunMetricsResponseReportRunMetricResult struct {
// Output. The detailed message of the error of the reporting.
Message string `json:"message,omitempty"`
// Output. The name of the metric.
MetricName string `json:"metric_name,omitempty"`
// Output. The ID of the node which reports the metric.
MetricNodeID string `json:"metric_node_id,omitempty"`
// Output. The status of the metric reporting.
Status ReportRunMetricsResponseReportRunMetricResultStatus `json:"status,omitempty"`
}
ReportRunMetricsResponseReportRunMetricResult report run metrics response report run metric result swagger:model ReportRunMetricsResponseReportRunMetricResult
func (*ReportRunMetricsResponseReportRunMetricResult) MarshalBinary ¶
func (m *ReportRunMetricsResponseReportRunMetricResult) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ReportRunMetricsResponseReportRunMetricResult) UnmarshalBinary ¶
func (m *ReportRunMetricsResponseReportRunMetricResult) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ReportRunMetricsResponseReportRunMetricResultStatus ¶
type ReportRunMetricsResponseReportRunMetricResultStatus string
ReportRunMetricsResponseReportRunMetricResultStatus - UNSPECIFIED: Default value if not present.
- OK: Indicates successful reporting.
- INVALID_ARGUMENT: Indicates that the payload of the metric is invalid.
- DUPLICATE_REPORTING: Indicates that the metric has been reported before.
- INTERNAL_ERROR: Indicates that something went wrong in the server.
swagger:model ReportRunMetricsResponseReportRunMetricResultStatus
const ( // ReportRunMetricsResponseReportRunMetricResultStatusUNSPECIFIED captures enum value "UNSPECIFIED" ReportRunMetricsResponseReportRunMetricResultStatusUNSPECIFIED ReportRunMetricsResponseReportRunMetricResultStatus = "UNSPECIFIED" // ReportRunMetricsResponseReportRunMetricResultStatusOK captures enum value "OK" ReportRunMetricsResponseReportRunMetricResultStatusOK ReportRunMetricsResponseReportRunMetricResultStatus = "OK" // ReportRunMetricsResponseReportRunMetricResultStatusINVALIDARGUMENT captures enum value "INVALID_ARGUMENT" ReportRunMetricsResponseReportRunMetricResultStatusINVALIDARGUMENT ReportRunMetricsResponseReportRunMetricResultStatus = "INVALID_ARGUMENT" // ReportRunMetricsResponseReportRunMetricResultStatusDUPLICATEREPORTING captures enum value "DUPLICATE_REPORTING" ReportRunMetricsResponseReportRunMetricResultStatusDUPLICATEREPORTING ReportRunMetricsResponseReportRunMetricResultStatus = "DUPLICATE_REPORTING" // ReportRunMetricsResponseReportRunMetricResultStatusINTERNALERROR captures enum value "INTERNAL_ERROR" ReportRunMetricsResponseReportRunMetricResultStatusINTERNALERROR ReportRunMetricsResponseReportRunMetricResultStatus = "INTERNAL_ERROR" )
type RunMetricFormat ¶
type RunMetricFormat string
RunMetricFormat - UNSPECIFIED: Default value if not present.
- RAW: Display value as its raw format.
- PERCENTAGE: Display value in percentage format.
swagger:model RunMetricFormat
const ( // RunMetricFormatUNSPECIFIED captures enum value "UNSPECIFIED" RunMetricFormatUNSPECIFIED RunMetricFormat = "UNSPECIFIED" // RunMetricFormatRAW captures enum value "RAW" RunMetricFormatRAW RunMetricFormat = "RAW" // RunMetricFormatPERCENTAGE captures enum value "PERCENTAGE" RunMetricFormatPERCENTAGE RunMetricFormat = "PERCENTAGE" )
type RunStorageState ¶
type RunStorageState string
RunStorageState run storage state swagger:model RunStorageState
const ( // RunStorageStateSTORAGESTATEAVAILABLE captures enum value "STORAGESTATE_AVAILABLE" RunStorageStateSTORAGESTATEAVAILABLE RunStorageState = "STORAGESTATE_AVAILABLE" // RunStorageStateSTORAGESTATEARCHIVED captures enum value "STORAGESTATE_ARCHIVED" RunStorageStateSTORAGESTATEARCHIVED RunStorageState = "STORAGESTATE_ARCHIVED" )
Source Files
¶
- api_list_runs_response.go
- api_parameter.go
- api_pipeline_runtime.go
- api_pipeline_spec.go
- api_read_artifact_response.go
- api_relationship.go
- api_report_run_metrics_request.go
- api_report_run_metrics_response.go
- api_resource_key.go
- api_resource_reference.go
- api_resource_type.go
- api_run.go
- api_run_detail.go
- api_run_metric.go
- api_status.go
- protobuf_any.go
- report_run_metrics_response_report_run_metric_result.go
- report_run_metrics_response_report_run_metric_result_status.go
- run_metric_format.go
- run_storage_state.go