Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GooglerpcStatus ¶
type GooglerpcStatus struct {
// The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
Code int32 `json:"code,omitempty"`
// A list of messages that carry the error details. There is a common set of
// message types for APIs to use.
Details []*ProtobufAny `json:"details"`
// A developer-facing error message, which should be in English. Any
// user-facing error message should be localized and sent in the
// [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
Message string `json:"message,omitempty"`
}
GooglerpcStatus The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details.
You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). swagger:model googlerpcStatus
func (*GooglerpcStatus) MarshalBinary ¶
func (m *GooglerpcStatus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GooglerpcStatus) UnmarshalBinary ¶
func (m *GooglerpcStatus) UnmarshalBinary(b []byte) error
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
type ProtobufNullValue ¶
type ProtobufNullValue string
ProtobufNullValue `NullValue` is a singleton enumeration to represent the null value for the `Value` type union.
The JSON representation for `NullValue` is JSON `null`. - NULL_VALUE: Null value.
swagger:model protobufNullValue
const ( // ProtobufNullValueNULLVALUE captures enum value "NULL_VALUE" ProtobufNullValueNULLVALUE ProtobufNullValue = "NULL_VALUE" )
type RuntimeError ¶
type RuntimeError struct {
// code
Code int32 `json:"code,omitempty"`
// details
Details []*ProtobufAny `json:"details"`
// error
Error string `json:"error,omitempty"`
// message
Message string `json:"message,omitempty"`
}
RuntimeError runtime error swagger:model runtimeError
func (*RuntimeError) MarshalBinary ¶
func (m *RuntimeError) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RuntimeError) UnmarshalBinary ¶
func (m *RuntimeError) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type V2beta1CreatePipelineAndVersionRequest ¶
type V2beta1CreatePipelineAndVersionRequest struct {
// Required input. Pipeline (parent) to be created.
Pipeline *V2beta1Pipeline `json:"pipeline,omitempty"`
// Required input. Pipeline version (child) to be created.
// Pipeline spec will be downloaded from pipeline_version.package_url.
PipelineVersion *V2beta1PipelineVersion `json:"pipeline_version,omitempty"`
}
V2beta1CreatePipelineAndVersionRequest v2beta1 create pipeline and version request swagger:model v2beta1CreatePipelineAndVersionRequest
func (*V2beta1CreatePipelineAndVersionRequest) MarshalBinary ¶
func (m *V2beta1CreatePipelineAndVersionRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*V2beta1CreatePipelineAndVersionRequest) UnmarshalBinary ¶
func (m *V2beta1CreatePipelineAndVersionRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type V2beta1ListPipelineVersionsResponse ¶
type V2beta1ListPipelineVersionsResponse struct {
// The token to list the next page of pipeline versions.
NextPageToken string `json:"next_page_token,omitempty"`
// Returned pipeline versions.
PipelineVersions []*V2beta1PipelineVersion `json:"pipeline_versions"`
// The total number of pipeline versions for the given query.
TotalSize int32 `json:"total_size,omitempty"`
}
V2beta1ListPipelineVersionsResponse v2beta1 list pipeline versions response swagger:model v2beta1ListPipelineVersionsResponse
func (*V2beta1ListPipelineVersionsResponse) MarshalBinary ¶
func (m *V2beta1ListPipelineVersionsResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*V2beta1ListPipelineVersionsResponse) UnmarshalBinary ¶
func (m *V2beta1ListPipelineVersionsResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type V2beta1ListPipelinesResponse ¶
type V2beta1ListPipelinesResponse struct {
// The token to list the next page of pipelines.
// This token can be used on the next ListPipelinesRequest.
NextPageToken string `json:"next_page_token,omitempty"`
// Returned pipelines.
Pipelines []*V2beta1Pipeline `json:"pipelines"`
// The total number of pipelines for the given query.
TotalSize int32 `json:"total_size,omitempty"`
}
V2beta1ListPipelinesResponse v2beta1 list pipelines response swagger:model v2beta1ListPipelinesResponse
func (*V2beta1ListPipelinesResponse) MarshalBinary ¶
func (m *V2beta1ListPipelinesResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*V2beta1ListPipelinesResponse) UnmarshalBinary ¶
func (m *V2beta1ListPipelinesResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type V2beta1Pipeline ¶
type V2beta1Pipeline struct {
// Output. Creation time of the pipeline.
// Format: date-time
CreatedAt strfmt.DateTime `json:"created_at,omitempty"`
// Optional input field. A short description of the pipeline.
Description string `json:"description,omitempty"`
// Required input field. Pipeline name provided by user.
DisplayName string `json:"display_name,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 the error. This is especially useful during listing call.
Error *GooglerpcStatus `json:"error,omitempty"`
// Input. A namespace this pipeline belongs to.
// Causes error if user is not authorized to access the specified namespace.
// If not specified in CreatePipeline, default namespace is used.
Namespace string `json:"namespace,omitempty"`
// Output. Unique pipeline ID. Generated by API server.
PipelineID string `json:"pipeline_id,omitempty"`
}
V2beta1Pipeline v2beta1 pipeline swagger:model v2beta1Pipeline
func (*V2beta1Pipeline) MarshalBinary ¶
func (m *V2beta1Pipeline) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*V2beta1Pipeline) UnmarshalBinary ¶
func (m *V2beta1Pipeline) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type V2beta1PipelineVersion ¶
type V2beta1PipelineVersion struct {
// Input. Optional. The URL to the code source of the pipeline version.
// The code is usually the Python definition of the pipeline and potentially
// related the component definitions. This allows users to trace back to how
// the pipeline YAML was created.
CodeSourceURL string `json:"code_source_url,omitempty"`
// Output. Creation time of the pipeline version.
// Format: date-time
CreatedAt strfmt.DateTime `json:"created_at,omitempty"`
// Optional input field. Short description of the pipeline version.
// This is ignored in CreatePipelineAndVersion API.
Description string `json:"description,omitempty"`
// Required input field. Pipeline version name provided by user.
// This is ignored in CreatePipelineAndVersion API.
DisplayName string `json:"display_name,omitempty"`
// In case any error happens retrieving a pipeline version field, only
// pipeline ID, pipeline version ID, and the error message are returned.
// Client has the flexibility of choosing how to handle the error.
// This is especially useful during List() calls.
Error *GooglerpcStatus `json:"error,omitempty"`
// Input. Required. The URL to the source of the pipeline version.
// This is required when creating the pipeine version through
// CreatePipelineVersion or CreatePipelineAndVersion API.
PackageURL *V2beta1URL `json:"package_url,omitempty"`
// Required input field. Unique ID of the parent pipeline.
// This is ignored in CreatePipelineAndVersion API.
PipelineID string `json:"pipeline_id,omitempty"`
// Output. The pipeline spec for the pipeline version.
PipelineSpec interface{} `json:"pipeline_spec,omitempty"`
// Output. Unique pipeline version ID. Generated by API server.
PipelineVersionID string `json:"pipeline_version_id,omitempty"`
}
V2beta1PipelineVersion v2beta1 pipeline version swagger:model v2beta1PipelineVersion
func (*V2beta1PipelineVersion) MarshalBinary ¶
func (m *V2beta1PipelineVersion) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*V2beta1PipelineVersion) UnmarshalBinary ¶
func (m *V2beta1PipelineVersion) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type V2beta1URL ¶
type V2beta1URL struct {
// URL of the pipeline version definition.
PipelineURL string `json:"pipeline_url,omitempty"`
}
V2beta1URL v2beta1 Url swagger:model v2beta1Url
func (*V2beta1URL) MarshalBinary ¶
func (m *V2beta1URL) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*V2beta1URL) UnmarshalBinary ¶
func (m *V2beta1URL) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
Source Files