recurring_run_model

package
v0.0.0-...-ffaeeda Latest Latest
Warning

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

 Go to latest Published: Sep 16, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

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

func (m *GooglerpcStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this googlerpc status based on the context it is used

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

func (*GooglerpcStatus) Validate 

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

Validate validates this googlerpc 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. As of May 2023, there are no widely used type server
	// implementations and no plans to implement one.
	//
	// Schemes other than `http`, `https` (or the empty scheme) might be
	// used with implementation specific semantics.
	AtType string `json:"@type,omitempty"`

	// protobuf any
	ProtobufAny map[string]interface{} `json:"-"`
}

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);
   }
   // or ...
   if (any.isSameTypeAs(Foo.getDefaultInstance())) {
     foo = any.unpack(Foo.getDefaultInstance());
   }

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

func (m *ProtobufAny) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this protobuf any based on context it is used

func (*ProtobufAny) MarshalBinary 

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

MarshalBinary interface implementation

func (ProtobufAny) MarshalJSON 

func (m ProtobufAny) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object with additional properties into a JSON object

func (*ProtobufAny) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*ProtobufAny) UnmarshalJSON 

func (m *ProtobufAny) UnmarshalJSON(data []byte) error

UnmarshalJSON unmarshals this object with additional properties from JSON

func (*ProtobufAny) Validate 

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

Validate validates this protobuf any

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

func NewProtobufNullValue 

func NewProtobufNullValue(value ProtobufNullValue) *ProtobufNullValue

func (ProtobufNullValue) ContextValidate 

func (m ProtobufNullValue) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this protobuf null value based on context it is used

func (ProtobufNullValue) Pointer 

func (m ProtobufNullValue) Pointer() *ProtobufNullValue

Pointer returns a pointer to a freshly-allocated ProtobufNullValue.

func (ProtobufNullValue) Validate 

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

Validate validates this protobuf null value

type RecurringRunMode 

type RecurringRunMode string

RecurringRunMode Required input. User setting to enable or disable the recurring run. Only used for creation of recurring runs. Later updates use enable/disable API.

  • DISABLE: The recurring run won't schedule any run if disabled.

swagger:model RecurringRunMode 

const (

	// RecurringRunModeMODEUNSPECIFIED captures enum value "MODE_UNSPECIFIED"
	RecurringRunModeMODEUNSPECIFIED RecurringRunMode = "MODE_UNSPECIFIED"

	// RecurringRunModeENABLE captures enum value "ENABLE"
	RecurringRunModeENABLE RecurringRunMode = "ENABLE"

	// RecurringRunModeDISABLE captures enum value "DISABLE"
	RecurringRunModeDISABLE RecurringRunMode = "DISABLE"
)

func NewRecurringRunMode 

func NewRecurringRunMode(value RecurringRunMode) *RecurringRunMode

func (RecurringRunMode) ContextValidate 

func (m RecurringRunMode) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this recurring run mode based on context it is used

func (RecurringRunMode) Pointer 

func (m RecurringRunMode) Pointer() *RecurringRunMode

Pointer returns a pointer to a freshly-allocated RecurringRunMode.

func (RecurringRunMode) Validate 

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

Validate validates this recurring run mode

type V2beta1CronSchedule 

type V2beta1CronSchedule struct {

	// The cron string. For details how to compose a cron, visit
	// ttps://en.wikipedia.org/wiki/Cron
	Cron string `json:"cron,omitempty"`

	// The end time of the cron job.
	// Format: date-time
	EndTime strfmt.DateTime `json:"end_time,omitempty"`

	// The start time of the cron job.
	// Format: date-time
	StartTime strfmt.DateTime `json:"start_time,omitempty"`
}

V2beta1CronSchedule CronSchedule allow scheduling the recurring run with unix-like cron.

swagger:model v2beta1CronSchedule

func (*V2beta1CronSchedule) ContextValidate 

func (m *V2beta1CronSchedule) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this v2beta1 cron schedule based on context it is used

func (*V2beta1CronSchedule) MarshalBinary 

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

MarshalBinary interface implementation

func (*V2beta1CronSchedule) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*V2beta1CronSchedule) Validate 

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

Validate validates this v2beta1 cron schedule

type V2beta1ListRecurringRunsResponse 

type V2beta1ListRecurringRunsResponse struct {

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

	// A list of recurring runs returned.
	RecurringRuns []*V2beta1RecurringRun `json:"recurringRuns"`

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

V2beta1ListRecurringRunsResponse v2beta1 list recurring runs response

swagger:model v2beta1ListRecurringRunsResponse

func (*V2beta1ListRecurringRunsResponse) ContextValidate 

func (m *V2beta1ListRecurringRunsResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this v2beta1 list recurring runs response based on the context it is used

func (*V2beta1ListRecurringRunsResponse) MarshalBinary 

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

MarshalBinary interface implementation

func (*V2beta1ListRecurringRunsResponse) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*V2beta1ListRecurringRunsResponse) Validate 

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

Validate validates this v2beta1 list recurring runs response

type V2beta1PeriodicSchedule 

type V2beta1PeriodicSchedule struct {

	// The end time of the periodic recurring run.
	// Format: date-time
	EndTime strfmt.DateTime `json:"end_time,omitempty"`

	// The time interval between the starting time of consecutive recurring runs.
	IntervalSecond int64 `json:"interval_second,omitempty,string"`

	// The start time of the periodic recurring run.
	// Format: date-time
	StartTime strfmt.DateTime `json:"start_time,omitempty"`
}

V2beta1PeriodicSchedule PeriodicSchedule allow scheduling the recurring run periodically with certain interval.

swagger:model v2beta1PeriodicSchedule

func (*V2beta1PeriodicSchedule) ContextValidate 

func (m *V2beta1PeriodicSchedule) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this v2beta1 periodic schedule based on context it is used

func (*V2beta1PeriodicSchedule) MarshalBinary 

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

MarshalBinary interface implementation

func (*V2beta1PeriodicSchedule) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*V2beta1PeriodicSchedule) Validate 

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

Validate validates this v2beta1 periodic schedule

type V2beta1PipelineVersionReference 

type V2beta1PipelineVersionReference struct {

	// Input. Required. Unique ID of the parent pipeline.
	PipelineID string `json:"pipeline_id,omitempty"`

	// Input. Optional. Unique ID of an existing pipeline version. If unset, the latest pipeline version is used.
	PipelineVersionID string `json:"pipeline_version_id,omitempty"`
}

V2beta1PipelineVersionReference Reference to an existing pipeline version.

swagger:model v2beta1PipelineVersionReference

func (*V2beta1PipelineVersionReference) ContextValidate 

func (m *V2beta1PipelineVersionReference) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this v2beta1 pipeline version reference based on context it is used

func (*V2beta1PipelineVersionReference) MarshalBinary 

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

MarshalBinary interface implementation

func (*V2beta1PipelineVersionReference) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*V2beta1PipelineVersionReference) Validate 

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

Validate validates this v2beta1 pipeline version reference

type V2beta1RecurringRun 

type V2beta1RecurringRun struct {

	// Output. The time this recurring run was created.
	// Format: date-time
	CreatedAt strfmt.DateTime `json:"created_at,omitempty"`

	// Optional input field. Describes the purpose of the recurring run.
	Description string `json:"description,omitempty"`

	// Required input field. Recurring run name provided by user. Not unique.
	DisplayName string `json:"display_name,omitempty"`

	// In case any error happens retrieving a recurring run field, only recurring run 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"`

	// ID of the parent experiment this recurring run belongs to.
	ExperimentID string `json:"experiment_id,omitempty"`

	// Required input field.
	// Specifies how many runs can be executed concurrently. Range [1-10].
	MaxConcurrency int64 `json:"max_concurrency,omitempty,string"`

	// mode
	Mode *RecurringRunMode `json:"mode,omitempty"`

	// TODO (gkclat): consider removing this field if it can be obtained from the parent experiment.
	// Output only. Namespace this recurring run belongs to. Derived from the parent experiment.
	// Read Only: true
	Namespace string `json:"namespace,omitempty"`

	// Optional input field. Whether the recurring run should catch up if behind schedule.
	// If true, the recurring run will only schedule the latest interval if behind schedule.
	// If false, the recurring run will catch up on each past interval.
	NoCatchup bool `json:"no_catchup,omitempty"`

	// The pipeline spec.
	PipelineSpec interface{} `json:"pipeline_spec,omitempty"`

	// This field is Deprecated. The pipeline version id is under pipeline_version_reference for v2.
	PipelineVersionID string `json:"pipeline_version_id,omitempty"`

	// Reference to a pipeline version containing pipeline_id and pipeline_version_id.
	PipelineVersionReference *V2beta1PipelineVersionReference `json:"pipeline_version_reference,omitempty"`

	// Output. Unique run ID generated by API server.
	RecurringRunID string `json:"recurring_run_id,omitempty"`

	// Runtime config of the pipeline.
	RuntimeConfig *V2beta1RuntimeConfig `json:"runtime_config,omitempty"`

	// Optional input field. Specifies which Kubernetes service account this recurring run uses.
	ServiceAccount string `json:"service_account,omitempty"`

	// status
	Status *V2beta1RecurringRunStatus `json:"status,omitempty"`

	// Required input field.
	// Specifies how a run is triggered. Support cron mode or periodic mode.
	Trigger *V2beta1Trigger `json:"trigger,omitempty"`

	// Output. The last time this recurring run was updated.
	// Format: date-time
	UpdatedAt strfmt.DateTime `json:"updated_at,omitempty"`
}

