Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIGetTemplateResponse ¶
type APIGetTemplateResponse struct {
// The template of the pipeline specified in a GetTemplate request, or of a
// pipeline version specified in a GetPipelinesVersionTemplate request.
Template string `json:"template,omitempty"`
}
APIGetTemplateResponse api get template response swagger:model apiGetTemplateResponse
func (*APIGetTemplateResponse) MarshalBinary ¶
func (m *APIGetTemplateResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIGetTemplateResponse) UnmarshalBinary ¶
func (m *APIGetTemplateResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIListPipelineVersionsResponse ¶
type APIListPipelineVersionsResponse struct {
// The token to list the next page of pipeline versions.
NextPageToken string `json:"next_page_token,omitempty"`
// The total number of pipeline versions for the given query.
TotalSize int32 `json:"total_size,omitempty"`
// versions
Versions []*APIPipelineVersion `json:"versions"`
}
APIListPipelineVersionsResponse api list pipeline versions response swagger:model apiListPipelineVersionsResponse
func (*APIListPipelineVersionsResponse) MarshalBinary ¶
func (m *APIListPipelineVersionsResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIListPipelineVersionsResponse) UnmarshalBinary ¶
func (m *APIListPipelineVersionsResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIListPipelinesResponse ¶
type APIListPipelinesResponse struct {
// The token to list the next page of pipelines.
NextPageToken string `json:"next_page_token,omitempty"`
// pipelines
Pipelines []*APIPipeline `json:"pipelines"`
// The total number of pipelines for the given query.
TotalSize int32 `json:"total_size,omitempty"`
}
APIListPipelinesResponse api list pipelines response swagger:model apiListPipelinesResponse
func (*APIListPipelinesResponse) MarshalBinary ¶
func (m *APIListPipelinesResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIListPipelinesResponse) UnmarshalBinary ¶
func (m *APIListPipelinesResponse) 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 APIPipeline ¶
type APIPipeline struct {
// Output. The time this pipeline is created.
// Format: date-time
CreatedAt strfmt.DateTime `json:"created_at,omitempty"`
// Output only. The default version of the pipeline. As of now, the latest
// version is used as default. (In the future, if desired by customers, we
// can allow them to set default version.)
// Read Only: true
DefaultVersion *APIPipelineVersion `json:"default_version,omitempty"`
// Optional input field. Describing the purpose of the job.
Description string `json:"description,omitempty"`
// In case any error happens retrieving a pipeline field, only pipeline 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. Unique pipeline ID. Generated by API server.
ID string `json:"id,omitempty"`
// Optional input field. Pipeline name provided by user. If not specified,
// file name is used as pipeline name.
Name string `json:"name,omitempty"`
// Output. The input parameters for this pipeline.
// TODO(jingzhang36): replace this parameters field with the parameters field
// inside PipelineVersion when all usage of the former has been changed to use
// the latter.
Parameters []*APIParameter `json:"parameters"`
// Input field. Specify which resource this pipeline belongs to.
// For Pipeline, the only valid resource reference is a single Namespace.
ResourceReferences []*APIResourceReference `json:"resource_references"`
// The URL to the source of the pipeline. This is required when creating the
// pipeine through CreatePipeline API.
// TODO(jingzhang36): replace this url field with the code_source_urls field
// inside PipelineVersion when all usage of the former has been changed to use
// the latter.
URL *APIURL `json:"url,omitempty"`
}
APIPipeline api pipeline swagger:model apiPipeline
func (*APIPipeline) MarshalBinary ¶
func (m *APIPipeline) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIPipeline) UnmarshalBinary ¶
func (m *APIPipeline) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIPipelineVersion ¶
type APIPipelineVersion struct {
// Input. Optional. Pipeline version code source.
CodeSourceURL string `json:"code_source_url,omitempty"`
// Output. The time this pipeline version is created.
// Format: date-time
CreatedAt strfmt.DateTime `json:"created_at,omitempty"`
// Output. Unique version ID. Generated by API server.
ID string `json:"id,omitempty"`
// Optional input field. Version name provided by user.
Name string `json:"name,omitempty"`
// Input. Required. Pipeline version package url.
// Whe calling CreatePipelineVersion API method, need to provide one package
// file location.
PackageURL *APIURL `json:"package_url,omitempty"`
// Output. The input parameters for this pipeline.
Parameters []*APIParameter `json:"parameters"`
// Input field. Specify which resource this pipeline version belongs to.
// For Experiment, the only valid resource reference is a single Namespace.
ResourceReferences []*APIResourceReference `json:"resource_references"`
}
APIPipelineVersion api pipeline version swagger:model apiPipelineVersion
func (*APIPipelineVersion) MarshalBinary ¶
func (m *APIPipelineVersion) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIPipelineVersion) UnmarshalBinary ¶
func (m *APIPipelineVersion) 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 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 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 APIURL ¶
type APIURL struct {
// URL of the pipeline definition or the pipeline version definition.
PipelineURL string `json:"pipeline_url,omitempty"`
}
APIURL api Url swagger:model apiUrl
func (*APIURL) MarshalBinary ¶
MarshalBinary interface implementation
func (*APIURL) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ProtobufAny ¶
type ProtobufAny struct {
// A URL/resource name that uniquely identifies the type of the serialized
// protocol buffer message. This string must contain at least
// one "/" character. 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 := anypb.New(foo)
if err != nil {
...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(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
Source Files