com.google.api.services.genomics.v2alpha1.model

Class Pipeline

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.genomics.v2alpha1.model.Pipeline

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Pipeline
extends GenericJson

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

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Genomics API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Pipeline()

Method Summary

Modifier and Type	Method and Description
Pipeline	clone()
List<Action>	getActions() The list of actions to execute, in the order they are specified.
Map<String,String>	getEnvironment() The environment to pass into every action.
Resources	getResources() The resources required for execution.
String	getTimeout() The maximum amount of time to give the pipeline to complete.
Pipeline	set(String fieldName, Object value)
Pipeline	setActions(List<Action> actions) The list of actions to execute, in the order they are specified.
Pipeline	setEnvironment(Map<String,String> environment) The environment to pass into every action.
Pipeline	setResources(Resources resources) The resources required for execution.
Pipeline	setTimeout(String timeout) The maximum amount of time to give the pipeline to complete.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Pipeline

public Pipeline()

Method Detail

getActions

public List<Action> getActions()

The list of actions to execute, in the order they are specified.

Returns:

value or null for none

setActions

public Pipeline setActions(List<Action> actions)

The list of actions to execute, in the order they are specified.

Parameters:

actions - actions or null for none

getEnvironment

public Map<String,String> getEnvironment()

The environment to pass into every action. Each action can also specify additional environment variables but cannot delete an entry from this map (though they can overwrite it with a different value).

Returns:

value or null for none

setEnvironment

public Pipeline setEnvironment(Map<String,String> environment)

The environment to pass into every action. Each action can also specify additional environment variables but cannot delete an entry from this map (though they can overwrite it with a different value).

Parameters:

environment - environment or null for none

getResources

public Resources getResources()

The resources required for execution.

Returns:

value or null for none

setResources

public Pipeline setResources(Resources resources)

The resources required for execution.

Parameters:

resources - resources or null for none

getTimeout

public String getTimeout()

The maximum amount of time to give the pipeline to complete. This includes the time spent waiting for a worker to be allocated. If the pipeline fails to complete before the timeout, it will be cancelled and the error code will be set to DEADLINE_EXCEEDED. If unspecified, it will default to 7 days.

Returns:

value or null for none

setTimeout

public Pipeline setTimeout(String timeout)

The maximum amount of time to give the pipeline to complete. This includes the time spent waiting for a worker to be allocated. If the pipeline fails to complete before the timeout, it will be cancelled and the error code will be set to DEADLINE_EXCEEDED. If unspecified, it will default to 7 days.

Parameters:

timeout - timeout or null for none

set

public Pipeline set(String fieldName,
                    Object value)

Overrides:

set in class GenericJson

clone

public Pipeline clone()

Overrides:

clone in class GenericJson