V2beta1RecurringRun v2beta1 recurring run

swagger:model v2beta1RecurringRun

func (*V2beta1RecurringRun) ContextValidate 

func (m *V2beta1RecurringRun) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this v2beta1 recurring run based on the context it is used

func (*V2beta1RecurringRun) MarshalBinary 

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

MarshalBinary interface implementation

func (*V2beta1RecurringRun) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*V2beta1RecurringRun) Validate 

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

Validate validates this v2beta1 recurring run

type V2beta1RecurringRunStatus 

type V2beta1RecurringRunStatus string

V2beta1RecurringRunStatus Output. The status of the recurring run.

swagger:model v2beta1RecurringRunStatus 

const (

	// V2beta1RecurringRunStatusSTATUSUNSPECIFIED captures enum value "STATUS_UNSPECIFIED"
	V2beta1RecurringRunStatusSTATUSUNSPECIFIED V2beta1RecurringRunStatus = "STATUS_UNSPECIFIED"

	// V2beta1RecurringRunStatusENABLED captures enum value "ENABLED"
	V2beta1RecurringRunStatusENABLED V2beta1RecurringRunStatus = "ENABLED"

	// V2beta1RecurringRunStatusDISABLED captures enum value "DISABLED"
	V2beta1RecurringRunStatusDISABLED V2beta1RecurringRunStatus = "DISABLED"
)

func NewV2beta1RecurringRunStatus 

func NewV2beta1RecurringRunStatus(value V2beta1RecurringRunStatus) *V2beta1RecurringRunStatus

func (V2beta1RecurringRunStatus) ContextValidate 

func (m V2beta1RecurringRunStatus) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this v2beta1 recurring run status based on context it is used

func (V2beta1RecurringRunStatus) Pointer 

func (m V2beta1RecurringRunStatus) Pointer() *V2beta1RecurringRunStatus

Pointer returns a pointer to a freshly-allocated V2beta1RecurringRunStatus.

func (V2beta1RecurringRunStatus) Validate 

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

Validate validates this v2beta1 recurring run status

type V2beta1RuntimeConfig 

type V2beta1RuntimeConfig struct {

	// The runtime parameters of the Pipeline. The parameters will be
	// used to replace the placeholders at runtime.
	Parameters map[string]interface{} `json:"parameters,omitempty"`

	// A path in a object store bucket which will be treated as the root
	// output directory of the pipeline. It is used by the system to
	// generate the paths of output artifacts.
	// Ref:(https://www.kubeflow.org/docs/components/pipelines/pipeline-root/)
	PipelineRoot string `json:"pipeline_root,omitempty"`
}

V2beta1RuntimeConfig The runtime config.

swagger:model v2beta1RuntimeConfig

func (*V2beta1RuntimeConfig) ContextValidate 

func (m *V2beta1RuntimeConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this v2beta1 runtime config based on context it is used

func (*V2beta1RuntimeConfig) MarshalBinary 

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

MarshalBinary interface implementation

func (*V2beta1RuntimeConfig) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*V2beta1RuntimeConfig) Validate 

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

Validate validates this v2beta1 runtime config

type V2beta1Trigger 

type V2beta1Trigger struct {

	// cron schedule
	CronSchedule *V2beta1CronSchedule `json:"cron_schedule,omitempty"`

	// periodic schedule
	PeriodicSchedule *V2beta1PeriodicSchedule `json:"periodic_schedule,omitempty"`
}

V2beta1Trigger Trigger defines what starts a pipeline run.

swagger:model v2beta1Trigger

func (*V2beta1Trigger) ContextValidate 

func (m *V2beta1Trigger) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this v2beta1 trigger based on the context it is used

func (*V2beta1Trigger) MarshalBinary 

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

MarshalBinary interface implementation

func (*V2beta1Trigger) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*V2beta1Trigger) Validate 

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

Validate validates this v2beta1 trigger

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.