Documentation

Overview

Package genomics provides access to the Genomics API.

For product documentation, see: https://cloud.google.com/genomics

Creating a client

Usage example:

import "google.golang.org/api/genomics/v1"
...
ctx := context.Background()
genomicsService, err := genomics.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:

genomicsService, err := genomics.NewService(ctx, option.WithScopes(genomics.GenomicsScope))

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:

genomicsService, err := genomics.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
genomicsService, err := genomics.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

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

	// View and manage Genomics data
	GenomicsScope = "https://www.googleapis.com/auth/genomics"
)

    OAuth2 scopes used by this API.

    Variables

    This section is empty.

    Functions

    This section is empty.

    Types

    type CancelOperationRequest

    type CancelOperationRequest struct {
    }

      CancelOperationRequest: The request message for Operations.CancelOperation.

      type ComputeEngine

      type ComputeEngine struct {
      	// DiskNames: The names of the disks that were created for this
      	// pipeline.
      	DiskNames []string `json:"diskNames,omitempty"`
      
      	// InstanceName: The instance on which the operation is running.
      	InstanceName string `json:"instanceName,omitempty"`
      
      	// MachineType: The machine type of the instance.
      	MachineType string `json:"machineType,omitempty"`
      
      	// Zone: The availability zone in which the instance resides.
      	Zone string `json:"zone,omitempty"`
      
      	// ForceSendFields is a list of field names (e.g. "DiskNames") 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:"-"`
      
      	// NullFields is a list of field names (e.g. "DiskNames") to include in
      	// API requests with the JSON null value. By default, fields with empty
      	// values are omitted from API requests. However, any field with an
      	// empty value appearing in NullFields will be sent to the server as
      	// null. It is an error if a field in this list has a non-empty value.
      	// This may be used to include null fields in Patch requests.
      	NullFields []string `json:"-"`
      }

        ComputeEngine: Describes a Compute Engine resource that is being managed by a running pipeline.

        func (*ComputeEngine) MarshalJSON

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

        type ContainerKilledEvent

        type ContainerKilledEvent struct {
        	// ActionId: The numeric ID of the action that started the container.
        	ActionId int64 `json:"actionId,omitempty"`
        
        	// ForceSendFields is a list of field names (e.g. "ActionId") 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:"-"`
        
        	// NullFields is a list of field names (e.g. "ActionId") to include in
        	// API requests with the JSON null value. By default, fields with empty
        	// values are omitted from API requests. However, any field with an
        	// empty value appearing in NullFields will be sent to the server as
        	// null. It is an error if a field in this list has a non-empty value.
        	// This may be used to include null fields in Patch requests.
        	NullFields []string `json:"-"`
        }

          ContainerKilledEvent: 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) MarshalJSON

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

          type ContainerStartedEvent

          type ContainerStartedEvent struct {
          	// ActionId: The numeric ID of the action that started this container.
          	ActionId int64 `json:"actionId,omitempty"`
          
          	// IpAddress: 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 `json:"ipAddress,omitempty"`
          
          	// PortMappings: 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[string]int64 `json:"portMappings,omitempty"`
          
          	// ForceSendFields is a list of field names (e.g. "ActionId") 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:"-"`
          
          	// NullFields is a list of field names (e.g. "ActionId") to include in
          	// API requests with the JSON null value. By default, fields with empty
          	// values are omitted from API requests. However, any field with an
          	// empty value appearing in NullFields will be sent to the server as
          	// null. It is an error if a field in this list has a non-empty value.
          	// This may be used to include null fields in Patch requests.
          	NullFields []string `json:"-"`
          }

            ContainerStartedEvent: An event generated when a container starts.

            func (*ContainerStartedEvent) MarshalJSON

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

            type ContainerStoppedEvent

            type ContainerStoppedEvent struct {
            	// ActionId: The numeric ID of the action that started this container.
            	ActionId int64 `json:"actionId,omitempty"`
            
            	// ExitStatus: The exit status of the container.
            	ExitStatus int64 `json:"exitStatus,omitempty"`
            
            	// Stderr: 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 `json:"stderr,omitempty"`
            
            	// ForceSendFields is a list of field names (e.g. "ActionId") 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:"-"`
            
            	// NullFields is a list of field names (e.g. "ActionId") to include in
            	// API requests with the JSON null value. By default, fields with empty
            	// values are omitted from API requests. However, any field with an
            	// empty value appearing in NullFields will be sent to the server as
            	// null. It is an error if a field in this list has a non-empty value.
            	// This may be used to include null fields in Patch requests.
            	NullFields []string `json:"-"`
            }

              ContainerStoppedEvent: An event generated when a container exits.

              func (*ContainerStoppedEvent) MarshalJSON

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

              type DelayedEvent

              type DelayedEvent struct {
              	// Cause: 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 `json:"cause,omitempty"`
              
              	// Metrics: 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 `json:"metrics,omitempty"`
              
              	// ForceSendFields is a list of field names (e.g. "Cause") 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:"-"`
              
              	// NullFields is a list of field names (e.g. "Cause") to include in API
              	// requests with the JSON null value. By default, fields with empty
              	// values are omitted from API requests. However, any field with an
              	// empty value appearing in NullFields will be sent to the server as
              	// null. It is an error if a field in this list has a non-empty value.
              	// This may be used to include null fields in Patch requests.
              	NullFields []string `json:"-"`
              }

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

                func (*DelayedEvent) MarshalJSON

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

                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 Event

                  type Event struct {
                  	// Description: 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 `json:"description,omitempty"`
                  
                  	// Details: Machine-readable details about the event.
                  	Details googleapi.RawMessage `json:"details,omitempty"`
                  
                  	// Timestamp: The time at which the event occurred.
                  	Timestamp string `json:"timestamp,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:"-"`
                  
                  	// NullFields is a list of field names (e.g. "Description") to include
                  	// in API requests with the JSON null value. By default, fields with
                  	// empty values are omitted from API requests. However, any field with
                  	// an empty value appearing in NullFields will be sent to the server as
                  	// null. It is an error if a field in this list has a non-empty value.
                  	// This may be used to include null fields in Patch requests.
                  	NullFields []string `json:"-"`
                  }

                    Event: Carries information about events that occur during pipeline execution.

                    func (*Event) MarshalJSON

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

                    type FailedEvent

                    type FailedEvent struct {
                    	// Cause: The human-readable description of the cause of the failure.
                    	Cause string `json:"cause,omitempty"`
                    
                    	// Code: The Google standard error code that best describes this
                    	// failure.
                    	//
                    	// Possible values:
                    	//   "OK" - Not an error; returned on success HTTP Mapping: 200 OK
                    	//   "CANCELLED" - The operation was cancelled, typically by the caller.
                    	// HTTP Mapping: 499 Client Closed Request
                    	//   "UNKNOWN" - Unknown error. For example, this error may be returned
                    	// when a `Status` value received from another address space belongs to
                    	// an error space that is not known in this address space. Also errors
                    	// raised by APIs that do not return enough error information may be
                    	// converted to this error. HTTP Mapping: 500 Internal Server Error
                    	//   "INVALID_ARGUMENT" - The client specified an invalid argument. Note
                    	// that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT`
                    	// indicates arguments that are problematic regardless of the state of
                    	// the system (e.g., a malformed file name). HTTP Mapping: 400 Bad
                    	// Request
                    	//   "DEADLINE_EXCEEDED" - The deadline expired before the operation
                    	// could complete. For operations that change the state of the system,
                    	// this error may be returned even if the operation has completed
                    	// successfully. For example, a successful response from a server could
                    	// have been delayed long enough for the deadline to expire. HTTP
                    	// Mapping: 504 Gateway Timeout
                    	//   "NOT_FOUND" - Some requested entity (e.g., file or directory) was
                    	// not found. Note to server developers: if a request is denied for an
                    	// entire class of users, such as gradual feature rollout or
                    	// undocumented allowlist, `NOT_FOUND` may be used. If a request is
                    	// denied for some users within a class of users, such as user-based
                    	// access control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404
                    	// Not Found
                    	//   "ALREADY_EXISTS" - The entity that a client attempted to create
                    	// (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict
                    	//   "PERMISSION_DENIED" - The caller does not have permission to
                    	// execute the specified operation. `PERMISSION_DENIED` must not be used
                    	// for rejections caused by exhausting some resource (use
                    	// `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED`
                    	// must not be used if the caller can not be identified (use
                    	// `UNAUTHENTICATED` instead for those errors). This error code does not
                    	// imply the request is valid or the requested entity exists or
                    	// satisfies other pre-conditions. HTTP Mapping: 403 Forbidden
                    	//   "UNAUTHENTICATED" - The request does not have valid authentication
                    	// credentials for the operation. HTTP Mapping: 401 Unauthorized
                    	//   "RESOURCE_EXHAUSTED" - Some resource has been exhausted, perhaps a
                    	// per-user quota, or perhaps the entire file system is out of space.
                    	// HTTP Mapping: 429 Too Many Requests
                    	//   "FAILED_PRECONDITION" - The operation was rejected because the
                    	// system is not in a state required for the operation's execution. For
                    	// example, the directory to be deleted is non-empty, an rmdir operation
                    	// is applied to a non-directory, etc. Service implementors can use the
                    	// following guidelines to decide between `FAILED_PRECONDITION`,
                    	// `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can
                    	// retry just the failing call. (b) Use `ABORTED` if the client should
                    	// retry at a higher level (e.g., when a client-specified test-and-set
                    	// fails, indicating the client should restart a read-modify-write
                    	// sequence). (c) Use `FAILED_PRECONDITION` if the client should not
                    	// retry until the system state has been explicitly fixed. E.g., if an
                    	// "rmdir" fails because the directory is non-empty,
                    	// `FAILED_PRECONDITION` should be returned since the client should not
                    	// retry unless the files are deleted from the directory. HTTP Mapping:
                    	// 400 Bad Request
                    	//   "ABORTED" - The operation was aborted, typically due to a
                    	// concurrency issue such as a sequencer check failure or transaction
                    	// abort. See the guidelines above for deciding between
                    	// `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping:
                    	// 409 Conflict
                    	//   "OUT_OF_RANGE" - The operation was attempted past the valid range.
                    	// E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`,
                    	// this error indicates a problem that may be fixed if the system state
                    	// changes. For example, a 32-bit file system will generate
                    	// `INVALID_ARGUMENT` if asked to read at an offset that is not in the
                    	// range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to
                    	// read from an offset past the current file size. There is a fair bit
                    	// of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We
                    	// recommend using `OUT_OF_RANGE` (the more specific error) when it
                    	// applies so that callers who are iterating through a space can easily
                    	// look for an `OUT_OF_RANGE` error to detect when they are done. HTTP
                    	// Mapping: 400 Bad Request
                    	//   "UNIMPLEMENTED" - The operation is not implemented or is not
                    	// supported/enabled in this service. HTTP Mapping: 501 Not Implemented
                    	//   "INTERNAL" - Internal errors. This means that some invariants
                    	// expected by the underlying system have been broken. This error code
                    	// is reserved for serious errors. HTTP Mapping: 500 Internal Server
                    	// Error
                    	//   "UNAVAILABLE" - The service is currently unavailable. This is most
                    	// likely a transient condition, which can be corrected by retrying with
                    	// a backoff. Note that it is not always safe to retry non-idempotent
                    	// operations. See the guidelines above for deciding between
                    	// `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping:
                    	// 503 Service Unavailable
                    	//   "DATA_LOSS" - Unrecoverable data loss or corruption. HTTP Mapping:
                    	// 500 Internal Server Error
                    	Code string `json:"code,omitempty"`
                    
                    	// ForceSendFields is a list of field names (e.g. "Cause") 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:"-"`
                    
                    	// NullFields is a list of field names (e.g. "Cause") to include in API
                    	// requests with the JSON null value. By default, fields with empty
                    	// values are omitted from API requests. However, any field with an
                    	// empty value appearing in NullFields will be sent to the server as
                    	// null. It is an error if a field in this list has a non-empty value.
                    	// This may be used to include null fields in Patch requests.
                    	NullFields []string `json:"-"`
                    }

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

                      func (*FailedEvent) MarshalJSON

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

                      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:"-"`
                      
                      	// NullFields is a list of field names (e.g. "NextPageToken") to include
                      	// in API requests with the JSON null value. By default, fields with
                      	// empty values are omitted from API requests. However, any field with
                      	// an empty value appearing in NullFields will be sent to the server as
                      	// null. It is an error if a field in this list has a non-empty value.
                      	// This may be used to include null fields in Patch requests.
                      	NullFields []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: An OperationMetadata or Metadata object. This will always
                        	// be returned with the Operation.
                        	Metadata googleapi.RawMessage `json:"metadata,omitempty"`
                        
                        	// Name: The server-assigned name, which is only unique within the same
                        	// service that originally returns it. For example:
                        	// `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`
                        	Name string `json:"name,omitempty"`
                        
                        	// Response: An Empty object.
                        	Response googleapi.RawMessage `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:"-"`
                        
                        	// NullFields is a list of field names (e.g. "Done") to include in API
                        	// requests with the JSON null value. By default, fields with empty
                        	// values are omitted from API requests. However, any field with an
                        	// empty value appearing in NullFields will be sent to the server as
                        	// null. It is an error if a field in this list has a non-empty value.
                        	// This may be used to include null fields in Patch requests.
                        	NullFields []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: Required description of event.
                          	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:"-"`
                          
                          	// NullFields is a list of field names (e.g. "Description") to include
                          	// in API requests with the JSON null value. By default, fields with
                          	// empty values are omitted from API requests. However, any field with
                          	// an empty value appearing in NullFields will be sent to the server as
                          	// null. It is an error if a field in this list has a non-empty value.
                          	// This may be used to include null fields in Patch requests.
                          	NullFields []string `json:"-"`
                          }

                            OperationEvent: An event that occurred during an Operation.

                            func (*OperationEvent) MarshalJSON

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

                            type OperationMetadata

                            type OperationMetadata struct {
                            	// ClientId: This field is deprecated. Use `labels` instead. Optionally
                            	// provided by the caller when submitting the request that creates the
                            	// operation.
                            	ClientId string `json:"clientId,omitempty"`
                            
                            	// 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: Optionally provided by the caller when submitting the request
                            	// that creates the operation.
                            	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. Note that
                            	// this will be in current version of the API. If the operation was
                            	// started with v1beta2 API and a GetOperation is performed on v1 API, a
                            	// v1 request will be returned.
                            	Request googleapi.RawMessage `json:"request,omitempty"`
                            
                            	// RuntimeMetadata: Runtime metadata on this Operation.
                            	RuntimeMetadata googleapi.RawMessage `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. "ClientId") 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:"-"`
                            
                            	// NullFields is a list of field names (e.g. "ClientId") to include in
                            	// API requests with the JSON null value. By default, fields with empty
                            	// values are omitted from API requests. However, any field with an
                            	// empty value appearing in NullFields will be sent to the server as
                            	// null. It is an error if a field in this list has a non-empty value.
                            	// This may be used to include null fields in Patch requests.
                            	NullFields []string `json:"-"`
                            }

                              OperationMetadata: Metadata describing an Operation.

                              func (*OperationMetadata) MarshalJSON

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

                              type OperationsCancelCall

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

                              func (*OperationsCancelCall) Context

                                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 (*OperationsCancelCall) Do

                                  Do executes the "genomics.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 (*OperationsCancelCall) Fields

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

                                    func (*OperationsCancelCall) Header

                                    func (c *OperationsCancelCall) Header() http.Header

                                      Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

                                      type OperationsGetCall

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

                                      func (*OperationsGetCall) Context

                                        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 (*OperationsGetCall) Do

                                          Do executes the "genomics.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 (*OperationsGetCall) Fields

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

                                            func (*OperationsGetCall) Header

                                            func (c *OperationsGetCall) Header() http.Header

                                              Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

                                              func (*OperationsGetCall) IfNoneMatch

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

                                                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 OperationsListCall

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

                                                func (*OperationsListCall) Context

                                                  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 (*OperationsListCall) Do

                                                    Do executes the "genomics.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 (*OperationsListCall) Fields

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

                                                      func (*OperationsListCall) Filter

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

                                                        Filter sets the optional parameter "filter": A string for filtering Operations. In v2alpha1, the following filter fields are supported: * createTime: The time this job was created * events: The set of event (names) that have occurred while running the pipeline. The : operator can be used to determine if a particular event has occurred. * error: If the pipeline is running, this value is NULL. Once the pipeline finishes, the value is the standard Google error code. * labels.key or labels."key with space" where key is a label key. * done: If the pipeline is running, this value is false. Once the pipeline finishes, the value is true. In v1 and v1alpha2, the following filter fields are supported: * projectId: Required. Corresponds to OperationMetadata.projectId. * createTime: The time this job was created, in seconds from the [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only one status may be specified. * labels.key where key is a label key. Examples: * `projectId = my-project AND createTime >= 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project AND labels.color = *` * `projectId = my-project AND labels.color = red`

                                                        func (*OperationsListCall) Header

                                                        func (c *OperationsListCall) Header() http.Header

                                                          Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

                                                          func (*OperationsListCall) IfNoneMatch

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

                                                            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 (*OperationsListCall) PageSize

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

                                                              PageSize sets the optional parameter "pageSize": The maximum number of results to return. The maximum value is 256.

                                                              func (*OperationsListCall) PageToken

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

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

                                                                func (*OperationsListCall) Pages

                                                                  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 OperationsService

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

                                                                  func NewOperationsService

                                                                  func NewOperationsService(s *Service) *OperationsService

                                                                  func (*OperationsService) Cancel

                                                                  func (r *OperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *OperationsCancelCall

                                                                    Cancel: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.cancel`

                                                                    func (*OperationsService) Get

                                                                      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. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.get`

                                                                      func (*OperationsService) List

                                                                        List: Lists operations that match the specified filter in the request. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.list`

                                                                        type PullStartedEvent

                                                                        type PullStartedEvent struct {
                                                                        	// ImageUri: The URI of the image that was pulled.
                                                                        	ImageUri string `json:"imageUri,omitempty"`
                                                                        
                                                                        	// ForceSendFields is a list of field names (e.g. "ImageUri") 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:"-"`
                                                                        
                                                                        	// NullFields is a list of field names (e.g. "ImageUri") to include in
                                                                        	// API requests with the JSON null value. By default, fields with empty
                                                                        	// values are omitted from API requests. However, any field with an
                                                                        	// empty value appearing in NullFields will be sent to the server as
                                                                        	// null. It is an error if a field in this list has a non-empty value.
                                                                        	// This may be used to include null fields in Patch requests.
                                                                        	NullFields []string `json:"-"`
                                                                        }

                                                                          PullStartedEvent: An event generated when the worker starts pulling an image.

                                                                          func (*PullStartedEvent) MarshalJSON

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

                                                                          type PullStoppedEvent

                                                                          type PullStoppedEvent struct {
                                                                          	// ImageUri: The URI of the image that was pulled.
                                                                          	ImageUri string `json:"imageUri,omitempty"`
                                                                          
                                                                          	// ForceSendFields is a list of field names (e.g. "ImageUri") 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:"-"`
                                                                          
                                                                          	// NullFields is a list of field names (e.g. "ImageUri") to include in
                                                                          	// API requests with the JSON null value. By default, fields with empty
                                                                          	// values are omitted from API requests. However, any field with an
                                                                          	// empty value appearing in NullFields will be sent to the server as
                                                                          	// null. It is an error if a field in this list has a non-empty value.
                                                                          	// This may be used to include null fields in Patch requests.
                                                                          	NullFields []string `json:"-"`
                                                                          }

                                                                            PullStoppedEvent: An event generated when the worker stops pulling an image.

                                                                            func (*PullStoppedEvent) MarshalJSON

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

                                                                            type RunPipelineResponse

                                                                            type RunPipelineResponse struct {
                                                                            }

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

                                                                              type RuntimeMetadata

                                                                              type RuntimeMetadata struct {
                                                                              	// ComputeEngine: Execution information specific to Google Compute
                                                                              	// Engine.
                                                                              	ComputeEngine *ComputeEngine `json:"computeEngine,omitempty"`
                                                                              
                                                                              	// ForceSendFields is a list of field names (e.g. "ComputeEngine") 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:"-"`
                                                                              
                                                                              	// NullFields is a list of field names (e.g. "ComputeEngine") to include
                                                                              	// in API requests with the JSON null value. By default, fields with
                                                                              	// empty values are omitted from API requests. However, any field with
                                                                              	// an empty value appearing in NullFields will be sent to the server as
                                                                              	// null. It is an error if a field in this list has a non-empty value.
                                                                              	// This may be used to include null fields in Patch requests.
                                                                              	NullFields []string `json:"-"`
                                                                              }

                                                                                RuntimeMetadata: Runtime metadata that will be populated in the runtimeMetadata field of the Operation associated with a RunPipeline execution.

                                                                                func (*RuntimeMetadata) MarshalJSON

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

                                                                                type Service

                                                                                type Service struct {
                                                                                	BasePath  string // API endpoint base URL
                                                                                	UserAgent string // optional additional User-Agent fragment
                                                                                
                                                                                	Operations *OperationsService
                                                                                	// contains filtered or unexported fields
                                                                                }

                                                                                func New

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

                                                                                  New creates a new Service. It uses the provided http.Client for requests.

                                                                                  Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

                                                                                  func NewService

                                                                                  func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

                                                                                    NewService creates a new Service.

                                                                                    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 is a
                                                                                    	// common set of message types for APIs to use.
                                                                                    	Details []googleapi.RawMessage `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:"-"`
                                                                                    
                                                                                    	// NullFields is a list of field names (e.g. "Code") to include in API
                                                                                    	// requests with the JSON null value. By default, fields with empty
                                                                                    	// values are omitted from API requests. However, any field with an
                                                                                    	// empty value appearing in NullFields will be sent to the server as
                                                                                    	// null. It is an error if a field in this list has a non-empty value.
                                                                                    	// This may be used to include null fields in Patch requests.
                                                                                    	NullFields []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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).

                                                                                      func (*Status) MarshalJSON

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

                                                                                      type UnexpectedExitStatusEvent

                                                                                      type UnexpectedExitStatusEvent struct {
                                                                                      	// ActionId: The numeric ID of the action that started the container.
                                                                                      	ActionId int64 `json:"actionId,omitempty"`
                                                                                      
                                                                                      	// ExitStatus: The exit status of the container.
                                                                                      	ExitStatus int64 `json:"exitStatus,omitempty"`
                                                                                      
                                                                                      	// ForceSendFields is a list of field names (e.g. "ActionId") 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:"-"`
                                                                                      
                                                                                      	// NullFields is a list of field names (e.g. "ActionId") to include in
                                                                                      	// API requests with the JSON null value. By default, fields with empty
                                                                                      	// values are omitted from API requests. However, any field with an
                                                                                      	// empty value appearing in NullFields will be sent to the server as
                                                                                      	// null. It is an error if a field in this list has a non-empty value.
                                                                                      	// This may be used to include null fields in Patch requests.
                                                                                      	NullFields []string `json:"-"`
                                                                                      }

                                                                                        UnexpectedExitStatusEvent: 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) MarshalJSON

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

                                                                                        type WorkerAssignedEvent

                                                                                        type WorkerAssignedEvent struct {
                                                                                        	// Instance: The worker's instance name.
                                                                                        	Instance string `json:"instance,omitempty"`
                                                                                        
                                                                                        	// MachineType: The machine type that was assigned for the worker.
                                                                                        	MachineType string `json:"machineType,omitempty"`
                                                                                        
                                                                                        	// Zone: The zone the worker is running in.
                                                                                        	Zone string `json:"zone,omitempty"`
                                                                                        
                                                                                        	// ForceSendFields is a list of field names (e.g. "Instance") 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:"-"`
                                                                                        
                                                                                        	// NullFields is a list of field names (e.g. "Instance") to include in
                                                                                        	// API requests with the JSON null value. By default, fields with empty
                                                                                        	// values are omitted from API requests. However, any field with an
                                                                                        	// empty value appearing in NullFields will be sent to the server as
                                                                                        	// null. It is an error if a field in this list has a non-empty value.
                                                                                        	// This may be used to include null fields in Patch requests.
                                                                                        	NullFields []string `json:"-"`
                                                                                        }

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

                                                                                          func (*WorkerAssignedEvent) MarshalJSON

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

                                                                                          type WorkerReleasedEvent

                                                                                          type WorkerReleasedEvent struct {
                                                                                          	// Instance: The worker's instance name.
                                                                                          	Instance string `json:"instance,omitempty"`
                                                                                          
                                                                                          	// Zone: The zone the worker was running in.
                                                                                          	Zone string `json:"zone,omitempty"`
                                                                                          
                                                                                          	// ForceSendFields is a list of field names (e.g. "Instance") 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:"-"`
                                                                                          
                                                                                          	// NullFields is a list of field names (e.g. "Instance") to include in
                                                                                          	// API requests with the JSON null value. By default, fields with empty
                                                                                          	// values are omitted from API requests. However, any field with an
                                                                                          	// empty value appearing in NullFields will be sent to the server as
                                                                                          	// null. It is an error if a field in this list has a non-empty value.
                                                                                          	// This may be used to include null fields in Patch requests.
                                                                                          	NullFields []string `json:"-"`
                                                                                          }

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

                                                                                            func (*WorkerReleasedEvent) MarshalJSON

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

                                                                                            Source Files