bio

package
v0.0.0-...-9b87225 Latest Latest
Warning

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

 Go to latest Published: Feb 23, 2017 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Overview

Package bio provides access to the Bio API.

See https://cloud.google.com/genomics/

Usage example: 

import "github.com/skelterjohn/gcloud_apis/clients/bio/v1"
...
bioService, err := bio.New(oauthHttpClient)

Index

Constants

View Source 
const (
	// View and manage your data across Google Cloud Platform services
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type Empty 

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: 

service Foo {
  rpc Bar(google.protobuf.Empty) returns

(google.protobuf.Empty); 

}

The JSON representation for `Empty` is empty JSON object `{}`.

type ListOperationsResponse 

type ListOperationsResponse struct {
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Operations: A list of operations that matches the specified filter in
	// the request.
	Operations []*Operation `json:"operations,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

ListOperationsResponse: The response message for Operations.ListOperations.

func (*ListOperationsResponse) MarshalJSON 

func (s *ListOperationsResponse) MarshalJSON() ([]byte, error)

type Operation 

type Operation struct {
	// Done: If the value is `false`, it means the operation is still in
	// progress.
	// If true, the operation is completed, and either `error` or `response`
	// is
	// available.
	Done bool `json:"done,omitempty"`

	// Error: The error result of the operation in case of failure or
	// cancellation.
	Error *Status `json:"error,omitempty"`

	// Metadata: Service-specific metadata associated with the operation.
	// It typically
	// contains progress information and common metadata such as create
	// time.
	// Some services might not provide such metadata.  Any method that
	// returns a
	// long-running operation should document the metadata type, if any.
	Metadata OperationMetadata `json:"metadata,omitempty"`

	// Name: The server-assigned name, which is only unique within the same
	// service that
	// originally returns it. If you use the default HTTP mapping,
	// the
	// `name` should have the format of `operations/some/unique/name`.
	Name string `json:"name,omitempty"`

	// Response: The normal response of the operation in case of success.
	// If the original
	// method returns no data on success, such as `Delete`, the response
	// is
	// `google.protobuf.Empty`.  If the original method is
	// standard
	// `Get`/`Create`/`Update`, the response should be the resource.  For
	// other
	// methods, the response should have the type `XxxResponse`, where
	// `Xxx`
	// is the original method name.  For example, if the original method
	// name
	// is `TakeSnapshot()`, the inferred response type
	// is
	// `TakeSnapshotResponse`.
	Response OperationResponse `json:"response,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Done") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

Operation: This resource represents a long-running operation that is the result of a network API call.

func (*Operation) MarshalJSON 

func (s *Operation) MarshalJSON() ([]byte, error)

type OperationEvent 

type OperationEvent struct {
	// Description: A description of event in JSON-LD format.
	Description string `json:"description,omitempty"`

	// EndTime: Optional time of when event finished. An event can have a
	// start time and no
	// finish time. If an event has a finish time, there must be a start
	// time.
	EndTime string `json:"endTime,omitempty"`

	// StartTime: Optional time of when event started.
	StartTime string `json:"startTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

OperationEvent: An event that occurred during an Operation.

func (*OperationEvent) MarshalJSON 

func (s *OperationEvent) MarshalJSON() ([]byte, error)

type OperationMetadata 

type OperationMetadata interface{}

type OperationMetadata1 

type OperationMetadata1 struct {
	// CreateTime: The time at which the job was submitted to the Genomics
	// service.
	CreateTime string `json:"createTime,omitempty"`

	// EndTime: The time at which the job stopped running.
	EndTime string `json:"endTime,omitempty"`

	// Events: Optional event messages that were generated during the job's
	// execution.
	// This also contains any warnings that were generated during import
	// or export.
	Events []*OperationEvent `json:"events,omitempty"`

	// Labels: User-settable labels.
	Labels map[string]string `json:"labels,omitempty"`

	// ProjectId: The Google Cloud Project in which the job is scoped.
	ProjectId string `json:"projectId,omitempty"`

	// Request: The original request that started the operation.
	Request OperationMetadataRequest `json:"request,omitempty"`

	// RuntimeMetadata: Runtime metadata on this Operation.
	RuntimeMetadata OperationMetadataRuntimeMetadata `json:"runtimeMetadata,omitempty"`

	// StartTime: The time at which the job began to run.
	StartTime string `json:"startTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CreateTime") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

OperationMetadata1: Metadata describing an Operation.

func (*OperationMetadata1) MarshalJSON 

func (s *OperationMetadata1) MarshalJSON() ([]byte, error)

type OperationMetadataRequest 

type OperationMetadataRequest interface{}

type OperationMetadataRuntimeMetadata 

type OperationMetadataRuntimeMetadata interface{}

type OperationResponse 

type OperationResponse interface{}

type PipelineOptions 

type PipelineOptions struct {
	// ComputeZones: Google Compute Engine availability zones in which the
	// workflow should start
	// worker virtual machines, if any are needed for this particular
	// workflow.
	// Must be valid Google Compute Engine zone names, for example
	// "us-east1-d".
	ComputeZones []string `json:"computeZones,omitempty"`

	// Labels: User-settable labels. Applied to the Operation and any
	// associated pipeline
	// resources, e.g. GCE VMs (if any).
	Labels map[string]string `json:"labels,omitempty"`

	// RequestId: Optional. If non-empty then requests are idempotent in
	// that
	// sending a second RunWorkflowRequest with the same project_id and
	// request_id
	// will return the name of the same already-running operation, instead
	// of
	// starting another.
	// Do not reuse request_ids. Reusing a (project_id, request_id) for
	// a
	// different request will result in an error.
	// A common way of filling this value is with a random 64-bit number.
	RequestId string `json:"requestId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ComputeZones") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

PipelineOptions: Common pipeline options.

func (*PipelineOptions) MarshalJSON 

func (s *PipelineOptions) MarshalJSON() ([]byte, error)

type ProjectsOperationsCancelCall 

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

func (*ProjectsOperationsCancelCall) Context 

func (c *ProjectsOperationsCancelCall) Context(ctx context.Context) *ProjectsOperationsCancelCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsOperationsCancelCall) Do 

func (c *ProjectsOperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "bio.projects.operations.cancel" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsOperationsCancelCall) Fields 

func (c *ProjectsOperationsCancelCall) Fields(s ...googleapi.Field) *ProjectsOperationsCancelCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type ProjectsOperationsGetCall 

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

func (*ProjectsOperationsGetCall) Context 

func (c *ProjectsOperationsGetCall) Context(ctx context.Context) *ProjectsOperationsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsOperationsGetCall) Do 

func (c *ProjectsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "bio.projects.operations.get" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsOperationsGetCall) Fields 

func (c *ProjectsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsOperationsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsOperationsGetCall) IfNoneMatch 

func (c *ProjectsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsOperationsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsOperationsListCall 

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

func (*ProjectsOperationsListCall) Context 

func (c *ProjectsOperationsListCall) Context(ctx context.Context) *ProjectsOperationsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsOperationsListCall) Do 

func (c *ProjectsOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)

Do executes the "bio.projects.operations.list" call. Exactly one of *ListOperationsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsOperationsListCall) Fields 

func (c *ProjectsOperationsListCall) Fields(s ...googleapi.Field) *ProjectsOperationsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsOperationsListCall) Filter 

func (c *ProjectsOperationsListCall) Filter(filter string) *ProjectsOperationsListCall

Filter sets the optional parameter "filter": The standard list filter.

func (*ProjectsOperationsListCall) IfNoneMatch 

func (c *ProjectsOperationsListCall) IfNoneMatch(entityTag string) *ProjectsOperationsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsOperationsListCall) PageSize 

func (c *ProjectsOperationsListCall) PageSize(pageSize int64) *ProjectsOperationsListCall

PageSize sets the optional parameter "pageSize": The standard list page size.

func (*ProjectsOperationsListCall) PageToken 

func (c *ProjectsOperationsListCall) PageToken(pageToken string) *ProjectsOperationsListCall

PageToken sets the optional parameter "pageToken": The standard list page token.

func (*ProjectsOperationsListCall) Pages 

func (c *ProjectsOperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsOperationsService 

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

func NewProjectsOperationsService 

func NewProjectsOperationsService(s *Service) *ProjectsOperationsService

func (*ProjectsOperationsService) Cancel 

func (r *ProjectsOperationsService) Cancel(name string) *ProjectsOperationsCancelCall

Cancel: Starts asynchronous cancellation on a long-running operation. 

The server

makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

func (*ProjectsOperationsService) Get 

func (r *ProjectsOperationsService) Get(name string) *ProjectsOperationsGetCall

Get: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

func (*ProjectsOperationsService) List 

func (r *ProjectsOperationsService) List(name string) *ProjectsOperationsListCall

List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.

NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.

type ProjectsPipelinesRunDeepVariantV1alphaCall 

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

func (*ProjectsPipelinesRunDeepVariantV1alphaCall) Context 

func (c *ProjectsPipelinesRunDeepVariantV1alphaCall) Context(ctx context.Context) *ProjectsPipelinesRunDeepVariantV1alphaCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsPipelinesRunDeepVariantV1alphaCall) Do 

func (c *ProjectsPipelinesRunDeepVariantV1alphaCall) Do(opts ...googleapi.CallOption) (*Operation, error)

Do executes the "bio.projects.pipelines.runDeepVariantV1alpha" call. Exactly one of *Operation or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsPipelinesRunDeepVariantV1alphaCall) Fields 

func (c *ProjectsPipelinesRunDeepVariantV1alphaCall) Fields(s ...googleapi.Field) *ProjectsPipelinesRunDeepVariantV1alphaCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type ProjectsPipelinesService 

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

func NewProjectsPipelinesService 

func NewProjectsPipelinesService(s *Service) *ProjectsPipelinesService

func (*ProjectsPipelinesService) RunDeepVariantV1alpha 

func (r *ProjectsPipelinesService) RunDeepVariantV1alpha(projectId string, rundeepvariantv1alpharequest *RunDeepVariantV1alphaRequest) *ProjectsPipelinesRunDeepVariantV1alphaCall

RunDeepVariantV1alpha: Run a DeepVariant pipeline.

type ProjectsService 

type ProjectsService struct {
	Operations *ProjectsOperationsService

	Pipelines *ProjectsPipelinesService
	// contains filtered or unexported fields
}

func NewProjectsService 

func NewProjectsService(s *Service) *ProjectsService

type RunDeepVariantV1alphaRequest 

type RunDeepVariantV1alphaRequest struct {
	// InputFastq1: List of Google Cloud Storage paths of forward strand
	// FASTQ.
	// The pairs of FASTQ files must occur at the same position in both
	// lists.
	// e.g.:
	//
	//   input_fastq1s = ['lane1_1.fastq', 'lane2_1.fastq',
	// 'lane3_1.fastq']
	//   input_fastq2s = ['lane1_2.fastq', 'lane2_2.fastq', 'lane3_2.fastq']
	InputFastq1 []string `json:"inputFastq1,omitempty"`

	// InputFastq2: List of Google Cloud Storage paths of reverse strand
	// FASTQ.
	// The pairs of FASTQ files must occur at the same position in both
	// lists.
	// e.g.:
	//
	//   input_fastq1s = ['lane1_1.fastq', 'lane2_1.fastq',
	// 'lane3_1.fastq']
	//   input_fastq2s = ['lane1_2.fastq', 'lane2_2.fastq', 'lane3_2.fastq']
	InputFastq2 []string `json:"inputFastq2,omitempty"`

	// Options: Common pipeline options.
	Options *PipelineOptions `json:"options,omitempty"`

	// OutputPath: Required. The Google Cloud Storage path for copying the
	// final output files.
	// For example, 'gs://<user_bucket>/<sample_name>/'.
	OutputPath string `json:"outputPath,omitempty"`

	// SampleName: Required. Sample name.
	SampleName string `json:"sampleName,omitempty"`

	// ForceSendFields is a list of field names (e.g. "InputFastq1") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

func (*RunDeepVariantV1alphaRequest) MarshalJSON 

func (s *RunDeepVariantV1alphaRequest) MarshalJSON() ([]byte, error)

type RuntimeMetadata 

type RuntimeMetadata struct {
}

RuntimeMetadata: Runtime metadata that will be populated in the runtime_metadata field of an Operation associated with a RunWorkflow execution.

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New 

func New(client *http.Client) (*Service, error)

type Status 

type Status struct {
	// Code: The status code, which should be an enum value of
	// google.rpc.Code.
	Code int64 `json:"code,omitempty"`

	// Details: A list of messages that carry the error details.  There will
	// be a
	// common set of message types for APIs to use.
	Details []StatusDetails `json:"details,omitempty"`

	// Message: A developer-facing error message, which should be in
	// English. Any
	// user-facing error message should be localized and sent in
	// the
	// google.rpc.Status.details field, or localized by the client.
	Message string `json:"message,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Code") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`
}

Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be:

- Simple to use and understand for most users - Flexible enough to meet unexpected needs

Overview

The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions.

Language mapping

The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.

Other uses

The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.

Example uses of this error model include:

- Partial errors. If a service needs to return partial errors to the client, 

it may embed the `Status` in the normal response to indicate the

partial 

errors.

- Workflow errors. A typical workflow has multiple steps. Each step may 

have a `Status` message for error reporting purpose.

- Batch operations. If a client uses batch request and batch response, the 

`Status` message should be used directly inside batch response,

one for 

each error sub-response.

- Asynchronous operations. If an API call embeds asynchronous operation 

results in its response, the status of those operations should

be 

represented directly using the `Status` message.

- Logging. If some API errors are stored in logs, the message `Status` could 

be used directly after any stripping needed for security/privacy

reasons.

func (*Status) MarshalJSON 

func (s *Status) MarshalJSON() ([]byte, error)

type StatusDetails 

type StatusDetails interface{}

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.