Class Pipeline (0.18.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
TypeDescription
int

ENCRYPTED_ENVIRONMENT_FIELD_NUMBER

public static final int ENCRYPTED_ENVIRONMENT_FIELD_NUMBER
Field Value
TypeDescription
int

ENVIRONMENT_FIELD_NUMBER

public static final int ENVIRONMENT_FIELD_NUMBER
Field Value
TypeDescription
int

RESOURCES_FIELD_NUMBER

public static final int RESOURCES_FIELD_NUMBER
Field Value
TypeDescription
int

TIMEOUT_FIELD_NUMBER

public static final int TIMEOUT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Pipeline getDefaultInstance()
Returns
TypeDescription
Pipeline

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Pipeline.Builder newBuilder()
Returns
TypeDescription
Pipeline.Builder

newBuilder(Pipeline prototype)

public static Pipeline.Builder newBuilder(Pipeline prototype)
Parameter
NameDescription
prototypePipeline
Returns
TypeDescription
Pipeline.Builder

parseDelimitedFrom(InputStream input)

public static Pipeline parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Pipeline
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Pipeline parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Pipeline
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Pipeline parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Pipeline
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Pipeline parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Pipeline
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Pipeline parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Pipeline
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Pipeline parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Pipeline
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Pipeline parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Pipeline
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Pipeline parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Pipeline
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Pipeline parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Pipeline
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Pipeline parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Pipeline
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Pipeline parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Pipeline
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Pipeline parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Pipeline
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Pipeline> parser()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.cloud.lifesciences.v2beta.ActionOrBuilder>

getDefaultInstanceForType()

public Pipeline getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
SecretOrBuilder

getEnvironment()

public Map<String,String> getEnvironment()

Use #getEnvironmentMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getParserForType()

public Parser<Pipeline> getParserForType()
Returns
TypeDescription
Parser<Pipeline>
Overrides

getResources()

public Resources getResources()

The resources required for execution.

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

Returns
TypeDescription
Resources

The resources.

getResourcesOrBuilder()

public ResourcesOrBuilder getResourcesOrBuilder()

The resources required for execution.

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

Returns
TypeDescription
ResourcesOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
DurationOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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
TypeDescription
boolean

Whether the encryptedEnvironment field is set.

hasResources()

public boolean hasResources()

The resources required for execution.

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the timeout field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Pipeline.Builder newBuilderForType()
Returns
TypeDescription
Pipeline.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Pipeline.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Pipeline.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Pipeline.Builder toBuilder()
Returns
TypeDescription
Pipeline.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException