lifesciencespb

package
v0.10.2 Latest Latest
Warning

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

 Go to latest Published: Oct 23, 2024 License: Apache-2.0 Imports: 13 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_google_cloud_lifesciences_v2beta_workflows_proto protoreflect.FileDescriptor

Functions

func RegisterWorkflowsServiceV2BetaServer 

func RegisterWorkflowsServiceV2BetaServer(s *grpc.Server, srv WorkflowsServiceV2BetaServer)

Types

type Accelerator 

type Accelerator struct {

	// The accelerator type string (for example, "nvidia-tesla-t4").
	//
	// Only NVIDIA GPU accelerators are currently supported. If an NVIDIA GPU is
	// attached, the required runtime libraries will be made available to all
	// containers under `/usr/local/nvidia`. The driver version to install must
	// be specified using the NVIDIA driver version parameter on the virtual
	// machine specification. Note that attaching a GPU increases the worker VM
	// startup time by a few minutes.
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// How many accelerators of this type to attach.
	Count int64 `protobuf:"varint,2,opt,name=count,proto3" json:"count,omitempty"`
	// contains filtered or unexported fields
}

Carries information about an accelerator that can be attached to a VM.

func (*Accelerator) Descriptor deprecated 

func (*Accelerator) Descriptor() ([]byte, []int)

Deprecated: Use Accelerator.ProtoReflect.Descriptor instead.

func (*Accelerator) GetCount 

func (x *Accelerator) GetCount() int64

func (*Accelerator) GetType 

func (x *Accelerator) GetType() string

func (*Accelerator) ProtoMessage 

func (*Accelerator) ProtoMessage()

func (*Accelerator) ProtoReflect 

func (x *Accelerator) ProtoReflect() protoreflect.Message

func (*Accelerator) Reset 

func (x *Accelerator) Reset()

func (*Accelerator) String 

func (x *Accelerator) String() string

type Action 

type Action struct {

	// An optional name for the container. The container hostname will be set to
	// this name, making it useful for inter-container communication. The name
	// must contain only upper and lowercase alphanumeric characters and hyphens
	// and cannot start with a hyphen.
	ContainerName string `protobuf:"bytes,1,opt,name=container_name,json=containerName,proto3" json:"container_name,omitempty"`
	// Required. The URI to pull the container image from. Note that all images
	// referenced by actions in the pipeline are pulled before the first action
	// runs. If multiple actions reference the same image, it is only pulled once,
	// ensuring that the same image is used for all actions in a single pipeline.
	//
	// The image URI can be either a complete host and image specification (e.g.,
	// quay.io/biocontainers/samtools), a library and image name (e.g.,
	// google/cloud-sdk) or a bare image name ('bash') to pull from the default
	// library.  No schema is required in any of these cases.
	//
	// If the specified image is not public, the service account specified for
	// the Virtual Machine must have access to pull the images from GCR, or
	// appropriate credentials must be specified in the
	// [google.cloud.lifesciences.v2beta.Action.credentials][google.cloud.lifesciences.v2beta.Action.credentials]
	// field.
	ImageUri string `protobuf:"bytes,2,opt,name=image_uri,json=imageUri,proto3" json:"image_uri,omitempty"`
	// If specified, overrides the `CMD` specified in the container. If the
	// container also has an `ENTRYPOINT` the values are used as entrypoint
	// arguments. Otherwise, they are used as a command and arguments to run
	// inside the container.
	Commands []string `protobuf:"bytes,3,rep,name=commands,proto3" json:"commands,omitempty"`
	// If specified, overrides the `ENTRYPOINT` specified in the container.
	Entrypoint string `protobuf:"bytes,4,opt,name=entrypoint,proto3" json:"entrypoint,omitempty"`
	// The environment to pass into the container. This environment is merged
	// with values specified in the
	// [google.cloud.lifesciences.v2beta.Pipeline][google.cloud.lifesciences.v2beta.Pipeline]
	// message, overwriting any duplicate values.
	//
	// In addition to the values passed here, a few other values are
	// automatically injected into the environment. These cannot be hidden or
	// overwritten.
	//
	// `GOOGLE_PIPELINE_FAILED` will be set to "1" if the pipeline failed
	// because an action has exited with a non-zero status (and did not have the
	// `IGNORE_EXIT_STATUS` flag set). This can be used to determine if additional
	// debug or logging actions should execute.
	//
	// `GOOGLE_LAST_EXIT_STATUS` will be set to the exit status of the last
	// non-background action that executed. This can be used by workflow engine
	// authors to determine whether an individual action has succeeded or failed.
	Environment map[string]string `` /* 163-byte string literal not displayed */
	// The encrypted environment to pass into the container. This environment is
	// merged with values specified in the
	// [google.cloud.lifesciences.v2beta.Pipeline][google.cloud.lifesciences.v2beta.Pipeline]
	// message, overwriting any duplicate values.
	//
	// The secret must decrypt to a JSON-encoded dictionary where key-value pairs
	// serve as environment variable names and their values. The decoded
	// environment variables can overwrite the values specified by the
	// `environment` field.
	EncryptedEnvironment *Secret `protobuf:"bytes,21,opt,name=encrypted_environment,json=encryptedEnvironment,proto3" json:"encrypted_environment,omitempty"`
	// An optional identifier for a PID namespace to run the action inside.
	// Multiple actions should use the same string to share a namespace.  If
	// unspecified, a separate isolated namespace is used.
	PidNamespace string `protobuf:"bytes,6,opt,name=pid_namespace,json=pidNamespace,proto3" json:"pid_namespace,omitempty"`
	// A map of containers to host port mappings for this container. If the
	// container already specifies exposed ports, use the
	// `PUBLISH_EXPOSED_PORTS` flag instead.
	//
	// The host port number must be less than 65536. If it is zero, an unused
	// random port is assigned. To determine the resulting port number, consult
	// the `ContainerStartedEvent` in the operation metadata.
	PortMappings map[int32]int32 `` /* 187-byte string literal not displayed */
	// A list of mounts to make available to the action.
	//
	// In addition to the values specified here, every action has a special
	// virtual disk mounted under `/google` that contains log files and other
	// operational components.
	//
	// <ul>
	//
	//	<li><code>/google/logs</code> All logs written during the pipeline
	//	execution.</li>
	//	<li><code>/google/logs/output</code> The combined standard output and
	//	standard error of all actions run as part of the pipeline
	//	execution.</li>
	//	<li><code>/google/logs/action/*/stdout</code> The complete contents of
	//	each individual action's standard output.</li>
	//	<li><code>/google/logs/action/*/stderr</code> The complete contents of
	//	each individual action's standard error output.</li>
	//
	// </ul>
	Mounts []*Mount `protobuf:"bytes,9,rep,name=mounts,proto3" json:"mounts,omitempty"`
	// Labels to associate with the action. This field is provided to assist
	// workflow engine authors in identifying actions (for example, to indicate
	// what sort of action they perform, such as localization or debugging).
	// They are returned in the operation metadata, but are otherwise ignored.
	Labels map[string]string `` /* 154-byte string literal not displayed */
	// If the specified image is hosted on a private registry other than Google
	// Container Registry, the credentials required to pull the image must be
	// specified here as an encrypted secret.
	//
	// The secret must decrypt to a JSON-encoded dictionary containing both
	// `username` and `password` keys.
	Credentials *Secret `protobuf:"bytes,11,opt,name=credentials,proto3" json:"credentials,omitempty"`
	// The maximum amount of time to give the action to complete. If the action
	// fails to complete before the timeout, it will be terminated and the exit
	// status will be non-zero. The pipeline will continue or terminate based
	// on the rules defined by the `ALWAYS_RUN` and `IGNORE_EXIT_STATUS` flags.
	Timeout *durationpb.Duration `protobuf:"bytes,12,opt,name=timeout,proto3" json:"timeout,omitempty"`
	// Normally, a non-zero exit status causes the pipeline to fail. This flag
	// allows execution of other actions to continue instead.
	IgnoreExitStatus bool `protobuf:"varint,13,opt,name=ignore_exit_status,json=ignoreExitStatus,proto3" json:"ignore_exit_status,omitempty"`
	// This flag allows an action to continue running in the background while
	// executing subsequent actions. This is useful to provide services to
	// other actions (or to provide debugging support tools like SSH servers).
	RunInBackground bool `protobuf:"varint,14,opt,name=run_in_background,json=runInBackground,proto3" json:"run_in_background,omitempty"`
	// By default, after an action fails, no further actions are run. This flag
	// indicates that this action must be run even if the pipeline has already
	// failed. This is useful for actions that copy output files off of the VM
	// or for debugging. Note that no actions will be run if image prefetching
	// fails.
	AlwaysRun bool `protobuf:"varint,15,opt,name=always_run,json=alwaysRun,proto3" json:"always_run,omitempty"`
	// Enable access to the FUSE device for this action. Filesystems can then
	// be mounted into disks shared with other actions. The other actions do
	// not need the `enable_fuse` flag to access the mounted filesystem.
	//
	// This has the effect of causing the container to be executed with
	// `CAP_SYS_ADMIN` and exposes `/dev/fuse` to the container, so use it only
	// for containers you trust.
	EnableFuse bool `protobuf:"varint,16,opt,name=enable_fuse,json=enableFuse,proto3" json:"enable_fuse,omitempty"`
	// Exposes all ports specified by `EXPOSE` statements in the container. To
	// discover the host side port numbers, consult the `ACTION_STARTED` event
	// in the operation metadata.
	PublishExposedPorts bool `protobuf:"varint,17,opt,name=publish_exposed_ports,json=publishExposedPorts,proto3" json:"publish_exposed_ports,omitempty"`
	// All container images are typically downloaded before any actions are
	// executed. This helps prevent typos in URIs or issues like lack of disk
	// space from wasting large amounts of compute resources.
	//
	// If set, this flag prevents the worker from downloading the image until
	// just before the action is executed.
	DisableImagePrefetch bool `protobuf:"varint,18,opt,name=disable_image_prefetch,json=disableImagePrefetch,proto3" json:"disable_image_prefetch,omitempty"`
	// A small portion of the container's standard error stream is typically
	// captured and returned inside the `ContainerStoppedEvent`. Setting this
	// flag disables this functionality.
	DisableStandardErrorCapture bool `` /* 148-byte string literal not displayed */
	// Prevents the container from accessing the external network.
	BlockExternalNetwork bool `protobuf:"varint,20,opt,name=block_external_network,json=blockExternalNetwork,proto3" json:"block_external_network,omitempty"`
	// contains filtered or unexported fields
}

Specifies a single action that runs a Docker container.

func (*Action) Descriptor deprecated 

func (*Action) Descriptor() ([]byte, []int)

Deprecated: Use Action.ProtoReflect.Descriptor instead.

func (*Action) GetAlwaysRun 

func (x *Action) GetAlwaysRun() bool

func (*Action) GetBlockExternalNetwork 

func (x *Action) GetBlockExternalNetwork() bool

func (*Action) GetCommands 

func (x *Action) GetCommands() []string

func (*Action) GetContainerName 

func (x *Action) GetContainerName() string

func (*Action) GetCredentials 

func (x *Action) GetCredentials() *Secret

func (*Action) GetDisableImagePrefetch 

func (x *Action) GetDisableImagePrefetch() bool

func (*Action) GetDisableStandardErrorCapture 

func (x *Action) GetDisableStandardErrorCapture() bool

func (*Action) GetEnableFuse 

func (x *Action) GetEnableFuse() bool

func (*Action) GetEncryptedEnvironment added in v0.7.0 

func (x *Action) GetEncryptedEnvironment() *Secret

func (*Action) GetEntrypoint 

func (x *Action) GetEntrypoint() string

func (*Action) GetEnvironment 

func (x *Action) GetEnvironment() map[string]string

func (*Action) GetIgnoreExitStatus 

func (x *Action) GetIgnoreExitStatus() bool

func (*Action) GetImageUri 

func (x *Action) GetImageUri() string

func (*Action) GetLabels 

func (x *Action) GetLabels() map[string]string

func (*Action) GetMounts 

func (x *Action) GetMounts() []*Mount

func (*Action) GetPidNamespace 

func (x *Action) GetPidNamespace() string

func (*Action) GetPortMappings 

func (x *Action) GetPortMappings() map[int32]int32

func (*Action) GetPublishExposedPorts 

func (x *Action) GetPublishExposedPorts() bool

func (*Action) GetRunInBackground 

func (x *Action) GetRunInBackground() bool

func (*Action) GetTimeout 

func (x *Action) GetTimeout() *durationpb.Duration

func (*Action) ProtoMessage 

func (*Action) ProtoMessage()

func (*Action) ProtoReflect 

func (x *Action) ProtoReflect() protoreflect.Message

func (*Action) Reset 

func (x *Action) Reset()

func (*Action) String 

func (x *Action) String() string

type ContainerKilledEvent 

type ContainerKilledEvent struct {

	// The numeric ID of the action that started the container.
	ActionId int32 `protobuf:"varint,1,opt,name=action_id,json=actionId,proto3" json:"action_id,omitempty"`
	// contains filtered or unexported fields
}

An event generated when a container is forcibly terminated by the worker. Currently, this only occurs when the container outlives the timeout specified by the user.

func (*ContainerKilledEvent) Descriptor deprecated 

func (*ContainerKilledEvent) Descriptor() ([]byte, []int)

Deprecated: Use ContainerKilledEvent.ProtoReflect.Descriptor instead.

func (*ContainerKilledEvent) GetActionId 

func (x *ContainerKilledEvent) GetActionId() int32

func (*ContainerKilledEvent) ProtoMessage 

func (*ContainerKilledEvent) ProtoMessage()

func (*ContainerKilledEvent) ProtoReflect 

func (x *ContainerKilledEvent) ProtoReflect() protoreflect.Message

func (*ContainerKilledEvent) Reset 

func (x *ContainerKilledEvent) Reset()

func (*ContainerKilledEvent) String 

func (x *ContainerKilledEvent) String() string

type ContainerStartedEvent 

type ContainerStartedEvent struct {

	// The numeric ID of the action that started this container.
	ActionId int32 `protobuf:"varint,1,opt,name=action_id,json=actionId,proto3" json:"action_id,omitempty"`
	// The container-to-host port mappings installed for this container. This
	// set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag
	// as well as any specified in the `Action` definition.
	PortMappings map[int32]int32 `` /* 187-byte string literal not displayed */
	// The public IP address that can be used to connect to the container. This
	// field is only populated when at least one port mapping is present. If the
	// instance was created with a private address, this field will be empty even
	// if port mappings exist.
	IpAddress string `protobuf:"bytes,3,opt,name=ip_address,json=ipAddress,proto3" json:"ip_address,omitempty"`
	// contains filtered or unexported fields
}

An event generated when a container starts.

func (*ContainerStartedEvent) Descriptor deprecated 

func (*ContainerStartedEvent) Descriptor() ([]byte, []int)

Deprecated: Use ContainerStartedEvent.ProtoReflect.Descriptor instead.

func (*ContainerStartedEvent) GetActionId 

func (x *ContainerStartedEvent) GetActionId() int32

func (*ContainerStartedEvent) GetIpAddress 

func (x *ContainerStartedEvent) GetIpAddress() string

func (*ContainerStartedEvent) GetPortMappings 

func (x *ContainerStartedEvent) GetPortMappings() map[int32]int32

func (*ContainerStartedEvent) ProtoMessage 

func (*ContainerStartedEvent) ProtoMessage()

func (*ContainerStartedEvent) ProtoReflect 

func (x *ContainerStartedEvent) ProtoReflect() protoreflect.Message

func (*ContainerStartedEvent) Reset 

func (x *ContainerStartedEvent) Reset()

func (*ContainerStartedEvent) String 

func (x *ContainerStartedEvent) String() string

type ContainerStoppedEvent 

type ContainerStoppedEvent struct {

	// The numeric ID of the action that started this container.
	ActionId int32 `protobuf:"varint,1,opt,name=action_id,json=actionId,proto3" json:"action_id,omitempty"`
	// The exit status of the container.
	ExitStatus int32 `protobuf:"varint,2,opt,name=exit_status,json=exitStatus,proto3" json:"exit_status,omitempty"`
	// The tail end of any content written to standard error by the container.
	// If the content emits large amounts of debugging noise or contains
	// sensitive information, you can prevent the content from being printed by
	// setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag.
	//
	// Note that only a small amount of the end of the stream is captured here.
	// The entire stream is stored in the `/google/logs` directory mounted into
	// each action, and can be copied off the machine as described elsewhere.
	Stderr string `protobuf:"bytes,3,opt,name=stderr,proto3" json:"stderr,omitempty"`
	// contains filtered or unexported fields
}

An event generated when a container exits.

func (*ContainerStoppedEvent) Descriptor deprecated 

func (*ContainerStoppedEvent) Descriptor() ([]byte, []int)

Deprecated: Use ContainerStoppedEvent.ProtoReflect.Descriptor instead.

func (*ContainerStoppedEvent) GetActionId 

func (x *ContainerStoppedEvent) GetActionId() int32

func (*ContainerStoppedEvent) GetExitStatus 

func (x *ContainerStoppedEvent) GetExitStatus() int32

func (*ContainerStoppedEvent) GetStderr 

func (x *ContainerStoppedEvent) GetStderr() string

func (*ContainerStoppedEvent) ProtoMessage 

func (*ContainerStoppedEvent) ProtoMessage()

func (*ContainerStoppedEvent) ProtoReflect 

func (x *ContainerStoppedEvent) ProtoReflect() protoreflect.Message

func (*ContainerStoppedEvent) Reset 

func (x *ContainerStoppedEvent) Reset()

func (*ContainerStoppedEvent) String 

func (x *ContainerStoppedEvent) String() string

type DelayedEvent 

type DelayedEvent struct {

	// A textual description of the cause of the delay. The string can change
	// without notice because it is often generated by another service (such as
	// Compute Engine).
	Cause string `protobuf:"bytes,1,opt,name=cause,proto3" json:"cause,omitempty"`
	// If the delay was caused by a resource shortage, this field lists the
	// Compute Engine metrics that are preventing this operation from running
	// (for example, `CPUS` or `INSTANCES`). If the particular metric is not
	// known, a single `UNKNOWN` metric will be present.
	Metrics []string `protobuf:"bytes,2,rep,name=metrics,proto3" json:"metrics,omitempty"`
	// contains filtered or unexported fields
}

An event generated whenever a resource limitation or transient error delays execution of a pipeline that was otherwise ready to run.

func (*DelayedEvent) Descriptor deprecated 

func (*DelayedEvent) Descriptor() ([]byte, []int)

Deprecated: Use DelayedEvent.ProtoReflect.Descriptor instead.

func (*DelayedEvent) GetCause 

func (x *DelayedEvent) GetCause() string

func (*DelayedEvent) GetMetrics 

func (x *DelayedEvent) GetMetrics() []string

func (*DelayedEvent) ProtoMessage 

func (*DelayedEvent) ProtoMessage()

func (*DelayedEvent) ProtoReflect 

func (x *DelayedEvent) ProtoReflect() protoreflect.Message

func (*DelayedEvent) Reset 

func (x *DelayedEvent) Reset()

func (*DelayedEvent) String 

func (x *DelayedEvent) String() string

type Disk 

type Disk struct {

	// A user-supplied name for the disk. Used when mounting the disk into
	// actions. The name must contain only upper and lowercase alphanumeric
	// characters and hyphens and cannot start with a hyphen.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The size, in GB, of the disk to attach. If the size is not
	// specified, a default is chosen to ensure reasonable I/O performance.
	//
	// If the disk type is specified as `local-ssd`, multiple local drives are
	// automatically combined to provide the requested size. Note, however, that
	// each physical SSD is 375GB in size, and no more than 8 drives can be
	// attached to a single instance.
	SizeGb int32 `protobuf:"varint,2,opt,name=size_gb,json=sizeGb,proto3" json:"size_gb,omitempty"`
	// The Compute Engine disk type. If unspecified, `pd-standard` is used.
	Type string `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"`
	// An optional image to put on the disk before attaching it to the VM.
	SourceImage string `protobuf:"bytes,4,opt,name=source_image,json=sourceImage,proto3" json:"source_image,omitempty"`
	// contains filtered or unexported fields
}

Carries information about a disk that can be attached to a VM.

See https://cloud.google.com/compute/docs/disks/performance for more information about disk type, size, and performance considerations.

Specify either [`Volume`][google.cloud.lifesciences.v2beta.Volume] or [`Disk`][google.cloud.lifesciences.v2beta.Disk], but not both.

func (*Disk) Descriptor deprecated 

func (*Disk) Descriptor() ([]byte, []int)

Deprecated: Use Disk.ProtoReflect.Descriptor instead.

func (*Disk) GetName 

func (x *Disk) GetName() string

func (*Disk) GetSizeGb 

func (x *Disk) GetSizeGb() int32

func (*Disk) GetSourceImage 

func (x *Disk) GetSourceImage() string

func (*Disk) GetType 

func (x *Disk) GetType() string

func (*Disk) ProtoMessage 

func (*Disk) ProtoMessage()

func (*Disk) ProtoReflect 

func (x *Disk) ProtoReflect() protoreflect.Message

func (*Disk) Reset 

func (x *Disk) Reset()

func (*Disk) String 

func (x *Disk) String() string

type Event 

type Event struct {

	// The time at which the event occurred.
	Timestamp *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// A human-readable description of the event. Note that these strings can
	// change at any time without notice. Any application logic must use the
	// information in the `details` field.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Machine-readable details about the event.
	//
	// Types that are assignable to Details:
	//
	//	*Event_Delayed
	//	*Event_WorkerAssigned
	//	*Event_WorkerReleased
	//	*Event_PullStarted
	//	*Event_PullStopped
	//	*Event_ContainerStarted
	//	*Event_ContainerStopped
	//	*Event_ContainerKilled
	//	*Event_UnexpectedExitStatus
	//	*Event_Failed
	Details isEvent_Details `protobuf_oneof:"details"`
	// contains filtered or unexported fields
}

Carries information about events that occur during pipeline execution.

func (*Event) Descriptor deprecated 

func (*Event) Descriptor() ([]byte, []int)

Deprecated: Use Event.ProtoReflect.Descriptor instead.

func (*Event) GetContainerKilled 

func (x *Event) GetContainerKilled() *ContainerKilledEvent

func (*Event) GetContainerStarted 

func (x *Event) GetContainerStarted() *ContainerStartedEvent

func (*Event) GetContainerStopped 

func (x *Event) GetContainerStopped() *ContainerStoppedEvent

func (*Event) GetDelayed 

func (x *Event) GetDelayed() *DelayedEvent

func (*Event) GetDescription 

func (x *Event) GetDescription() string

func (*Event) GetDetails 

func (m *Event) GetDetails() isEvent_Details

func (*Event) GetFailed 

func (x *Event) GetFailed() *FailedEvent

func (*Event) GetPullStarted 

func (x *Event) GetPullStarted() *PullStartedEvent

func (*Event) GetPullStopped 

func (x *Event) GetPullStopped() *PullStoppedEvent

func (*Event) GetTimestamp 

func (x *Event) GetTimestamp() *timestamppb.Timestamp

func (*Event) GetUnexpectedExitStatus 

func (x *Event) GetUnexpectedExitStatus() *UnexpectedExitStatusEvent

func (*Event) GetWorkerAssigned 

func (x *Event) GetWorkerAssigned() *WorkerAssignedEvent

func (*Event) GetWorkerReleased 

func (x *Event) GetWorkerReleased() *WorkerReleasedEvent

func (*Event) ProtoMessage 

func (*Event) ProtoMessage()

func (*Event) ProtoReflect 

func (x *Event) ProtoReflect() protoreflect.Message

func (*Event) Reset 

func (x *Event) Reset()

func (*Event) String 

func (x *Event) String() string

type Event_ContainerKilled 

type Event_ContainerKilled struct {
	// See
	// [google.cloud.lifesciences.v2beta.ContainerKilledEvent][google.cloud.lifesciences.v2beta.ContainerKilledEvent].
	ContainerKilled *ContainerKilledEvent `protobuf:"bytes,24,opt,name=container_killed,json=containerKilled,proto3,oneof"`
}

type Event_ContainerStarted 

type Event_ContainerStarted struct {
	// See
	// [google.cloud.lifesciences.v2beta.ContainerStartedEvent][google.cloud.lifesciences.v2beta.ContainerStartedEvent].
	ContainerStarted *ContainerStartedEvent `protobuf:"bytes,22,opt,name=container_started,json=containerStarted,proto3,oneof"`
}

type Event_ContainerStopped 

type Event_ContainerStopped struct {
	// See
	// [google.cloud.lifesciences.v2beta.ContainerStoppedEvent][google.cloud.lifesciences.v2beta.ContainerStoppedEvent].
	ContainerStopped *ContainerStoppedEvent `protobuf:"bytes,23,opt,name=container_stopped,json=containerStopped,proto3,oneof"`
}

type Event_Delayed 

type Event_Delayed struct {
	// See
	// [google.cloud.lifesciences.v2beta.DelayedEvent][google.cloud.lifesciences.v2beta.DelayedEvent].
	Delayed *DelayedEvent `protobuf:"bytes,17,opt,name=delayed,proto3,oneof"`
}

type Event_Failed 

type Event_Failed struct {
	// See
	// [google.cloud.lifesciences.v2beta.FailedEvent][google.cloud.lifesciences.v2beta.FailedEvent].
	Failed *FailedEvent `protobuf:"bytes,26,opt,name=failed,proto3,oneof"`
}

type Event_PullStarted 

type Event_PullStarted struct {
	// See
	// [google.cloud.lifesciences.v2beta.PullStartedEvent][google.cloud.lifesciences.v2beta.PullStartedEvent].
	PullStarted *PullStartedEvent `protobuf:"bytes,20,opt,name=pull_started,json=pullStarted,proto3,oneof"`
}

type Event_PullStopped 

type Event_PullStopped struct {
	// See
	// [google.cloud.lifesciences.v2beta.PullStoppedEvent][google.cloud.lifesciences.v2beta.PullStoppedEvent].
	PullStopped *PullStoppedEvent `protobuf:"bytes,21,opt,name=pull_stopped,json=pullStopped,proto3,oneof"`
}

type Event_UnexpectedExitStatus 

type Event_UnexpectedExitStatus struct {
	// See
	// [google.cloud.lifesciences.v2beta.UnexpectedExitStatusEvent][google.cloud.lifesciences.v2beta.UnexpectedExitStatusEvent].
	UnexpectedExitStatus *UnexpectedExitStatusEvent `protobuf:"bytes,25,opt,name=unexpected_exit_status,json=unexpectedExitStatus,proto3,oneof"`
}

type Event_WorkerAssigned 

type Event_WorkerAssigned struct {
	// See
	// [google.cloud.lifesciences.v2beta.WorkerAssignedEvent][google.cloud.lifesciences.v2beta.WorkerAssignedEvent].
	WorkerAssigned *WorkerAssignedEvent `protobuf:"bytes,18,opt,name=worker_assigned,json=workerAssigned,proto3,oneof"`
}

type Event_WorkerReleased 

type Event_WorkerReleased struct {
	// See
	// [google.cloud.lifesciences.v2beta.WorkerReleasedEvent][google.cloud.lifesciences.v2beta.WorkerReleasedEvent].
	WorkerReleased *WorkerReleasedEvent `protobuf:"bytes,19,opt,name=worker_released,json=workerReleased,proto3,oneof"`
}

type ExistingDisk 

type ExistingDisk struct {

	// If `disk` contains slashes, the Cloud Life Sciences API assumes that it is
	// a complete URL for the disk.  If `disk` does not contain slashes, the Cloud
	// Life Sciences API assumes that the disk is a zonal disk and a URL will be
	// generated of the form `zones/<zone>/disks/<disk>`, where `<zone>` is the
	// zone in which the instance is allocated. The disk must be ext4 formatted.
	//
	// If all `Mount` references to this disk have the `read_only` flag set to
	// true, the disk will be attached in `read-only` mode and can be shared with
	// other instances. Otherwise, the disk will be available for writing but
	// cannot be shared.
	Disk string `protobuf:"bytes,1,opt,name=disk,proto3" json:"disk,omitempty"`
	// contains filtered or unexported fields
}

Configuration for an existing disk to be attached to the VM.

func (*ExistingDisk) Descriptor deprecated 

func (*ExistingDisk) Descriptor() ([]byte, []int)

Deprecated: Use ExistingDisk.ProtoReflect.Descriptor instead.

func (*ExistingDisk) GetDisk 

func (x *ExistingDisk) GetDisk() string

func (*ExistingDisk) ProtoMessage 

func (*ExistingDisk) ProtoMessage()

func (*ExistingDisk) ProtoReflect 

func (x *ExistingDisk) ProtoReflect() protoreflect.Message

func (*ExistingDisk) Reset 

func (x *ExistingDisk) Reset()

func (*ExistingDisk) String 

func (x *ExistingDisk) String() string

type FailedEvent 

type FailedEvent struct {

	// The Google standard error code that best describes this failure.
	Code code.Code `protobuf:"varint,1,opt,name=code,proto3,enum=google.rpc.Code" json:"code,omitempty"`
	// The human-readable description of the cause of the failure.
	Cause string `protobuf:"bytes,2,opt,name=cause,proto3" json:"cause,omitempty"`
	// contains filtered or unexported fields
}

An event generated when the execution of a pipeline has failed. Note that other events can continue to occur after this event.

func (*FailedEvent) Descriptor deprecated 

func (*FailedEvent) Descriptor() ([]byte, []int)

Deprecated: Use FailedEvent.ProtoReflect.Descriptor instead.

func (*FailedEvent) GetCause 

func (x *FailedEvent) GetCause() string

func (*FailedEvent) GetCode 

func (x *FailedEvent) GetCode() code.Code

func (*FailedEvent) ProtoMessage 

func (*FailedEvent) ProtoMessage()

func (*FailedEvent) ProtoReflect 

func (x *FailedEvent) ProtoReflect() protoreflect.Message

func (*FailedEvent) Reset 

func (x *FailedEvent) Reset()

func (*FailedEvent) String 

func (x *FailedEvent) String() string

type Metadata 

type Metadata struct {

	// The pipeline this operation represents.
	Pipeline *Pipeline `protobuf:"bytes,1,opt,name=pipeline,proto3" json:"pipeline,omitempty"`
	// The user-defined labels associated with this operation.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// The list of events that have happened so far during the execution of this
	// operation.
	Events []*Event `protobuf:"bytes,3,rep,name=events,proto3" json:"events,omitempty"`
	// The time at which the operation was created by the API.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The first time at which resources were allocated to execute the pipeline.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// The time at which execution was completed and resources were cleaned up.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// The name of the Cloud Pub/Sub topic where notifications of operation status
	// changes are sent.
	PubSubTopic string `protobuf:"bytes,7,opt,name=pub_sub_topic,json=pubSubTopic,proto3" json:"pub_sub_topic,omitempty"`
	// contains filtered or unexported fields
}

Carries information about the pipeline execution that is returned in the long running operation's metadata field.

func (*Metadata) Descriptor deprecated 

func (*Metadata) Descriptor() ([]byte, []int)

Deprecated: Use Metadata.ProtoReflect.Descriptor instead.

func (*Metadata) GetCreateTime 

func (x *Metadata) GetCreateTime() *timestamppb.Timestamp

func (*Metadata) GetEndTime 

func (x *Metadata) GetEndTime() *timestamppb.Timestamp

func (*Metadata) GetEvents 

func (x *Metadata) GetEvents() []*Event

func (*Metadata) GetLabels 

func (x *Metadata) GetLabels() map[string]string

func (*Metadata) GetPipeline 

func (x *Metadata) GetPipeline() *Pipeline

func (*Metadata) GetPubSubTopic 

func (x *Metadata) GetPubSubTopic() string

func (*Metadata) GetStartTime 

func (x *Metadata) GetStartTime() *timestamppb.Timestamp

func (*Metadata) ProtoMessage 

func (*Metadata) ProtoMessage()

func (*Metadata) ProtoReflect 

func (x *Metadata) ProtoReflect() protoreflect.Message

func (*Metadata) Reset 

func (x *Metadata) Reset()

func (*Metadata) String 

func (x *Metadata) String() string

type Mount 

type Mount struct {

	// The name of the disk to mount, as specified in the resources section.
	Disk string `protobuf:"bytes,1,opt,name=disk,proto3" json:"disk,omitempty"`
	// The path to mount the disk inside the container.
	Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// If true, the disk is mounted read-only inside the container.
	ReadOnly bool `protobuf:"varint,3,opt,name=read_only,json=readOnly,proto3" json:"read_only,omitempty"`
	// contains filtered or unexported fields
}

Carries information about a particular disk mount inside a container.

func (*Mount) Descriptor deprecated 

func (*Mount) Descriptor() ([]byte, []int)

Deprecated: Use Mount.ProtoReflect.Descriptor instead.

func (*Mount) GetDisk 

func (x *Mount) GetDisk() string

func (*Mount) GetPath 

func (x *Mount) GetPath() string

func (*Mount) GetReadOnly 

func (x *Mount) GetReadOnly() bool

func (*Mount) ProtoMessage 

func (*Mount) ProtoMessage()

func (*Mount) ProtoReflect 

func (x *Mount) ProtoReflect() protoreflect.Message

func (*Mount) Reset 

func (x *Mount) Reset()

func (*Mount) String 

func (x *Mount) String() string

type NFSMount 

type NFSMount struct {

	// A target NFS mount. The target must be specified as `address:/mount".
	Target string `protobuf:"bytes,1,opt,name=target,proto3" json:"target,omitempty"`
	// contains filtered or unexported fields
}

Configuration for an `NFSMount` to be attached to the VM.

func (*NFSMount) Descriptor deprecated 

func (*NFSMount) Descriptor() ([]byte, []int)

Deprecated: Use NFSMount.ProtoReflect.Descriptor instead.

func (*NFSMount) GetTarget 

func (x *NFSMount) GetTarget() string

func (*NFSMount) ProtoMessage 

func (*NFSMount) ProtoMessage()

func (*NFSMount) ProtoReflect 

func (x *NFSMount) ProtoReflect() protoreflect.Message

func (*NFSMount) Reset 

func (x *NFSMount) Reset()

func (*NFSMount) String 

func (x *NFSMount) String() string

type Network 

type Network struct {

	// The network name to attach the VM's network interface to. The value will
	// be prefixed with `global/networks/` unless it contains a `/`, in which
	// case it is assumed to be a fully specified network resource URL.
	//
	// If unspecified, the global default network is used.
	Network string `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"`
	// If set to true, do not attach a public IP address to the VM. Note that
	// without a public IP address, additional configuration is required to
	// allow the VM to access Google services.
	//
	// See https://cloud.google.com/vpc/docs/configure-private-google-access
	// for more information.
	UsePrivateAddress bool `protobuf:"varint,2,opt,name=use_private_address,json=usePrivateAddress,proto3" json:"use_private_address,omitempty"`
	// If the specified network is configured for custom subnet creation, the
	// name of the subnetwork to attach the instance to must be specified here.
	//
	// The value is prefixed with `regions/*/subnetworks/` unless it contains a
	// `/`, in which case it is assumed to be a fully specified subnetwork
	// resource URL.
	//
	// If the `*` character appears in the value, it is replaced with the region
	// that the virtual machine has been allocated in.
	Subnetwork string `protobuf:"bytes,3,opt,name=subnetwork,proto3" json:"subnetwork,omitempty"`
	// contains filtered or unexported fields
}

VM networking options.

func (*Network) Descriptor deprecated 

func (*Network) Descriptor() ([]byte, []int)

Deprecated: Use Network.ProtoReflect.Descriptor instead.

func (*Network) GetNetwork 

func (x *Network) GetNetwork() string

func (*Network) GetSubnetwork 

func (x *Network) GetSubnetwork() string

func (*Network) GetUsePrivateAddress 

func (x *Network) GetUsePrivateAddress() bool

func (*Network) ProtoMessage 

func (*Network) ProtoMessage()

func (*Network) ProtoReflect 

func (x *Network) ProtoReflect() protoreflect.Message

func (*Network) Reset 

func (x *Network) Reset()

func (*Network) String 

func (x *Network) String() string

type PersistentDisk 

type PersistentDisk struct {

	// The size, in GB, of the disk to attach. If the size is not
	// specified, a default is chosen to ensure reasonable I/O performance.
	//
	// If the disk type is specified as `local-ssd`, multiple local drives are
	// automatically combined to provide the requested size. Note, however, that
	// each physical SSD is 375GB in size, and no more than 8 drives can be
	// attached to a single instance.
	SizeGb int32 `protobuf:"varint,1,opt,name=size_gb,json=sizeGb,proto3" json:"size_gb,omitempty"`
	// The Compute Engine disk type. If unspecified, `pd-standard` is used.
	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	// An image to put on the disk before attaching it to the VM.
	SourceImage string `protobuf:"bytes,3,opt,name=source_image,json=sourceImage,proto3" json:"source_image,omitempty"`
	// contains filtered or unexported fields
}

Configuration for a persistent disk to be attached to the VM.

See https://cloud.google.com/compute/docs/disks/performance for more information about disk type, size, and performance considerations.

func (*PersistentDisk) Descriptor deprecated 

func (*PersistentDisk) Descriptor() ([]byte, []int)

Deprecated: Use PersistentDisk.ProtoReflect.Descriptor instead.

func (*PersistentDisk) GetSizeGb 

func (x *PersistentDisk) GetSizeGb() int32

func (*PersistentDisk) GetSourceImage 

func (x *PersistentDisk) GetSourceImage() string

func (*PersistentDisk) GetType 

func (x *PersistentDisk) GetType() string

func (*PersistentDisk) ProtoMessage 

func (*PersistentDisk) ProtoMessage()

func (*PersistentDisk) ProtoReflect 

func (x *PersistentDisk) ProtoReflect() protoreflect.Message

func (*PersistentDisk) Reset 

func (x *PersistentDisk) Reset()

func (*PersistentDisk) String 

func (x *PersistentDisk) String() string

type Pipeline 

type Pipeline struct {

	// The list of actions to execute, in the order they are specified.
	Actions []*Action `protobuf:"bytes,1,rep,name=actions,proto3" json:"actions,omitempty"`
	// The resources required for execution.
	Resources *Resources `protobuf:"bytes,2,opt,name=resources,proto3" json:"resources,omitempty"`
	// The environment to pass into every action. Each action can also specify
	// additional environment variables but cannot delete an entry from this map
	// (though they can overwrite it with a different value).
	Environment map[string]string `` /* 163-byte string literal not displayed */
	// The encrypted environment to pass into every action. Each action can also
	// specify its own encrypted environment.
	//
	// The secret must decrypt to a JSON-encoded dictionary where key-value pairs
	// serve as environment variable names and their values. The decoded
	// environment variables can overwrite the values specified by the
	// `environment` field.
	EncryptedEnvironment *Secret `protobuf:"bytes,5,opt,name=encrypted_environment,json=encryptedEnvironment,proto3" json:"encrypted_environment,omitempty"`
	// The maximum amount of time to give the pipeline to complete.  This includes
	// the time spent waiting for a worker to be allocated.  If the pipeline fails
	// to complete before the timeout, it will be cancelled and the error code
	// will be set to DEADLINE_EXCEEDED.
	//
	// If unspecified, it will default to 7 days.
	Timeout *durationpb.Duration `protobuf:"bytes,4,opt,name=timeout,proto3" json:"timeout,omitempty"`
	// contains filtered or unexported fields
}

Specifies a series of actions to execute, expressed as Docker containers.

func (*Pipeline) Descriptor deprecated 

func (*Pipeline) Descriptor() ([]byte, []int)

Deprecated: Use Pipeline.ProtoReflect.Descriptor instead.

func (*Pipeline) GetActions 

func (x *Pipeline) GetActions() []*Action

func (*Pipeline) GetEncryptedEnvironment added in v0.7.0 

func (x *Pipeline) GetEncryptedEnvironment() *Secret

func (*Pipeline) GetEnvironment 

func (x *Pipeline) GetEnvironment() map[string]string

func (*Pipeline) GetResources 

func (x *Pipeline) GetResources() *Resources

func (*Pipeline) GetTimeout 

func (x *Pipeline) GetTimeout() *durationpb.Duration

func (*Pipeline) ProtoMessage 

func (*Pipeline) ProtoMessage()

func (*Pipeline) ProtoReflect 

func (x *Pipeline) ProtoReflect() protoreflect.Message

func (*Pipeline) Reset 

func (x *Pipeline) Reset()

func (*Pipeline) String 

func (x *Pipeline) String() string

type PullStartedEvent 

type PullStartedEvent struct {

	// The URI of the image that was pulled.
	ImageUri string `protobuf:"bytes,1,opt,name=image_uri,json=imageUri,proto3" json:"image_uri,omitempty"`
	// contains filtered or unexported fields
}

An event generated when the worker starts pulling an image.

func (*PullStartedEvent) Descriptor deprecated 

func (*PullStartedEvent) Descriptor() ([]byte, []int)

Deprecated: Use PullStartedEvent.ProtoReflect.Descriptor instead.

func (*PullStartedEvent) GetImageUri 

func (x *PullStartedEvent) GetImageUri() string

func (*PullStartedEvent) ProtoMessage 

func (*PullStartedEvent) ProtoMessage()

func (*PullStartedEvent) ProtoReflect 

func (x *PullStartedEvent) ProtoReflect() protoreflect.Message

func (*PullStartedEvent) Reset 

func (x *PullStartedEvent) Reset()

func (*PullStartedEvent) String 

func (x *PullStartedEvent) String() string

type PullStoppedEvent 

type PullStoppedEvent struct {

	// The URI of the image that was pulled.
	ImageUri string `protobuf:"bytes,1,opt,name=image_uri,json=imageUri,proto3" json:"image_uri,omitempty"`
	// contains filtered or unexported fields
}

An event generated when the worker stops pulling an image.

func (*PullStoppedEvent) Descriptor deprecated 

func (*PullStoppedEvent) Descriptor() ([]byte, []int)

Deprecated: Use PullStoppedEvent.ProtoReflect.Descriptor instead.

func (*PullStoppedEvent) GetImageUri 

func (x *PullStoppedEvent) GetImageUri() string

func (*PullStoppedEvent) ProtoMessage 

func (*PullStoppedEvent) ProtoMessage()

func (*PullStoppedEvent) ProtoReflect 

func (x *PullStoppedEvent) ProtoReflect() protoreflect.Message

func (*PullStoppedEvent) Reset 

func (x *PullStoppedEvent) Reset()

func (*PullStoppedEvent) String 

func (x *PullStoppedEvent) String() string

type Resources 

type Resources struct {

	// The list of regions allowed for VM allocation. If set, the `zones` field
	// must not be set.
	Regions []string `protobuf:"bytes,2,rep,name=regions,proto3" json:"regions,omitempty"`
	// The list of zones allowed for VM allocation. If set, the `regions` field
	// must not be set.
	Zones []string `protobuf:"bytes,3,rep,name=zones,proto3" json:"zones,omitempty"`
	// The virtual machine specification.
	VirtualMachine *VirtualMachine `protobuf:"bytes,4,opt,name=virtual_machine,json=virtualMachine,proto3" json:"virtual_machine,omitempty"`
	// contains filtered or unexported fields
}

The system resources for the pipeline run.

At least one zone or region must be specified or the pipeline run will fail.

func (*Resources) Descriptor deprecated 

func (*Resources) Descriptor() ([]byte, []int)

Deprecated: Use Resources.ProtoReflect.Descriptor instead.

func (*Resources) GetRegions 

func (x *Resources) GetRegions() []string

func (*Resources) GetVirtualMachine 

func (x *Resources) GetVirtualMachine() *VirtualMachine

func (*Resources) GetZones 

func (x *Resources) GetZones() []string

func (*Resources) ProtoMessage 

func (*Resources) ProtoMessage()

func (*Resources) ProtoReflect 

func (x *Resources) ProtoReflect() protoreflect.Message

func (*Resources) Reset 

func (x *Resources) Reset()

func (*Resources) String 

func (x *Resources) String() string

type RunPipelineRequest 

type RunPipelineRequest struct {

	// The project and location that this request should be executed against.
	Parent string `protobuf:"bytes,4,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The description of the pipeline to run.
	Pipeline *Pipeline `protobuf:"bytes,1,opt,name=pipeline,proto3" json:"pipeline,omitempty"`
	// User-defined labels to associate with the returned operation. These
	// labels are not propagated to any Google Cloud Platform resources used by
	// the operation, and can be modified at any time.
	//
	// To associate labels with resources created while executing the operation,
	// see the appropriate resource message (for example, `VirtualMachine`).
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// The name of an existing Pub/Sub topic.  The server will publish
	// messages to this topic whenever the status of the operation changes.
	// The Life Sciences Service Agent account must have publisher permissions to
	// the specified topic or notifications will not be sent.
	PubSubTopic string `protobuf:"bytes,3,opt,name=pub_sub_topic,json=pubSubTopic,proto3" json:"pub_sub_topic,omitempty"`
	// contains filtered or unexported fields
}

The arguments to the `RunPipeline` method. The requesting user must have the `iam.serviceAccounts.actAs` permission for the Cloud Life Sciences service account or the request will fail.

func (*RunPipelineRequest) Descriptor deprecated 

func (*RunPipelineRequest) Descriptor() ([]byte, []int)

Deprecated: Use RunPipelineRequest.ProtoReflect.Descriptor instead.

func (*RunPipelineRequest) GetLabels 

func (x *RunPipelineRequest) GetLabels() map[string]string

func (*RunPipelineRequest) GetParent 

func (x *RunPipelineRequest) GetParent() string

func (*RunPipelineRequest) GetPipeline 

func (x *RunPipelineRequest) GetPipeline() *Pipeline

func (*RunPipelineRequest) GetPubSubTopic 

func (x *RunPipelineRequest) GetPubSubTopic() string

func (*RunPipelineRequest) ProtoMessage 

func (*RunPipelineRequest) ProtoMessage()

func (*RunPipelineRequest) ProtoReflect 

func (x *RunPipelineRequest) ProtoReflect() protoreflect.Message

func (*RunPipelineRequest) Reset 

func (x *RunPipelineRequest) Reset()

func (*RunPipelineRequest) String 

func (x *RunPipelineRequest) String() string

type RunPipelineResponse 

type RunPipelineResponse struct {
	// contains filtered or unexported fields
}

The response to the RunPipeline method, returned in the operation's result field on success.

func (*RunPipelineResponse) Descriptor deprecated 

func (*RunPipelineResponse) Descriptor() ([]byte, []int)

Deprecated: Use RunPipelineResponse.ProtoReflect.Descriptor instead.

func (*RunPipelineResponse) ProtoMessage 

func (*RunPipelineResponse) ProtoMessage()

func (*RunPipelineResponse) ProtoReflect 

func (x *RunPipelineResponse) ProtoReflect() protoreflect.Message

func (*RunPipelineResponse) Reset 

func (x *RunPipelineResponse) Reset()

func (*RunPipelineResponse) String 

func (x *RunPipelineResponse) String() string

type Secret 

type Secret struct {

	// The name of the Cloud KMS key that will be used to decrypt the secret
	// value. The VM service account must have the required permissions and
	// authentication scopes to invoke the `decrypt` method on the specified key.
	KeyName string `protobuf:"bytes,1,opt,name=key_name,json=keyName,proto3" json:"key_name,omitempty"`
	// The value of the cipherText response from the `encrypt` method. This field
	// is intentionally unaudited.
	CipherText string `protobuf:"bytes,2,opt,name=cipher_text,json=cipherText,proto3" json:"cipher_text,omitempty"`
	// contains filtered or unexported fields
}

Holds encrypted information that is only decrypted and stored in RAM by the worker VM when running the pipeline.

func (*Secret) Descriptor deprecated 

func (*Secret) Descriptor() ([]byte, []int)

Deprecated: Use Secret.ProtoReflect.Descriptor instead.

func (*Secret) GetCipherText 

func (x *Secret) GetCipherText() string

func (*Secret) GetKeyName 

func (x *Secret) GetKeyName() string

func (*Secret) ProtoMessage 

func (*Secret) ProtoMessage()

func (*Secret) ProtoReflect 

func (x *Secret) ProtoReflect() protoreflect.Message

func (*Secret) Reset 

func (x *Secret) Reset()

func (*Secret) String 

func (x *Secret) String() string

type ServiceAccount 

type ServiceAccount struct {

	// Email address of the service account. If not specified, the default
	// Compute Engine service account for the project will be used.
	Email string `protobuf:"bytes,1,opt,name=email,proto3" json:"email,omitempty"`
	// List of scopes to be enabled for this service account on the VM, in
	// addition to the cloud-platform API scope that will be added by default.
	Scopes []string `protobuf:"bytes,2,rep,name=scopes,proto3" json:"scopes,omitempty"`
	// contains filtered or unexported fields
}

Carries information about a Google Cloud service account.

func (*ServiceAccount) Descriptor deprecated 

func (*ServiceAccount) Descriptor() ([]byte, []int)

Deprecated: Use ServiceAccount.ProtoReflect.Descriptor instead.

func (*ServiceAccount) GetEmail 

func (x *ServiceAccount) GetEmail() string

func (*ServiceAccount) GetScopes 

func (x *ServiceAccount) GetScopes() []string

func (*ServiceAccount) ProtoMessage 

func (*ServiceAccount) ProtoMessage()

func (*ServiceAccount) ProtoReflect 

func (x *ServiceAccount) ProtoReflect() protoreflect.Message

func (*ServiceAccount) Reset 

func (x *ServiceAccount) Reset()

func (*ServiceAccount) String 

func (x *ServiceAccount) String() string

type UnexpectedExitStatusEvent 

type UnexpectedExitStatusEvent struct {

	// The numeric ID of the action that started the container.
	ActionId int32 `protobuf:"varint,1,opt,name=action_id,json=actionId,proto3" json:"action_id,omitempty"`
	// The exit status of the container.
	ExitStatus int32 `protobuf:"varint,2,opt,name=exit_status,json=exitStatus,proto3" json:"exit_status,omitempty"`
	// contains filtered or unexported fields
}

An event generated when the execution of a container results in a non-zero exit status that was not otherwise ignored. Execution will continue, but only actions that are flagged as `ALWAYS_RUN` will be executed. Other actions will be skipped.

func (*UnexpectedExitStatusEvent) Descriptor deprecated 

func (*UnexpectedExitStatusEvent) Descriptor() ([]byte, []int)

Deprecated: Use UnexpectedExitStatusEvent.ProtoReflect.Descriptor instead.

func (*UnexpectedExitStatusEvent) GetActionId 

func (x *UnexpectedExitStatusEvent) GetActionId() int32

func (*UnexpectedExitStatusEvent) GetExitStatus 

func (x *UnexpectedExitStatusEvent) GetExitStatus() int32

func (*UnexpectedExitStatusEvent) ProtoMessage 

func (*UnexpectedExitStatusEvent) ProtoMessage()

func (*UnexpectedExitStatusEvent) ProtoReflect 

func (x *UnexpectedExitStatusEvent) ProtoReflect() protoreflect.Message

func (*UnexpectedExitStatusEvent) Reset 

func (x *UnexpectedExitStatusEvent) Reset()

func (*UnexpectedExitStatusEvent) String 

func (x *UnexpectedExitStatusEvent) String() string

type UnimplementedWorkflowsServiceV2BetaServer 

type UnimplementedWorkflowsServiceV2BetaServer struct {
}

UnimplementedWorkflowsServiceV2BetaServer can be embedded to have forward compatible implementations.

func (*UnimplementedWorkflowsServiceV2BetaServer) RunPipeline 

func (*UnimplementedWorkflowsServiceV2BetaServer) RunPipeline(context.Context, *RunPipelineRequest) (*longrunningpb.Operation, error)

type VirtualMachine 

type VirtualMachine struct {

	// Required. The machine type of the virtual machine to create. Must be the
	// short name of a standard machine type (such as "n1-standard-1") or a custom
	// machine type (such as "custom-1-4096", where "1" indicates the number of
	// vCPUs and "4096" indicates the memory in MB). See [Creating an instance
	// with a custom machine
	// type](https://cloud.google.com/compute/docs/instances/creating-instance-with-custom-machine-type#create)
	// for more specifications on creating a custom machine type.
	MachineType string `protobuf:"bytes,1,opt,name=machine_type,json=machineType,proto3" json:"machine_type,omitempty"`
	// If true, allocate a preemptible VM.
	Preemptible bool `protobuf:"varint,2,opt,name=preemptible,proto3" json:"preemptible,omitempty"`
	// Optional set of labels to apply to the VM and any attached disk resources.
	// These labels must adhere to the [name and value
	// restrictions](https://cloud.google.com/compute/docs/labeling-resources) on
	// VM labels imposed by Compute Engine.
	//
	// Labels keys with the prefix 'google-' are reserved for use by Google.
	//
	// Labels applied at creation time to the VM. Applied on a best-effort basis
	// to attached disk resources shortly after VM creation.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// The list of disks to create and attach to the VM.
	//
	// Specify either the `volumes[]` field or the `disks[]` field, but not both.
	Disks []*Disk `protobuf:"bytes,4,rep,name=disks,proto3" json:"disks,omitempty"`
	// The VM network configuration.
	Network *Network `protobuf:"bytes,5,opt,name=network,proto3" json:"network,omitempty"`
	// The list of accelerators to attach to the VM.
	Accelerators []*Accelerator `protobuf:"bytes,6,rep,name=accelerators,proto3" json:"accelerators,omitempty"`
	// The service account to install on the VM. This account does not need
	// any permissions other than those required by the pipeline.
	ServiceAccount *ServiceAccount `protobuf:"bytes,7,opt,name=service_account,json=serviceAccount,proto3" json:"service_account,omitempty"`
	// The size of the boot disk, in GB. The boot disk must be large
	// enough to accommodate all of the Docker images from each action in the
	// pipeline at the same time. If not specified, a small but reasonable
	// default value is used.
	BootDiskSizeGb int32 `protobuf:"varint,8,opt,name=boot_disk_size_gb,json=bootDiskSizeGb,proto3" json:"boot_disk_size_gb,omitempty"`
	// The CPU platform to request. An instance based on a newer platform can be
	// allocated, but never one with fewer capabilities. The value of this
	// parameter must be a valid Compute Engine CPU platform name (such as "Intel
	// Skylake"). This parameter is only useful for carefully optimized work
	// loads where the CPU platform has a significant impact.
	//
	// For more information about the effect of this parameter, see
	// https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.
	CpuPlatform string `protobuf:"bytes,9,opt,name=cpu_platform,json=cpuPlatform,proto3" json:"cpu_platform,omitempty"`
	// The host operating system image to use.
	//
	// Currently, only Container-Optimized OS images can be used.
	//
	// The default value is `projects/cos-cloud/global/images/family/cos-stable`,
	// which selects the latest stable release of Container-Optimized OS.
	//
	// This option is provided to allow testing against the beta release of the
	// operating system to ensure that the new version does not interact
	// negatively with production pipelines.
	//
	// To test a pipeline against the beta release of Container-Optimized OS,
	// use the value `projects/cos-cloud/global/images/family/cos-beta`.
	BootImage string `protobuf:"bytes,10,opt,name=boot_image,json=bootImage,proto3" json:"boot_image,omitempty"`
	// The NVIDIA driver version to use when attaching an NVIDIA GPU accelerator.
	// The version specified here must be compatible with the GPU libraries
	// contained in the container being executed, and must be one of the drivers
	// hosted in the `nvidia-drivers-us-public` bucket on Google Cloud Storage.
	//
	// Deprecated: Marked as deprecated in google/cloud/lifesciences/v2beta/workflows.proto.
	NvidiaDriverVersion string `protobuf:"bytes,11,opt,name=nvidia_driver_version,json=nvidiaDriverVersion,proto3" json:"nvidia_driver_version,omitempty"`
	// Whether Stackdriver monitoring should be enabled on the VM.
	EnableStackdriverMonitoring bool `` /* 146-byte string literal not displayed */
	// The Compute Engine Disk Images to use as a Docker cache. The disks will be
	// mounted into the Docker folder in a way that the images present in the
	// cache will not need to be pulled. The digests of the cached images must
	// match those of the tags used or the latest version will still be pulled.
	// The root directory of the ext4 image must contain `image` and `overlay2`
	// directories copied from the Docker directory of a VM where the desired
	// Docker images have already been pulled. Any images pulled that are not
	// cached will be stored on the first cache disk instead of the boot disk.
	// Only a single image is supported.
	DockerCacheImages []string `protobuf:"bytes,13,rep,name=docker_cache_images,json=dockerCacheImages,proto3" json:"docker_cache_images,omitempty"`
	// The list of disks and other storage to create or attach to the VM.
	//
	// Specify either the `volumes[]` field or the `disks[]` field, but not both.
	Volumes []*Volume `protobuf:"bytes,14,rep,name=volumes,proto3" json:"volumes,omitempty"`
	// If specified, the VM will only be allocated inside the matching
	// reservation. It will fail if the VM parameters don't match the reservation.
	Reservation string `protobuf:"bytes,15,opt,name=reservation,proto3" json:"reservation,omitempty"`
	// contains filtered or unexported fields
}

Carries information about a Compute Engine VM resource.

func (*VirtualMachine) Descriptor deprecated 

func (*VirtualMachine) Descriptor() ([]byte, []int)

Deprecated: Use VirtualMachine.ProtoReflect.Descriptor instead.

func (*VirtualMachine) GetAccelerators 

func (x *VirtualMachine) GetAccelerators() []*Accelerator

func (*VirtualMachine) GetBootDiskSizeGb 

func (x *VirtualMachine) GetBootDiskSizeGb() int32

func (*VirtualMachine) GetBootImage 

func (x *VirtualMachine) GetBootImage() string

func (*VirtualMachine) GetCpuPlatform 

func (x *VirtualMachine) GetCpuPlatform() string

func (*VirtualMachine) GetDisks 

func (x *VirtualMachine) GetDisks() []*Disk

func (*VirtualMachine) GetDockerCacheImages 

func (x *VirtualMachine) GetDockerCacheImages() []string

func (*VirtualMachine) GetEnableStackdriverMonitoring 

func (x *VirtualMachine) GetEnableStackdriverMonitoring() bool

func (*VirtualMachine) GetLabels 

func (x *VirtualMachine) GetLabels() map[string]string

func (*VirtualMachine) GetMachineType 

func (x *VirtualMachine) GetMachineType() string

func (*VirtualMachine) GetNetwork 

func (x *VirtualMachine) GetNetwork() *Network

func (*VirtualMachine) GetNvidiaDriverVersion deprecated 

func (x *VirtualMachine) GetNvidiaDriverVersion() string

Deprecated: Marked as deprecated in google/cloud/lifesciences/v2beta/workflows.proto.

func (*VirtualMachine) GetPreemptible 

func (x *VirtualMachine) GetPreemptible() bool

func (*VirtualMachine) GetReservation added in v0.7.0 

func (x *VirtualMachine) GetReservation() string

func (*VirtualMachine) GetServiceAccount 

func (x *VirtualMachine) GetServiceAccount() *ServiceAccount

func (*VirtualMachine) GetVolumes 

func (x *VirtualMachine) GetVolumes() []*Volume

func (*VirtualMachine) ProtoMessage 

func (*VirtualMachine) ProtoMessage()

func (*VirtualMachine) ProtoReflect 

func (x *VirtualMachine) ProtoReflect() protoreflect.Message

func (*VirtualMachine) Reset 

func (x *VirtualMachine) Reset()

func (*VirtualMachine) String 

func (x *VirtualMachine) String() string

type Volume 

type Volume struct {

	// A user-supplied name for the volume. Used when mounting the volume into
	// [`Actions`][google.cloud.lifesciences.v2beta.Action]. The name must contain
	// only upper and lowercase alphanumeric characters and hyphens and cannot
	// start with a hyphen.
	Volume string `protobuf:"bytes,1,opt,name=volume,proto3" json:"volume,omitempty"`
	// Types that are assignable to Storage:
	//
	//	*Volume_PersistentDisk
	//	*Volume_ExistingDisk
	//	*Volume_NfsMount
	Storage isVolume_Storage `protobuf_oneof:"storage"`
	// contains filtered or unexported fields
}

Carries information about storage that can be attached to a VM.

Specify either [`Volume`][google.cloud.lifesciences.v2beta.Volume] or [`Disk`][google.cloud.lifesciences.v2beta.Disk], but not both.

func (*Volume) Descriptor deprecated 

func (*Volume) Descriptor() ([]byte, []int)

Deprecated: Use Volume.ProtoReflect.Descriptor instead.

func (*Volume) GetExistingDisk 

func (x *Volume) GetExistingDisk() *ExistingDisk

func (*Volume) GetNfsMount 

func (x *Volume) GetNfsMount() *NFSMount

func (*Volume) GetPersistentDisk 

func (x *Volume) GetPersistentDisk() *PersistentDisk

func (*Volume) GetStorage 

func (m *Volume) GetStorage() isVolume_Storage

func (*Volume) GetVolume 

func (x *Volume) GetVolume() string

func (*Volume) ProtoMessage 

func (*Volume) ProtoMessage()

func (*Volume) ProtoReflect 

func (x *Volume) ProtoReflect() protoreflect.Message

func (*Volume) Reset 

func (x *Volume) Reset()

func (*Volume) String 

func (x *Volume) String() string

type Volume_ExistingDisk 

type Volume_ExistingDisk struct {
	// Configuration for a existing disk.
	ExistingDisk *ExistingDisk `protobuf:"bytes,3,opt,name=existing_disk,json=existingDisk,proto3,oneof"`
}

type Volume_NfsMount 

type Volume_NfsMount struct {
	// Configuration for an NFS mount.
	NfsMount *NFSMount `protobuf:"bytes,4,opt,name=nfs_mount,json=nfsMount,proto3,oneof"`
}

type Volume_PersistentDisk 

type Volume_PersistentDisk struct {
	// Configuration for a persistent disk.
	PersistentDisk *PersistentDisk `protobuf:"bytes,2,opt,name=persistent_disk,json=persistentDisk,proto3,oneof"`
}

type WorkerAssignedEvent 

type WorkerAssignedEvent struct {

	// The zone the worker is running in.
	Zone string `protobuf:"bytes,1,opt,name=zone,proto3" json:"zone,omitempty"`
	// The worker's instance name.
	Instance string `protobuf:"bytes,2,opt,name=instance,proto3" json:"instance,omitempty"`
	// The machine type that was assigned for the worker.
	MachineType string `protobuf:"bytes,3,opt,name=machine_type,json=machineType,proto3" json:"machine_type,omitempty"`
	// contains filtered or unexported fields
}

An event generated after a worker VM has been assigned to run the pipeline.

func (*WorkerAssignedEvent) Descriptor deprecated 

func (*WorkerAssignedEvent) Descriptor() ([]byte, []int)

Deprecated: Use WorkerAssignedEvent.ProtoReflect.Descriptor instead.

func (*WorkerAssignedEvent) GetInstance 

func (x *WorkerAssignedEvent) GetInstance() string

func (*WorkerAssignedEvent) GetMachineType 

func (x *WorkerAssignedEvent) GetMachineType() string

func (*WorkerAssignedEvent) GetZone 

func (x *WorkerAssignedEvent) GetZone() string

func (*WorkerAssignedEvent) ProtoMessage 

func (*WorkerAssignedEvent) ProtoMessage()

func (*WorkerAssignedEvent) ProtoReflect 

func (x *WorkerAssignedEvent) ProtoReflect() protoreflect.Message

func (*WorkerAssignedEvent) Reset 

func (x *WorkerAssignedEvent) Reset()

func (*WorkerAssignedEvent) String 

func (x *WorkerAssignedEvent) String() string

type WorkerReleasedEvent 

type WorkerReleasedEvent struct {

	// The zone the worker was running in.
	Zone string `protobuf:"bytes,1,opt,name=zone,proto3" json:"zone,omitempty"`
	// The worker's instance name.
	Instance string `protobuf:"bytes,2,opt,name=instance,proto3" json:"instance,omitempty"`
	// contains filtered or unexported fields
}

An event generated when the worker VM that was assigned to the pipeline has been released (deleted).

func (*WorkerReleasedEvent) Descriptor deprecated 

func (*WorkerReleasedEvent) Descriptor() ([]byte, []int)

Deprecated: Use WorkerReleasedEvent.ProtoReflect.Descriptor instead.

func (*WorkerReleasedEvent) GetInstance 

func (x *WorkerReleasedEvent) GetInstance() string

func (*WorkerReleasedEvent) GetZone 

func (x *WorkerReleasedEvent) GetZone() string

func (*WorkerReleasedEvent) ProtoMessage 

func (*WorkerReleasedEvent) ProtoMessage()

func (*WorkerReleasedEvent) ProtoReflect 

func (x *WorkerReleasedEvent) ProtoReflect() protoreflect.Message

func (*WorkerReleasedEvent) Reset 

func (x *WorkerReleasedEvent) Reset()

func (*WorkerReleasedEvent) String 

func (x *WorkerReleasedEvent) String() string

type WorkflowsServiceV2BetaClient 

type WorkflowsServiceV2BetaClient interface {
	// Runs a pipeline.  The returned Operation's [metadata]
	// [google.longrunning.Operation.metadata] field will contain a
	// [google.cloud.lifesciences.v2beta.Metadata][google.cloud.lifesciences.v2beta.Metadata]
	// object describing the status of the pipeline execution. The
	// [response][google.longrunning.Operation.response] field will contain a
	// [google.cloud.lifesciences.v2beta.RunPipelineResponse][google.cloud.lifesciences.v2beta.RunPipelineResponse]
	// object if the pipeline completes successfully.
	//
	// **Note:** Before you can use this method, the *Life Sciences Service Agent*
	// must have access to your project. This is done automatically when the
	// Cloud Life Sciences API is first enabled, but if you delete this permission
	// you must disable and re-enable the API to grant the Life Sciences
	// Service Agent the required permissions.
	// Authorization requires the following [Google
	// IAM](https://cloud.google.com/iam/) permission:
	//
	// * `lifesciences.workflows.run`
	RunPipeline(ctx context.Context, in *RunPipelineRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
}

WorkflowsServiceV2BetaClient is the client API for WorkflowsServiceV2Beta service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewWorkflowsServiceV2BetaClient 

func NewWorkflowsServiceV2BetaClient(cc grpc.ClientConnInterface) WorkflowsServiceV2BetaClient

type WorkflowsServiceV2BetaServer 

type WorkflowsServiceV2BetaServer interface {
	// Runs a pipeline.  The returned Operation's [metadata]
	// [google.longrunning.Operation.metadata] field will contain a
	// [google.cloud.lifesciences.v2beta.Metadata][google.cloud.lifesciences.v2beta.Metadata]
	// object describing the status of the pipeline execution. The
	// [response][google.longrunning.Operation.response] field will contain a
	// [google.cloud.lifesciences.v2beta.RunPipelineResponse][google.cloud.lifesciences.v2beta.RunPipelineResponse]
	// object if the pipeline completes successfully.
	//
	// **Note:** Before you can use this method, the *Life Sciences Service Agent*
	// must have access to your project. This is done automatically when the
	// Cloud Life Sciences API is first enabled, but if you delete this permission
	// you must disable and re-enable the API to grant the Life Sciences
	// Service Agent the required permissions.
	// Authorization requires the following [Google
	// IAM](https://cloud.google.com/iam/) permission:
	//
	// * `lifesciences.workflows.run`
	RunPipeline(context.Context, *RunPipelineRequest) (*longrunningpb.Operation, error)
}

WorkflowsServiceV2BetaServer is the server API for WorkflowsServiceV2Beta service.

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.