genproto: google.golang.org/genproto/googleapis/genomics/v1alpha2 Index | Files

package genomics

import "google.golang.org/genproto/googleapis/genomics/v1alpha2"

Index

Package Files

pipelines.pb.go

Variables

var (
    PipelineResources_Disk_Type_name = map[int32]string{
        0:  "TYPE_UNSPECIFIED",
        1:  "PERSISTENT_HDD",
        2:  "PERSISTENT_SSD",
        3:  "LOCAL_SSD",
    }
    PipelineResources_Disk_Type_value = map[string]int32{
        "TYPE_UNSPECIFIED": 0,
        "PERSISTENT_HDD":   1,
        "PERSISTENT_SSD":   2,
        "LOCAL_SSD":        3,
    }
)

Enum value maps for PipelineResources_Disk_Type.

var File_google_genomics_v1alpha2_pipelines_proto protoreflect.FileDescriptor

func RegisterPipelinesV1Alpha2Server Uses

func RegisterPipelinesV1Alpha2Server(s *grpc.Server, srv PipelinesV1Alpha2Server)

type ComputeEngine Uses

type ComputeEngine struct {

    // The instance on which the operation is running.
    InstanceName string `protobuf:"bytes,1,opt,name=instance_name,json=instanceName,proto3" json:"instance_name,omitempty"`
    // The availability zone in which the instance resides.
    Zone string `protobuf:"bytes,2,opt,name=zone,proto3" json:"zone,omitempty"`
    // The machine type of the instance.
    MachineType string `protobuf:"bytes,3,opt,name=machine_type,json=machineType,proto3" json:"machine_type,omitempty"`
    // The names of the disks that were created for this pipeline.
    DiskNames []string `protobuf:"bytes,4,rep,name=disk_names,json=diskNames,proto3" json:"disk_names,omitempty"`
    // contains filtered or unexported fields
}

Describes a Compute Engine resource that is being managed by a running [pipeline][google.genomics.v1alpha2.Pipeline].

func (*ComputeEngine) Descriptor Uses

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

Deprecated: Use ComputeEngine.ProtoReflect.Descriptor instead.

func (*ComputeEngine) GetDiskNames Uses

func (x *ComputeEngine) GetDiskNames() []string

func (*ComputeEngine) GetInstanceName Uses

func (x *ComputeEngine) GetInstanceName() string

func (*ComputeEngine) GetMachineType Uses

func (x *ComputeEngine) GetMachineType() string

func (*ComputeEngine) GetZone Uses

func (x *ComputeEngine) GetZone() string

func (*ComputeEngine) ProtoMessage Uses

func (*ComputeEngine) ProtoMessage()

func (*ComputeEngine) ProtoReflect Uses

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

func (*ComputeEngine) Reset Uses

func (x *ComputeEngine) Reset()

func (*ComputeEngine) String Uses

func (x *ComputeEngine) String() string

type ControllerConfig Uses

type ControllerConfig struct {
    Image       string                                      `protobuf:"bytes,1,opt,name=image,proto3" json:"image,omitempty"`
    Cmd         string                                      `protobuf:"bytes,2,opt,name=cmd,proto3" json:"cmd,omitempty"`
    GcsLogPath  string                                      `protobuf:"bytes,3,opt,name=gcs_log_path,json=gcsLogPath,proto3" json:"gcs_log_path,omitempty"`
    MachineType string                                      `protobuf:"bytes,4,opt,name=machine_type,json=machineType,proto3" json:"machine_type,omitempty"`
    Vars        map[string]string                           `protobuf:"bytes,5,rep,name=vars,proto3" json:"vars,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    Disks       map[string]string                           `protobuf:"bytes,6,rep,name=disks,proto3" json:"disks,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    GcsSources  map[string]*ControllerConfig_RepeatedString `protobuf:"bytes,7,rep,name=gcs_sources,json=gcsSources,proto3" json:"gcs_sources,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    GcsSinks    map[string]*ControllerConfig_RepeatedString `protobuf:"bytes,8,rep,name=gcs_sinks,json=gcsSinks,proto3" json:"gcs_sinks,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    // contains filtered or unexported fields
}

Stores the information that the controller will fetch from the server in order to run. Should only be used by VMs created by the Pipelines Service and not by end users.

func (*ControllerConfig) Descriptor Uses

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

Deprecated: Use ControllerConfig.ProtoReflect.Descriptor instead.

func (*ControllerConfig) GetCmd Uses

func (x *ControllerConfig) GetCmd() string

func (*ControllerConfig) GetDisks Uses

func (x *ControllerConfig) GetDisks() map[string]string

func (*ControllerConfig) GetGcsLogPath Uses

func (x *ControllerConfig) GetGcsLogPath() string

func (*ControllerConfig) GetGcsSinks Uses

func (x *ControllerConfig) GetGcsSinks() map[string]*ControllerConfig_RepeatedString

func (*ControllerConfig) GetGcsSources Uses

func (x *ControllerConfig) GetGcsSources() map[string]*ControllerConfig_RepeatedString

func (*ControllerConfig) GetImage Uses

func (x *ControllerConfig) GetImage() string

func (*ControllerConfig) GetMachineType Uses

func (x *ControllerConfig) GetMachineType() string

func (*ControllerConfig) GetVars Uses

func (x *ControllerConfig) GetVars() map[string]string

func (*ControllerConfig) ProtoMessage Uses

func (*ControllerConfig) ProtoMessage()

func (*ControllerConfig) ProtoReflect Uses

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

func (*ControllerConfig) Reset Uses

func (x *ControllerConfig) Reset()

func (*ControllerConfig) String Uses

func (x *ControllerConfig) String() string

type ControllerConfig_RepeatedString Uses

type ControllerConfig_RepeatedString struct {
    Values []string `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
    // contains filtered or unexported fields
}

func (*ControllerConfig_RepeatedString) Descriptor Uses

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

Deprecated: Use ControllerConfig_RepeatedString.ProtoReflect.Descriptor instead.

func (*ControllerConfig_RepeatedString) GetValues Uses

func (x *ControllerConfig_RepeatedString) GetValues() []string

func (*ControllerConfig_RepeatedString) ProtoMessage Uses

func (*ControllerConfig_RepeatedString) ProtoMessage()

func (*ControllerConfig_RepeatedString) ProtoReflect Uses

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

func (*ControllerConfig_RepeatedString) Reset Uses

func (x *ControllerConfig_RepeatedString) Reset()

func (*ControllerConfig_RepeatedString) String Uses

func (x *ControllerConfig_RepeatedString) String() string

type CreatePipelineRequest Uses

type CreatePipelineRequest struct {

    // The pipeline to create. Should not have `pipelineId` populated.
    Pipeline *Pipeline `protobuf:"bytes,1,opt,name=pipeline,proto3" json:"pipeline,omitempty"`
    // contains filtered or unexported fields
}

The request to create a pipeline. The pipeline field here should not have `pipelineId` populated, as that will be populated by the server.

func (*CreatePipelineRequest) Descriptor Uses

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

Deprecated: Use CreatePipelineRequest.ProtoReflect.Descriptor instead.

func (*CreatePipelineRequest) GetPipeline Uses

func (x *CreatePipelineRequest) GetPipeline() *Pipeline

func (*CreatePipelineRequest) ProtoMessage Uses

func (*CreatePipelineRequest) ProtoMessage()

func (*CreatePipelineRequest) ProtoReflect Uses

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

func (*CreatePipelineRequest) Reset Uses

func (x *CreatePipelineRequest) Reset()

func (*CreatePipelineRequest) String Uses

func (x *CreatePipelineRequest) String() string

type DeletePipelineRequest Uses

type DeletePipelineRequest struct {

    // Caller must have WRITE access to the project in which this pipeline
    // is defined.
    PipelineId string `protobuf:"bytes,1,opt,name=pipeline_id,json=pipelineId,proto3" json:"pipeline_id,omitempty"`
    // contains filtered or unexported fields
}

The request to delete a saved pipeline by ID.

func (*DeletePipelineRequest) Descriptor Uses

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

Deprecated: Use DeletePipelineRequest.ProtoReflect.Descriptor instead.

func (*DeletePipelineRequest) GetPipelineId Uses

func (x *DeletePipelineRequest) GetPipelineId() string

func (*DeletePipelineRequest) ProtoMessage Uses

func (*DeletePipelineRequest) ProtoMessage()

func (*DeletePipelineRequest) ProtoReflect Uses

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

func (*DeletePipelineRequest) Reset Uses

func (x *DeletePipelineRequest) Reset()

func (*DeletePipelineRequest) String Uses

func (x *DeletePipelineRequest) String() string

type DockerExecutor Uses

type DockerExecutor struct {

    // Required. Image name from either Docker Hub or Google Container Registry.
    // Users that run pipelines must have READ access to the image.
    ImageName string `protobuf:"bytes,1,opt,name=image_name,json=imageName,proto3" json:"image_name,omitempty"`
    // Required. The command or newline delimited script to run. The command
    // string will be executed within a bash shell.
    //
    // If the command exits with a non-zero exit code, output parameter
    // de-localization will be skipped and the pipeline operation's
    // [`error`][google.longrunning.Operation.error] field will be populated.
    //
    // Maximum command string length is 16384.
    Cmd string `protobuf:"bytes,2,opt,name=cmd,proto3" json:"cmd,omitempty"`
    // contains filtered or unexported fields
}

The Docker execuctor specification.

func (*DockerExecutor) Descriptor Uses

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

Deprecated: Use DockerExecutor.ProtoReflect.Descriptor instead.

func (*DockerExecutor) GetCmd Uses

func (x *DockerExecutor) GetCmd() string

func (*DockerExecutor) GetImageName Uses

func (x *DockerExecutor) GetImageName() string

func (*DockerExecutor) ProtoMessage Uses

func (*DockerExecutor) ProtoMessage()

func (*DockerExecutor) ProtoReflect Uses

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

func (*DockerExecutor) Reset Uses

func (x *DockerExecutor) Reset()

func (*DockerExecutor) String Uses

func (x *DockerExecutor) String() string

type GetControllerConfigRequest Uses

type GetControllerConfigRequest struct {

    // The operation to retrieve controller configuration for.
    OperationId     string `protobuf:"bytes,1,opt,name=operation_id,json=operationId,proto3" json:"operation_id,omitempty"`
    ValidationToken uint64 `protobuf:"varint,2,opt,name=validation_token,json=validationToken,proto3" json:"validation_token,omitempty"`
    // contains filtered or unexported fields
}

Request to get controller configuation. Should only be used by VMs created by the Pipelines Service and not by end users.

func (*GetControllerConfigRequest) Descriptor Uses

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

Deprecated: Use GetControllerConfigRequest.ProtoReflect.Descriptor instead.

func (*GetControllerConfigRequest) GetOperationId Uses

func (x *GetControllerConfigRequest) GetOperationId() string

func (*GetControllerConfigRequest) GetValidationToken Uses

func (x *GetControllerConfigRequest) GetValidationToken() uint64

func (*GetControllerConfigRequest) ProtoMessage Uses

func (*GetControllerConfigRequest) ProtoMessage()

func (*GetControllerConfigRequest) ProtoReflect Uses

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

func (*GetControllerConfigRequest) Reset Uses

func (x *GetControllerConfigRequest) Reset()

func (*GetControllerConfigRequest) String Uses

func (x *GetControllerConfigRequest) String() string

type GetPipelineRequest Uses

type GetPipelineRequest struct {

    // Caller must have READ access to the project in which this pipeline
    // is defined.
    PipelineId string `protobuf:"bytes,1,opt,name=pipeline_id,json=pipelineId,proto3" json:"pipeline_id,omitempty"`
    // contains filtered or unexported fields
}

A request to get a saved pipeline by id.

func (*GetPipelineRequest) Descriptor Uses

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

Deprecated: Use GetPipelineRequest.ProtoReflect.Descriptor instead.

func (*GetPipelineRequest) GetPipelineId Uses

func (x *GetPipelineRequest) GetPipelineId() string

func (*GetPipelineRequest) ProtoMessage Uses

func (*GetPipelineRequest) ProtoMessage()

func (*GetPipelineRequest) ProtoReflect Uses

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

func (*GetPipelineRequest) Reset Uses

func (x *GetPipelineRequest) Reset()

func (*GetPipelineRequest) String Uses

func (x *GetPipelineRequest) String() string

type ListPipelinesRequest Uses

type ListPipelinesRequest struct {

    // Required. The name of the project to search for pipelines. Caller
    // must have READ access to this project.
    ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
    // Pipelines with names that match this prefix should be
    // returned.  If unspecified, all pipelines in the project, up to
    // `pageSize`, will be returned.
    NamePrefix string `protobuf:"bytes,2,opt,name=name_prefix,json=namePrefix,proto3" json:"name_prefix,omitempty"`
    // Number of pipelines to return at once. Defaults to 256, and max
    // is 2048.
    PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
    // Token to use to indicate where to start getting results.
    // If unspecified, returns the first page of results.
    PageToken string `protobuf:"bytes,4,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
    // contains filtered or unexported fields
}

A request to list pipelines in a given project. Pipelines can be filtered by name using `namePrefix`: all pipelines with names that begin with `namePrefix` will be returned. Uses standard pagination: `pageSize` indicates how many pipelines to return, and `pageToken` comes from a previous ListPipelinesResponse to indicate offset.

func (*ListPipelinesRequest) Descriptor Uses

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

Deprecated: Use ListPipelinesRequest.ProtoReflect.Descriptor instead.

func (*ListPipelinesRequest) GetNamePrefix Uses

func (x *ListPipelinesRequest) GetNamePrefix() string

func (*ListPipelinesRequest) GetPageSize Uses

func (x *ListPipelinesRequest) GetPageSize() int32

func (*ListPipelinesRequest) GetPageToken Uses

func (x *ListPipelinesRequest) GetPageToken() string

func (*ListPipelinesRequest) GetProjectId Uses

func (x *ListPipelinesRequest) GetProjectId() string

func (*ListPipelinesRequest) ProtoMessage Uses

func (*ListPipelinesRequest) ProtoMessage()

func (*ListPipelinesRequest) ProtoReflect Uses

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

func (*ListPipelinesRequest) Reset Uses

func (x *ListPipelinesRequest) Reset()

func (*ListPipelinesRequest) String Uses

func (x *ListPipelinesRequest) String() string

type ListPipelinesResponse Uses

type ListPipelinesResponse struct {

    // The matched pipelines.
    Pipelines []*Pipeline `protobuf:"bytes,1,rep,name=pipelines,proto3" json:"pipelines,omitempty"`
    // The token to use to get the next page of results.
    NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
    // contains filtered or unexported fields
}

The response of ListPipelines. Contains at most `pageSize` pipelines. If it contains `pageSize` pipelines, and more pipelines exist, then `nextPageToken` will be populated and should be used as the `pageToken` argument to a subsequent ListPipelines request.

func (*ListPipelinesResponse) Descriptor Uses

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

Deprecated: Use ListPipelinesResponse.ProtoReflect.Descriptor instead.

func (*ListPipelinesResponse) GetNextPageToken Uses

func (x *ListPipelinesResponse) GetNextPageToken() string

func (*ListPipelinesResponse) GetPipelines Uses

func (x *ListPipelinesResponse) GetPipelines() []*Pipeline

func (*ListPipelinesResponse) ProtoMessage Uses

func (*ListPipelinesResponse) ProtoMessage()

func (*ListPipelinesResponse) ProtoReflect Uses

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

func (*ListPipelinesResponse) Reset Uses

func (x *ListPipelinesResponse) Reset()

func (*ListPipelinesResponse) String Uses

func (x *ListPipelinesResponse) String() string

type LoggingOptions Uses

type LoggingOptions struct {

    // The location in Google Cloud Storage to which the pipeline logs
    // will be copied. Can be specified as a fully qualified directory
    // path, in which case logs will be output with a unique identifier
    // as the filename in that directory, or as a fully specified path,
    // which must end in `.log`, in which case that path will be
    // used, and the user must ensure that logs are not
    // overwritten. Stdout and stderr logs from the run are also
    // generated and output as `-stdout.log` and `-stderr.log`.
    GcsPath string `protobuf:"bytes,1,opt,name=gcs_path,json=gcsPath,proto3" json:"gcs_path,omitempty"`
    // contains filtered or unexported fields
}

The logging options for the pipeline run.

func (*LoggingOptions) Descriptor Uses

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

Deprecated: Use LoggingOptions.ProtoReflect.Descriptor instead.

func (*LoggingOptions) GetGcsPath Uses

func (x *LoggingOptions) GetGcsPath() string

func (*LoggingOptions) ProtoMessage Uses

func (*LoggingOptions) ProtoMessage()

func (*LoggingOptions) ProtoReflect Uses

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

func (*LoggingOptions) Reset Uses

func (x *LoggingOptions) Reset()

func (*LoggingOptions) String Uses

func (x *LoggingOptions) String() string

type Pipeline Uses

type Pipeline struct {

    // Required. The project in which to create the pipeline. The caller must have
    // WRITE access.
    ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
    // Required. A user specified pipeline name that does not have to be unique.
    // This name can be used for filtering Pipelines in ListPipelines.
    Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
    // User-specified description.
    Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
    // Input parameters of the pipeline.
    InputParameters []*PipelineParameter `protobuf:"bytes,8,rep,name=input_parameters,json=inputParameters,proto3" json:"input_parameters,omitempty"`
    // Output parameters of the pipeline.
    OutputParameters []*PipelineParameter `protobuf:"bytes,9,rep,name=output_parameters,json=outputParameters,proto3" json:"output_parameters,omitempty"`
    // Required. The executor indicates in which environment the pipeline runs.
    //
    // Types that are assignable to Executor:
    //	*Pipeline_Docker
    Executor isPipeline_Executor `protobuf_oneof:"executor"`
    // Required. Specifies resource requirements for the pipeline run.
    // Required fields:
    //
    // *
    // [minimumCpuCores][google.genomics.v1alpha2.PipelineResources.minimum_cpu_cores]
    //
    // *
    // [minimumRamGb][google.genomics.v1alpha2.PipelineResources.minimum_ram_gb]
    Resources *PipelineResources `protobuf:"bytes,6,opt,name=resources,proto3" json:"resources,omitempty"`
    // Unique pipeline id that is generated by the service when CreatePipeline
    // is called. Cannot be specified in the Pipeline used in the
    // CreatePipelineRequest, and will be populated in the response to
    // CreatePipeline and all subsequent Get and List calls. Indicates that the
    // service has registered this pipeline.
    PipelineId string `protobuf:"bytes,7,opt,name=pipeline_id,json=pipelineId,proto3" json:"pipeline_id,omitempty"`
    // contains filtered or unexported fields
}

The pipeline object. Represents a transformation from a set of input parameters to a set of output parameters. The transformation is defined as a docker image and command to run within that image. Each pipeline is run on a Google Compute Engine VM. A pipeline can be created with the `create` method and then later run with the `run` method, or a pipeline can be defined and run all at once with the `run` method.

func (*Pipeline) Descriptor Uses

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

Deprecated: Use Pipeline.ProtoReflect.Descriptor instead.

func (*Pipeline) GetDescription Uses

func (x *Pipeline) GetDescription() string

func (*Pipeline) GetDocker Uses

func (x *Pipeline) GetDocker() *DockerExecutor

func (*Pipeline) GetExecutor Uses

func (m *Pipeline) GetExecutor() isPipeline_Executor

func (*Pipeline) GetInputParameters Uses

func (x *Pipeline) GetInputParameters() []*PipelineParameter

func (*Pipeline) GetName Uses

func (x *Pipeline) GetName() string

func (*Pipeline) GetOutputParameters Uses

func (x *Pipeline) GetOutputParameters() []*PipelineParameter

func (*Pipeline) GetPipelineId Uses

func (x *Pipeline) GetPipelineId() string

func (*Pipeline) GetProjectId Uses

func (x *Pipeline) GetProjectId() string

func (*Pipeline) GetResources Uses

func (x *Pipeline) GetResources() *PipelineResources

func (*Pipeline) ProtoMessage Uses

func (*Pipeline) ProtoMessage()

func (*Pipeline) ProtoReflect Uses

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

func (*Pipeline) Reset Uses

func (x *Pipeline) Reset()

func (*Pipeline) String Uses

func (x *Pipeline) String() string

type PipelineParameter Uses

type PipelineParameter struct {

    // Required. Name of the parameter - the pipeline runner uses this string
    // as the key to the input and output maps in RunPipeline.
    Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
    // Human-readable description.
    Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
    // The default value for this parameter. Can be overridden at runtime.
    // If `localCopy` is present, then this must be a Google Cloud Storage path
    // beginning with `gs://`.
    DefaultValue string `protobuf:"bytes,5,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"`
    // If present, this parameter is marked for copying to and from the VM.
    // `LocalCopy` indicates where on the VM the file should be. The value
    // given to this parameter (either at runtime or using `defaultValue`)
    // must be the remote path where the file should be.
    LocalCopy *PipelineParameter_LocalCopy `protobuf:"bytes,6,opt,name=local_copy,json=localCopy,proto3" json:"local_copy,omitempty"`
    // contains filtered or unexported fields
}

Parameters facilitate setting and delivering data into the pipeline's execution environment. They are defined at create time, with optional defaults, and can be overridden at run time.

If `localCopy` is unset, then the parameter specifies a string that is passed as-is into the pipeline, as the value of the environment variable with the given name. A default value can be optionally specified at create time. The default can be overridden at run time using the inputs map. If no default is given, a value must be supplied at runtime.

If `localCopy` is defined, then the parameter specifies a data source or sink, both in Google Cloud Storage and on the Docker container where the pipeline computation is run. The [service account associated with the Pipeline][google.genomics.v1alpha2.RunPipelineArgs.service_account] (by default the project's Compute Engine service account) must have access to the Google Cloud Storage paths.

At run time, the Google Cloud Storage paths can be overridden if a default was provided at create time, or must be set otherwise. The pipeline runner should add a key/value pair to either the inputs or outputs map. The indicated data copies will be carried out before/after pipeline execution, just as if the corresponding arguments were provided to `gsutil cp`.

For example: Given the following `PipelineParameter`, specified in the `inputParameters` list:

“` {name: "input_file", localCopy: {path: "file.txt", disk: "pd1"}} “`

where `disk` is defined in the `PipelineResources` object as:

“` {name: "pd1", mountPoint: "/mnt/disk/"} “`

We create a disk named `pd1`, mount it on the host VM, and map `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for `input_file` would be required in the inputs map, such as:

“`

inputs["input_file"] = "gs://my-bucket/bar.txt"

“`

This would generate the following gsutil call:

“`

gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt

“`

The file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the Docker container. Acceptable paths are:

<table>

<thead>
  <tr><th>Google Cloud storage path</th><th>Local path</th></tr>
</thead>
<tbody>
  <tr><td>file</td><td>file</td></tr>
  <tr><td>glob</td><td>directory</td></tr>
</tbody>

</table>

For outputs, the direction of the copy is reversed:

“`

gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt

“`

Acceptable paths are:

<table>

<thead>
  <tr><th>Local path</th><th>Google Cloud Storage path</th></tr>
</thead>
<tbody>
  <tr><td>file</td><td>file</td></tr>
  <tr>
    <td>file</td>
    <td>directory - directory must already exist</td>
  </tr>
  <tr>
    <td>glob</td>
    <td>directory - directory will be created if it doesn't exist</td></tr>
</tbody>

</table>

One restriction due to docker limitations, is that for outputs that are found on the boot disk, the local path cannot be a glob and must be a file.

func (*PipelineParameter) Descriptor Uses

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

Deprecated: Use PipelineParameter.ProtoReflect.Descriptor instead.

func (*PipelineParameter) GetDefaultValue Uses

func (x *PipelineParameter) GetDefaultValue() string

func (*PipelineParameter) GetDescription Uses

func (x *PipelineParameter) GetDescription() string

func (*PipelineParameter) GetLocalCopy Uses

func (x *PipelineParameter) GetLocalCopy() *PipelineParameter_LocalCopy

func (*PipelineParameter) GetName Uses

func (x *PipelineParameter) GetName() string

func (*PipelineParameter) ProtoMessage Uses

func (*PipelineParameter) ProtoMessage()

func (*PipelineParameter) ProtoReflect Uses

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

func (*PipelineParameter) Reset Uses

func (x *PipelineParameter) Reset()

func (*PipelineParameter) String Uses

func (x *PipelineParameter) String() string

type PipelineParameter_LocalCopy Uses

type PipelineParameter_LocalCopy struct {

    // Required. The path within the user's docker container where
    // this input should be localized to and from, relative to the specified
    // disk's mount point. For example: file.txt,
    Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
    // Required. The name of the disk where this parameter is
    // located. Can be the name of one of the disks specified in the
    // Resources field, or "boot", which represents the Docker
    // instance's boot disk and has a mount point of `/`.
    Disk string `protobuf:"bytes,2,opt,name=disk,proto3" json:"disk,omitempty"`
    // contains filtered or unexported fields
}

LocalCopy defines how a remote file should be copied to and from the VM.

func (*PipelineParameter_LocalCopy) Descriptor Uses

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

Deprecated: Use PipelineParameter_LocalCopy.ProtoReflect.Descriptor instead.

func (*PipelineParameter_LocalCopy) GetDisk Uses

func (x *PipelineParameter_LocalCopy) GetDisk() string

func (*PipelineParameter_LocalCopy) GetPath Uses

func (x *PipelineParameter_LocalCopy) GetPath() string

func (*PipelineParameter_LocalCopy) ProtoMessage Uses

func (*PipelineParameter_LocalCopy) ProtoMessage()

func (*PipelineParameter_LocalCopy) ProtoReflect Uses

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

func (*PipelineParameter_LocalCopy) Reset Uses

func (x *PipelineParameter_LocalCopy) Reset()

func (*PipelineParameter_LocalCopy) String Uses

func (x *PipelineParameter_LocalCopy) String() string

type PipelineResources Uses

type PipelineResources struct {

    // The minimum number of cores to use. Defaults to 1.
    MinimumCpuCores int32 `protobuf:"varint,1,opt,name=minimum_cpu_cores,json=minimumCpuCores,proto3" json:"minimum_cpu_cores,omitempty"`
    // Whether to use preemptible VMs. Defaults to `false`. In order to use this,
    // must be true for both create time and run time. Cannot be true at run time
    // if false at create time.
    Preemptible bool `protobuf:"varint,2,opt,name=preemptible,proto3" json:"preemptible,omitempty"`
    // The minimum amount of RAM to use. Defaults to 3.75 (GB)
    MinimumRamGb float64 `protobuf:"fixed64,3,opt,name=minimum_ram_gb,json=minimumRamGb,proto3" json:"minimum_ram_gb,omitempty"`
    // Disks to attach.
    Disks []*PipelineResources_Disk `protobuf:"bytes,4,rep,name=disks,proto3" json:"disks,omitempty"`
    // List of Google Compute Engine availability zones to which resource
    // creation will restricted. If empty, any zone may be chosen.
    Zones []string `protobuf:"bytes,5,rep,name=zones,proto3" json:"zones,omitempty"`
    // The size of the boot disk. Defaults to 10 (GB).
    BootDiskSizeGb int32 `protobuf:"varint,6,opt,name=boot_disk_size_gb,json=bootDiskSizeGb,proto3" json:"boot_disk_size_gb,omitempty"`
    // Whether to assign an external IP to the instance. This is an experimental
    // feature that may go away. Defaults to false.
    // Corresponds to `--no_address` flag for [gcloud compute instances create]
    // (https://cloud.google.com/sdk/gcloud/reference/compute/instances/create).
    // In order to use this, must be true for both create time and run time.
    // Cannot be true at run time if false at create time. If you need to ssh into
    // a private IP VM for debugging, you can ssh to a public VM and then ssh into
    // the private VM's Internal IP.  If noAddress is set, this pipeline run may
    // only load docker images from Google Container Registry and not Docker Hub.
    // ** Note: To use this option, your project must be in Google Access for
    // Private IPs Early Access Program.**
    NoAddress bool `protobuf:"varint,7,opt,name=no_address,json=noAddress,proto3" json:"no_address,omitempty"`
    // contains filtered or unexported fields
}

The system resources for the pipeline run.

func (*PipelineResources) Descriptor Uses

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

Deprecated: Use PipelineResources.ProtoReflect.Descriptor instead.

func (*PipelineResources) GetBootDiskSizeGb Uses

func (x *PipelineResources) GetBootDiskSizeGb() int32

func (*PipelineResources) GetDisks Uses

func (x *PipelineResources) GetDisks() []*PipelineResources_Disk

func (*PipelineResources) GetMinimumCpuCores Uses

func (x *PipelineResources) GetMinimumCpuCores() int32

func (*PipelineResources) GetMinimumRamGb Uses

func (x *PipelineResources) GetMinimumRamGb() float64

func (*PipelineResources) GetNoAddress Uses

func (x *PipelineResources) GetNoAddress() bool

func (*PipelineResources) GetPreemptible Uses

func (x *PipelineResources) GetPreemptible() bool

func (*PipelineResources) GetZones Uses

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

func (*PipelineResources) ProtoMessage Uses

func (*PipelineResources) ProtoMessage()

func (*PipelineResources) ProtoReflect Uses

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

func (*PipelineResources) Reset Uses

func (x *PipelineResources) Reset()

func (*PipelineResources) String Uses

func (x *PipelineResources) String() string

type PipelineResources_Disk Uses

type PipelineResources_Disk struct {

    // Required. The name of the disk that can be used in the pipeline
    // parameters. Must be 1 - 63 characters.
    // The name "boot" is reserved for system use.
    Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
    // Required. The type of the disk to create.
    Type PipelineResources_Disk_Type `protobuf:"varint,2,opt,name=type,proto3,enum=google.genomics.v1alpha2.PipelineResources_Disk_Type" json:"type,omitempty"`
    // The size of the disk. Defaults to 500 (GB).
    // This field is not applicable for local SSD.
    SizeGb int32 `protobuf:"varint,3,opt,name=size_gb,json=sizeGb,proto3" json:"size_gb,omitempty"`
    // The full or partial URL of the persistent disk to attach. See
    // https://cloud.google.com/compute/docs/reference/latest/instances#resource
    // and
    // https://cloud.google.com/compute/docs/disks/persistent-disks#snapshots
    // for more details.
    Source string `protobuf:"bytes,4,opt,name=source,proto3" json:"source,omitempty"`
    // Deprecated. Disks created by the Pipelines API will be deleted at the end
    // of the pipeline run, regardless of what this field is set to.
    AutoDelete bool `protobuf:"varint,6,opt,name=auto_delete,json=autoDelete,proto3" json:"auto_delete,omitempty"`
    // Required at create time and cannot be overridden at run time.
    // Specifies the path in the docker container where files on
    // this disk should be located. For example, if `mountPoint`
    // is `/mnt/disk`, and the parameter has `localPath`
    // `inputs/file.txt`, the docker container can access the data at
    // `/mnt/disk/inputs/file.txt`.
    MountPoint string `protobuf:"bytes,8,opt,name=mount_point,json=mountPoint,proto3" json:"mount_point,omitempty"`
    // contains filtered or unexported fields
}

A Google Compute Engine disk resource specification.

func (*PipelineResources_Disk) Descriptor Uses

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

Deprecated: Use PipelineResources_Disk.ProtoReflect.Descriptor instead.

func (*PipelineResources_Disk) GetAutoDelete Uses

func (x *PipelineResources_Disk) GetAutoDelete() bool

func (*PipelineResources_Disk) GetMountPoint Uses

func (x *PipelineResources_Disk) GetMountPoint() string

func (*PipelineResources_Disk) GetName Uses

func (x *PipelineResources_Disk) GetName() string

func (*PipelineResources_Disk) GetSizeGb Uses

func (x *PipelineResources_Disk) GetSizeGb() int32

func (*PipelineResources_Disk) GetSource Uses

func (x *PipelineResources_Disk) GetSource() string

func (*PipelineResources_Disk) GetType Uses

func (x *PipelineResources_Disk) GetType() PipelineResources_Disk_Type

func (*PipelineResources_Disk) ProtoMessage Uses

func (*PipelineResources_Disk) ProtoMessage()

func (*PipelineResources_Disk) ProtoReflect Uses

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

func (*PipelineResources_Disk) Reset Uses

func (x *PipelineResources_Disk) Reset()

func (*PipelineResources_Disk) String Uses

func (x *PipelineResources_Disk) String() string

type PipelineResources_Disk_Type Uses

type PipelineResources_Disk_Type int32

The types of disks that may be attached to VMs.

const (
    // Default disk type. Use one of the other options below.
    PipelineResources_Disk_TYPE_UNSPECIFIED PipelineResources_Disk_Type = 0
    // Specifies a Google Compute Engine persistent hard disk. See
    // https://cloud.google.com/compute/docs/disks/#pdspecs for details.
    PipelineResources_Disk_PERSISTENT_HDD PipelineResources_Disk_Type = 1
    // Specifies a Google Compute Engine persistent solid-state disk. See
    // https://cloud.google.com/compute/docs/disks/#pdspecs for details.
    PipelineResources_Disk_PERSISTENT_SSD PipelineResources_Disk_Type = 2
    // Specifies a Google Compute Engine local SSD.
    // See https://cloud.google.com/compute/docs/disks/local-ssd for details.
    PipelineResources_Disk_LOCAL_SSD PipelineResources_Disk_Type = 3
)

func (PipelineResources_Disk_Type) Descriptor Uses

func (PipelineResources_Disk_Type) Descriptor() protoreflect.EnumDescriptor

func (PipelineResources_Disk_Type) Enum Uses

func (x PipelineResources_Disk_Type) Enum() *PipelineResources_Disk_Type

func (PipelineResources_Disk_Type) EnumDescriptor Uses

func (PipelineResources_Disk_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use PipelineResources_Disk_Type.Descriptor instead.

func (PipelineResources_Disk_Type) Number Uses

func (x PipelineResources_Disk_Type) Number() protoreflect.EnumNumber

func (PipelineResources_Disk_Type) String Uses

func (x PipelineResources_Disk_Type) String() string

func (PipelineResources_Disk_Type) Type Uses

func (PipelineResources_Disk_Type) Type() protoreflect.EnumType

type Pipeline_Docker Uses

type Pipeline_Docker struct {
    // Specifies the docker run information.
    Docker *DockerExecutor `protobuf:"bytes,5,opt,name=docker,proto3,oneof"`
}

type PipelinesV1Alpha2Client Uses

type PipelinesV1Alpha2Client interface {
    // Creates a pipeline that can be run later. Create takes a Pipeline that
    // has all fields other than `pipelineId` populated, and then returns
    // the same pipeline with `pipelineId` populated. This id can be used
    // to run the pipeline.
    //
    // Caller must have WRITE permission to the project.
    CreatePipeline(ctx context.Context, in *CreatePipelineRequest, opts ...grpc.CallOption) (*Pipeline, error)
    // Runs a pipeline. If `pipelineId` is specified in the request, then
    // run a saved pipeline. If `ephemeralPipeline` is specified, then run
    // that pipeline once without saving a copy.
    //
    // The caller must have READ permission to the project where the pipeline
    // is stored and WRITE permission to the project where the pipeline will be
    // run, as VMs will be created and storage will be used.
    RunPipeline(ctx context.Context, in *RunPipelineRequest, opts ...grpc.CallOption) (*longrunning.Operation, error)
    // Retrieves a pipeline based on ID.
    //
    // Caller must have READ permission to the project.
    GetPipeline(ctx context.Context, in *GetPipelineRequest, opts ...grpc.CallOption) (*Pipeline, error)
    // Lists pipelines.
    //
    // Caller must have READ permission to the project.
    ListPipelines(ctx context.Context, in *ListPipelinesRequest, opts ...grpc.CallOption) (*ListPipelinesResponse, error)
    // Deletes a pipeline based on ID.
    //
    // Caller must have WRITE permission to the project.
    DeletePipeline(ctx context.Context, in *DeletePipelineRequest, opts ...grpc.CallOption) (*empty.Empty, error)
    // Gets controller configuration information. Should only be called
    // by VMs created by the Pipelines Service and not by end users.
    GetControllerConfig(ctx context.Context, in *GetControllerConfigRequest, opts ...grpc.CallOption) (*ControllerConfig, error)
    // Sets status of a given operation. Any new timestamps (as determined by
    // description) are appended to TimestampEvents. Should only be called by VMs
    // created by the Pipelines Service and not by end users.
    SetOperationStatus(ctx context.Context, in *SetOperationStatusRequest, opts ...grpc.CallOption) (*empty.Empty, error)
}

PipelinesV1Alpha2Client is the client API for PipelinesV1Alpha2 service.

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

func NewPipelinesV1Alpha2Client Uses

func NewPipelinesV1Alpha2Client(cc grpc.ClientConnInterface) PipelinesV1Alpha2Client

type PipelinesV1Alpha2Server Uses

type PipelinesV1Alpha2Server interface {
    // Creates a pipeline that can be run later. Create takes a Pipeline that
    // has all fields other than `pipelineId` populated, and then returns
    // the same pipeline with `pipelineId` populated. This id can be used
    // to run the pipeline.
    //
    // Caller must have WRITE permission to the project.
    CreatePipeline(context.Context, *CreatePipelineRequest) (*Pipeline, error)
    // Runs a pipeline. If `pipelineId` is specified in the request, then
    // run a saved pipeline. If `ephemeralPipeline` is specified, then run
    // that pipeline once without saving a copy.
    //
    // The caller must have READ permission to the project where the pipeline
    // is stored and WRITE permission to the project where the pipeline will be
    // run, as VMs will be created and storage will be used.
    RunPipeline(context.Context, *RunPipelineRequest) (*longrunning.Operation, error)
    // Retrieves a pipeline based on ID.
    //
    // Caller must have READ permission to the project.
    GetPipeline(context.Context, *GetPipelineRequest) (*Pipeline, error)
    // Lists pipelines.
    //
    // Caller must have READ permission to the project.
    ListPipelines(context.Context, *ListPipelinesRequest) (*ListPipelinesResponse, error)
    // Deletes a pipeline based on ID.
    //
    // Caller must have WRITE permission to the project.
    DeletePipeline(context.Context, *DeletePipelineRequest) (*empty.Empty, error)
    // Gets controller configuration information. Should only be called
    // by VMs created by the Pipelines Service and not by end users.
    GetControllerConfig(context.Context, *GetControllerConfigRequest) (*ControllerConfig, error)
    // Sets status of a given operation. Any new timestamps (as determined by
    // description) are appended to TimestampEvents. Should only be called by VMs
    // created by the Pipelines Service and not by end users.
    SetOperationStatus(context.Context, *SetOperationStatusRequest) (*empty.Empty, error)
}

PipelinesV1Alpha2Server is the server API for PipelinesV1Alpha2 service.

type RunPipelineArgs Uses

type RunPipelineArgs struct {

    // Required. The project in which to run the pipeline. The caller must have
    // WRITER access to all Google Cloud services and resources (e.g. Google
    // Compute Engine) will be used.
    ProjectId string `protobuf:"bytes,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
    // Pipeline input arguments; keys are defined in the pipeline documentation.
    // All input parameters that do not have default values  must be specified.
    // If parameters with defaults are specified here, the defaults will be
    // overridden.
    Inputs map[string]string `protobuf:"bytes,2,rep,name=inputs,proto3" json:"inputs,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    // Pipeline output arguments; keys are defined in the pipeline
    // documentation.  All output parameters of without default values
    // must be specified.  If parameters with defaults are specified
    // here, the defaults will be overridden.
    Outputs map[string]string `protobuf:"bytes,3,rep,name=outputs,proto3" json:"outputs,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    // The Google Cloud Service Account that will be used to access data and
    // services. By default, the compute service account associated with
    // `projectId` is used.
    ServiceAccount *ServiceAccount `protobuf:"bytes,4,opt,name=service_account,json=serviceAccount,proto3" json:"service_account,omitempty"`
    // This field is deprecated. Use `labels` instead. Client-specified pipeline
    // operation identifier.
    ClientId string `protobuf:"bytes,5,opt,name=client_id,json=clientId,proto3" json:"client_id,omitempty"`
    // Specifies resource requirements/overrides for the pipeline run.
    Resources *PipelineResources `protobuf:"bytes,6,opt,name=resources,proto3" json:"resources,omitempty"`
    // Required. Logging options. Used by the service to communicate results
    // to the user.
    Logging *LoggingOptions `protobuf:"bytes,7,opt,name=logging,proto3" json:"logging,omitempty"`
    // How long to keep the VM up after a failure (for example docker command
    // failed, copying input or output files failed, etc). While the VM is up, one
    // can ssh into the VM to debug. Default is 0; maximum allowed value is 1 day.
    KeepVmAliveOnFailureDuration *duration.Duration `protobuf:"bytes,8,opt,name=keep_vm_alive_on_failure_duration,json=keepVmAliveOnFailureDuration,proto3" json:"keep_vm_alive_on_failure_duration,omitempty"`
    // Labels to apply to this pipeline run. Labels will also be applied to
    // compute resources (VM, disks) created by this pipeline run. When listing
    // operations, operations can [filtered by labels]
    // [google.longrunning.ListOperationsRequest.filter].
    // Label keys may not be empty; label values may be empty. Non-empty labels
    // must be 1-63 characters long, and comply with [RFC1035]
    // (https://www.ietf.org/rfc/rfc1035.txt).
    // Specifically, the name must be 1-63 characters long and match the regular
    // expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
    // character must be a lowercase letter, and all following characters must be
    // a dash, lowercase letter, or digit, except the last character, which cannot
    // be a dash.
    Labels map[string]string `protobuf:"bytes,9,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    // contains filtered or unexported fields
}

The pipeline run arguments.

func (*RunPipelineArgs) Descriptor Uses

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

Deprecated: Use RunPipelineArgs.ProtoReflect.Descriptor instead.

func (*RunPipelineArgs) GetClientId Uses

func (x *RunPipelineArgs) GetClientId() string

func (*RunPipelineArgs) GetInputs Uses

func (x *RunPipelineArgs) GetInputs() map[string]string

func (*RunPipelineArgs) GetKeepVmAliveOnFailureDuration Uses

func (x *RunPipelineArgs) GetKeepVmAliveOnFailureDuration() *duration.Duration

func (*RunPipelineArgs) GetLabels Uses

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

func (*RunPipelineArgs) GetLogging Uses

func (x *RunPipelineArgs) GetLogging() *LoggingOptions

func (*RunPipelineArgs) GetOutputs Uses

func (x *RunPipelineArgs) GetOutputs() map[string]string

func (*RunPipelineArgs) GetProjectId Uses

func (x *RunPipelineArgs) GetProjectId() string

func (*RunPipelineArgs) GetResources Uses

func (x *RunPipelineArgs) GetResources() *PipelineResources

func (*RunPipelineArgs) GetServiceAccount Uses

func (x *RunPipelineArgs) GetServiceAccount() *ServiceAccount

func (*RunPipelineArgs) ProtoMessage Uses

func (*RunPipelineArgs) ProtoMessage()

func (*RunPipelineArgs) ProtoReflect Uses

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

func (*RunPipelineArgs) Reset Uses

func (x *RunPipelineArgs) Reset()

func (*RunPipelineArgs) String Uses

func (x *RunPipelineArgs) String() string

type RunPipelineRequest Uses

type RunPipelineRequest struct {

    // Types that are assignable to Pipeline:
    //	*RunPipelineRequest_PipelineId
    //	*RunPipelineRequest_EphemeralPipeline
    Pipeline isRunPipelineRequest_Pipeline `protobuf_oneof:"pipeline"`
    // The arguments to use when running this pipeline.
    PipelineArgs *RunPipelineArgs `protobuf:"bytes,3,opt,name=pipeline_args,json=pipelineArgs,proto3" json:"pipeline_args,omitempty"`
    // contains filtered or unexported fields
}

The request to run a pipeline. If `pipelineId` is specified, it refers to a saved pipeline created with CreatePipeline and set as the `pipelineId` of the returned Pipeline object. If `ephemeralPipeline` is specified, that pipeline is run once with the given args and not saved. It is an error to specify both `pipelineId` and `ephemeralPipeline`. `pipelineArgs` must be specified.

func (*RunPipelineRequest) Descriptor Uses

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

Deprecated: Use RunPipelineRequest.ProtoReflect.Descriptor instead.

func (*RunPipelineRequest) GetEphemeralPipeline Uses

func (x *RunPipelineRequest) GetEphemeralPipeline() *Pipeline

func (*RunPipelineRequest) GetPipeline Uses

func (m *RunPipelineRequest) GetPipeline() isRunPipelineRequest_Pipeline

func (*RunPipelineRequest) GetPipelineArgs Uses

func (x *RunPipelineRequest) GetPipelineArgs() *RunPipelineArgs

func (*RunPipelineRequest) GetPipelineId Uses

func (x *RunPipelineRequest) GetPipelineId() string

func (*RunPipelineRequest) ProtoMessage Uses

func (*RunPipelineRequest) ProtoMessage()

func (*RunPipelineRequest) ProtoReflect Uses

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

func (*RunPipelineRequest) Reset Uses

func (x *RunPipelineRequest) Reset()

func (*RunPipelineRequest) String Uses

func (x *RunPipelineRequest) String() string

type RunPipelineRequest_EphemeralPipeline Uses

type RunPipelineRequest_EphemeralPipeline struct {
    // A new pipeline object to run once and then delete.
    EphemeralPipeline *Pipeline `protobuf:"bytes,2,opt,name=ephemeral_pipeline,json=ephemeralPipeline,proto3,oneof"`
}

type RunPipelineRequest_PipelineId Uses

type RunPipelineRequest_PipelineId struct {
    // The already created pipeline to run.
    PipelineId string `protobuf:"bytes,1,opt,name=pipeline_id,json=pipelineId,proto3,oneof"`
}

type RuntimeMetadata Uses

type RuntimeMetadata struct {

    // Execution information specific to Google Compute Engine.
    ComputeEngine *ComputeEngine `protobuf:"bytes,1,opt,name=compute_engine,json=computeEngine,proto3" json:"compute_engine,omitempty"`
    // contains filtered or unexported fields
}

Runtime metadata that will be populated in the [runtimeMetadata][google.genomics.v1.OperationMetadata.runtime_metadata] field of the Operation associated with a RunPipeline execution.

func (*RuntimeMetadata) Descriptor Uses

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

Deprecated: Use RuntimeMetadata.ProtoReflect.Descriptor instead.

func (*RuntimeMetadata) GetComputeEngine Uses

func (x *RuntimeMetadata) GetComputeEngine() *ComputeEngine

func (*RuntimeMetadata) ProtoMessage Uses

func (*RuntimeMetadata) ProtoMessage()

func (*RuntimeMetadata) ProtoReflect Uses

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

func (*RuntimeMetadata) Reset Uses

func (x *RuntimeMetadata) Reset()

func (*RuntimeMetadata) String Uses

func (x *RuntimeMetadata) String() string

type ServiceAccount Uses

type ServiceAccount struct {

    // Email address of the service account. Defaults to `default`,
    // which uses the compute service account associated with the project.
    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.
    // The following scopes are automatically included:
    //
    // * https://www.googleapis.com/auth/compute
    // * https://www.googleapis.com/auth/devstorage.full_control
    // * https://www.googleapis.com/auth/genomics
    // * https://www.googleapis.com/auth/logging.write
    // * https://www.googleapis.com/auth/monitoring.write
    Scopes []string `protobuf:"bytes,2,rep,name=scopes,proto3" json:"scopes,omitempty"`
    // contains filtered or unexported fields
}

A Google Cloud Service Account.

func (*ServiceAccount) Descriptor Uses

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

Deprecated: Use ServiceAccount.ProtoReflect.Descriptor instead.

func (*ServiceAccount) GetEmail Uses

func (x *ServiceAccount) GetEmail() string

func (*ServiceAccount) GetScopes Uses

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

func (*ServiceAccount) ProtoMessage Uses

func (*ServiceAccount) ProtoMessage()

func (*ServiceAccount) ProtoReflect Uses

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

func (*ServiceAccount) Reset Uses

func (x *ServiceAccount) Reset()

func (*ServiceAccount) String Uses

func (x *ServiceAccount) String() string

type SetOperationStatusRequest Uses

type SetOperationStatusRequest struct {
    OperationId     string            `protobuf:"bytes,1,opt,name=operation_id,json=operationId,proto3" json:"operation_id,omitempty"`
    TimestampEvents []*TimestampEvent `protobuf:"bytes,2,rep,name=timestamp_events,json=timestampEvents,proto3" json:"timestamp_events,omitempty"`
    ErrorCode       code.Code         `protobuf:"varint,3,opt,name=error_code,json=errorCode,proto3,enum=google.rpc.Code" json:"error_code,omitempty"`
    ErrorMessage    string            `protobuf:"bytes,4,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
    ValidationToken uint64            `protobuf:"varint,5,opt,name=validation_token,json=validationToken,proto3" json:"validation_token,omitempty"`
    // contains filtered or unexported fields
}

Request to set operation status. Should only be used by VMs created by the Pipelines Service and not by end users.

func (*SetOperationStatusRequest) Descriptor Uses

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

Deprecated: Use SetOperationStatusRequest.ProtoReflect.Descriptor instead.

func (*SetOperationStatusRequest) GetErrorCode Uses

func (x *SetOperationStatusRequest) GetErrorCode() code.Code

func (*SetOperationStatusRequest) GetErrorMessage Uses

func (x *SetOperationStatusRequest) GetErrorMessage() string

func (*SetOperationStatusRequest) GetOperationId Uses

func (x *SetOperationStatusRequest) GetOperationId() string

func (*SetOperationStatusRequest) GetTimestampEvents Uses

func (x *SetOperationStatusRequest) GetTimestampEvents() []*TimestampEvent

func (*SetOperationStatusRequest) GetValidationToken Uses

func (x *SetOperationStatusRequest) GetValidationToken() uint64

func (*SetOperationStatusRequest) ProtoMessage Uses

func (*SetOperationStatusRequest) ProtoMessage()

func (*SetOperationStatusRequest) ProtoReflect Uses

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

func (*SetOperationStatusRequest) Reset Uses

func (x *SetOperationStatusRequest) Reset()

func (*SetOperationStatusRequest) String Uses

func (x *SetOperationStatusRequest) String() string

type TimestampEvent Uses

type TimestampEvent struct {

    // String indicating the type of event
    Description string `protobuf:"bytes,1,opt,name=description,proto3" json:"description,omitempty"`
    // The time this event occured.
    Timestamp *timestamp.Timestamp `protobuf:"bytes,2,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
    // contains filtered or unexported fields
}

Stores the list of events and times they occured for major events in job execution.

func (*TimestampEvent) Descriptor Uses

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

Deprecated: Use TimestampEvent.ProtoReflect.Descriptor instead.

func (*TimestampEvent) GetDescription Uses

func (x *TimestampEvent) GetDescription() string

func (*TimestampEvent) GetTimestamp Uses

func (x *TimestampEvent) GetTimestamp() *timestamp.Timestamp

func (*TimestampEvent) ProtoMessage Uses

func (*TimestampEvent) ProtoMessage()

func (*TimestampEvent) ProtoReflect Uses

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

func (*TimestampEvent) Reset Uses

func (x *TimestampEvent) Reset()

func (*TimestampEvent) String Uses

func (x *TimestampEvent) String() string

type UnimplementedPipelinesV1Alpha2Server Uses

type UnimplementedPipelinesV1Alpha2Server struct {
}

UnimplementedPipelinesV1Alpha2Server can be embedded to have forward compatible implementations.

func (*UnimplementedPipelinesV1Alpha2Server) CreatePipeline Uses

func (*UnimplementedPipelinesV1Alpha2Server) CreatePipeline(context.Context, *CreatePipelineRequest) (*Pipeline, error)

func (*UnimplementedPipelinesV1Alpha2Server) DeletePipeline Uses

func (*UnimplementedPipelinesV1Alpha2Server) DeletePipeline(context.Context, *DeletePipelineRequest) (*empty.Empty, error)

func (*UnimplementedPipelinesV1Alpha2Server) GetControllerConfig Uses

func (*UnimplementedPipelinesV1Alpha2Server) GetControllerConfig(context.Context, *GetControllerConfigRequest) (*ControllerConfig, error)

func (*UnimplementedPipelinesV1Alpha2Server) GetPipeline Uses

func (*UnimplementedPipelinesV1Alpha2Server) GetPipeline(context.Context, *GetPipelineRequest) (*Pipeline, error)

func (*UnimplementedPipelinesV1Alpha2Server) ListPipelines Uses

func (*UnimplementedPipelinesV1Alpha2Server) ListPipelines(context.Context, *ListPipelinesRequest) (*ListPipelinesResponse, error)

func (*UnimplementedPipelinesV1Alpha2Server) RunPipeline Uses

func (*UnimplementedPipelinesV1Alpha2Server) RunPipeline(context.Context, *RunPipelineRequest) (*longrunning.Operation, error)

func (*UnimplementedPipelinesV1Alpha2Server) SetOperationStatus Uses

func (*UnimplementedPipelinesV1Alpha2Server) SetOperationStatus(context.Context, *SetOperationStatusRequest) (*empty.Empty, error)

Package genomics imports 15 packages (graph). Updated 2020-08-13. Refresh now. Tools for package owners.