Class Pipeline (0.45.0)

public final class Pipeline extends GeneratedMessageV3 implements PipelineOrBuilder

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

Protobuf type google.cloud.lifesciences.v2beta.Pipeline

Implements

PipelineOrBuilder

Static Fields

ACTIONS_FIELD_NUMBER

public static final int ACTIONS_FIELD_NUMBER
Field Value
Type Description
int

ENCRYPTED_ENVIRONMENT_FIELD_NUMBER

public static final int ENCRYPTED_ENVIRONMENT_FIELD_NUMBER
Field Value
Type Description
int

ENVIRONMENT_FIELD_NUMBER

public static final int ENVIRONMENT_FIELD_NUMBER
Field Value
Type Description
int

RESOURCES_FIELD_NUMBER

public static final int RESOURCES_FIELD_NUMBER
Field Value
Type Description
int

TIMEOUT_FIELD_NUMBER

public static final int TIMEOUT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Pipeline getDefaultInstance()
Returns
Type Description
Pipeline

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Pipeline.Builder newBuilder()
Returns
Type Description
Pipeline.Builder

newBuilder(Pipeline prototype)

public static Pipeline.Builder newBuilder(Pipeline prototype)
Parameter
Name Description
prototype Pipeline
Returns
Type Description
Pipeline.Builder

parseDelimitedFrom(InputStream input)

public static Pipeline parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Pipeline
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Pipeline parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Pipeline parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Pipeline
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Pipeline parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Pipeline parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Pipeline
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Pipeline parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Pipeline parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Pipeline
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Pipeline parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Pipeline parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Pipeline
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Pipeline parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Pipeline parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Pipeline
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Pipeline parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Pipeline> parser()
Returns
Type Description
Parser<Pipeline>

Methods

containsEnvironment(String key)

public boolean containsEnvironment(String key)

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).

map<string, string> environment = 3;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getActions(int index)

public Action getActions(int index)

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

repeated .google.cloud.lifesciences.v2beta.Action actions = 1;

Parameter
Name Description
index int
Returns
Type Description
Action

getActionsCount()

public int getActionsCount()

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

repeated .google.cloud.lifesciences.v2beta.Action actions = 1;

Returns
Type Description
int

getActionsList()

public List<Action> getActionsList()

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

repeated .google.cloud.lifesciences.v2beta.Action actions = 1;

Returns
Type Description
List<Action>

getActionsOrBuilder(int index)

public ActionOrBuilder getActionsOrBuilder(int index)

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

repeated .google.cloud.lifesciences.v2beta.Action actions = 1;

Parameter
Name Description
index int
Returns
Type Description
ActionOrBuilder

getActionsOrBuilderList()

public List<? extends ActionOrBuilder> getActionsOrBuilderList()

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

repeated .google.cloud.lifesciences.v2beta.Action actions = 1;

Returns
Type Description
List<? extends com.google.cloud.lifesciences.v2beta.ActionOrBuilder>

getDefaultInstanceForType()

public Pipeline getDefaultInstanceForType()
Returns
Type Description
Pipeline

getEncryptedEnvironment()

public Secret getEncryptedEnvironment()

The encrypted environment to pass into every action. Each action can also specify its own encrypted environment.

The secret must decrypt to a JSON-encoded dictionary where key-value pairs serve as environment variable names and their values. The decoded environment variables can overwrite the values specified by the environment field.

.google.cloud.lifesciences.v2beta.Secret encrypted_environment = 5;

Returns
Type Description
Secret

The encryptedEnvironment.

getEncryptedEnvironmentOrBuilder()

public SecretOrBuilder getEncryptedEnvironmentOrBuilder()

The encrypted environment to pass into every action. Each action can also specify its own encrypted environment.

The secret must decrypt to a JSON-encoded dictionary where key-value pairs serve as environment variable names and their values. The decoded environment variables can overwrite the values specified by the environment field.

.google.cloud.lifesciences.v2beta.Secret encrypted_environment = 5;

Returns
Type Description
SecretOrBuilder

getEnvironment() (deprecated)

public Map<String,String> getEnvironment()

Use #getEnvironmentMap() instead.

Returns
Type Description
Map<String,String>

getEnvironmentCount()

public int getEnvironmentCount()

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).

map<string, string> environment = 3;

Returns
Type Description
int

getEnvironmentMap()

public Map<String,String> getEnvironmentMap()

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).

map<string, string> environment = 3;

Returns
Type Description
Map<String,String>

getEnvironmentOrDefault(String key, String defaultValue)

public String getEnvironmentOrDefault(String key, String defaultValue)

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).

map<string, string> environment = 3;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getEnvironmentOrThrow(String key)

public String getEnvironmentOrThrow(String key)

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).

map<string, string> environment = 3;

Parameter
Name Description
key String
Returns
Type Description
String

getParserForType()

public Parser<Pipeline> getParserForType()
Returns
Type Description
Parser<Pipeline>
Overrides

getResources()

public Resources getResources()

The resources required for execution.

.google.cloud.lifesciences.v2beta.Resources resources = 2;

Returns
Type Description
Resources

The resources.

getResourcesOrBuilder()

public ResourcesOrBuilder getResourcesOrBuilder()

The resources required for execution.

.google.cloud.lifesciences.v2beta.Resources resources = 2;

Returns
Type Description
ResourcesOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTimeout()

public Duration 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.

.google.protobuf.Duration timeout = 4;

Returns
Type Description
Duration

The timeout.

getTimeoutOrBuilder()

public DurationOrBuilder getTimeoutOrBuilder()

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.

.google.protobuf.Duration timeout = 4;

Returns
Type Description
DurationOrBuilder

hasEncryptedEnvironment()

public boolean hasEncryptedEnvironment()

The encrypted environment to pass into every action. Each action can also specify its own encrypted environment.

The secret must decrypt to a JSON-encoded dictionary where key-value pairs serve as environment variable names and their values. The decoded environment variables can overwrite the values specified by the environment field.

.google.cloud.lifesciences.v2beta.Secret encrypted_environment = 5;

Returns
Type Description
boolean

Whether the encryptedEnvironment field is set.

hasResources()

public boolean hasResources()

The resources required for execution.

.google.cloud.lifesciences.v2beta.Resources resources = 2;

Returns
Type Description
boolean

Whether the resources field is set.

hasTimeout()

public boolean hasTimeout()

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.

.google.protobuf.Duration timeout = 4;

Returns
Type Description
boolean

Whether the timeout field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Pipeline.Builder newBuilderForType()
Returns
Type Description
Pipeline.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Pipeline.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Pipeline.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Pipeline.Builder toBuilder()
Returns
Type Description
Pipeline.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException