experiment_model

package
v1.7.0-alpha.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 12, 2021 License: Apache-2.0 Imports: 6 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APIExperiment

type APIExperiment struct {

	// Output. The time that the experiment created.
	// Format: date-time
	CreatedAt strfmt.DateTime `json:"created_at,omitempty"`

	// Optional input field. Describing the purpose of the experiment
	Description string `json:"description,omitempty"`

	// Output. Unique experiment ID. Generated by API server.
	ID string `json:"id,omitempty"`

	// Required input field. Unique experiment name provided by user.
	Name string `json:"name,omitempty"`

	// Optional input field. Specify which resource this run belongs to.
	// For Experiment, the only valid resource reference is a single Namespace.
	ResourceReferences []*APIResourceReference `json:"resource_references"`

	// Output. Specifies whether this experiment is in archived or available state.
	StorageState APIExperimentStorageState `json:"storage_state,omitempty"`
}

APIExperiment api experiment swagger:model apiExperiment

func (*APIExperiment) MarshalBinary

func (m *APIExperiment) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*APIExperiment) UnmarshalBinary

func (m *APIExperiment) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*APIExperiment) Validate

func (m *APIExperiment) Validate(formats strfmt.Registry) error

Validate validates this api experiment

type APIExperimentStorageState

type APIExperimentStorageState string

APIExperimentStorageState api experiment storage state swagger:model apiExperimentStorageState

const (

	// APIExperimentStorageStateSTORAGESTATEUNSPECIFIED captures enum value "STORAGESTATE_UNSPECIFIED"
	APIExperimentStorageStateSTORAGESTATEUNSPECIFIED APIExperimentStorageState = "STORAGESTATE_UNSPECIFIED"

	// APIExperimentStorageStateSTORAGESTATEAVAILABLE captures enum value "STORAGESTATE_AVAILABLE"
	APIExperimentStorageStateSTORAGESTATEAVAILABLE APIExperimentStorageState = "STORAGESTATE_AVAILABLE"

	// APIExperimentStorageStateSTORAGESTATEARCHIVED captures enum value "STORAGESTATE_ARCHIVED"
	APIExperimentStorageStateSTORAGESTATEARCHIVED APIExperimentStorageState = "STORAGESTATE_ARCHIVED"
)

func (APIExperimentStorageState) Validate

func (m APIExperimentStorageState) Validate(formats strfmt.Registry) error

Validate validates this api experiment storage state

type APIListExperimentsResponse

type APIListExperimentsResponse struct {

	// A list of experiments returned.
	Experiments []*APIExperiment `json:"experiments"`

	// The token to list the next page of experiments.
	NextPageToken string `json:"next_page_token,omitempty"`

	// The total number of experiments for the given query.
	TotalSize int32 `json:"total_size,omitempty"`
}

APIListExperimentsResponse api list experiments response swagger:model apiListExperimentsResponse

func (*APIListExperimentsResponse) MarshalBinary

func (m *APIListExperimentsResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*APIListExperimentsResponse) UnmarshalBinary

func (m *APIListExperimentsResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*APIListExperimentsResponse) Validate

func (m *APIListExperimentsResponse) Validate(formats strfmt.Registry) error

Validate validates this api list experiments response

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"
)

func (APIRelationship) Validate

func (m APIRelationship) Validate(formats strfmt.Registry) error

Validate validates this api relationship

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

func (*APIResourceKey) Validate

func (m *APIResourceKey) Validate(formats strfmt.Registry) error

Validate validates this api resource key

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

func (*APIResourceReference) Validate

func (m *APIResourceReference) Validate(formats strfmt.Registry) error

Validate validates this api resource reference

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"
)

func (APIResourceType) Validate

func (m APIResourceType) Validate(formats strfmt.Registry) error

Validate validates this api resource type

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

func (m *APIStatus) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*APIStatus) UnmarshalBinary

func (m *APIStatus) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*APIStatus) Validate

func (m *APIStatus) Validate(formats strfmt.Registry) error

Validate validates this api status

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

func (*ProtobufAny) Validate

func (m *ProtobufAny) Validate(formats strfmt.Registry) error

Validate validates this protobuf any

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL