Class Pipeline.Builder (0.47.0)

public static final class Pipeline.Builder extends GeneratedMessageV3.Builder<Pipeline.Builder> implements PipelineOrBuilder

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

Protobuf type google.cloud.lifesciences.v2beta.Pipeline

Implements

PipelineOrBuilder

Static Methods

getDescriptor()

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

Methods

addActions(Action value)

public Pipeline.Builder addActions(Action value)

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

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

Parameter
Name Description
value Action
Returns
Type Description
Pipeline.Builder

addActions(Action.Builder builderForValue)

public Pipeline.Builder addActions(Action.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Action.Builder
Returns
Type Description
Pipeline.Builder

addActions(int index, Action value)

public Pipeline.Builder addActions(int index, Action value)

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

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

Parameters
Name Description
index int
value Action
Returns
Type Description
Pipeline.Builder

addActions(int index, Action.Builder builderForValue)

public Pipeline.Builder addActions(int index, Action.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue Action.Builder
Returns
Type Description
Pipeline.Builder

addActionsBuilder()

public Action.Builder addActionsBuilder()

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

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

Returns
Type Description
Action.Builder

addActionsBuilder(int index)

public Action.Builder addActionsBuilder(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.Builder

addAllActions(Iterable<? extends Action> values)

public Pipeline.Builder addAllActions(Iterable<? extends Action> values)

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

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.lifesciences.v2beta.Action>
Returns
Type Description
Pipeline.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Pipeline.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Pipeline.Builder
Overrides

build()

public Pipeline build()
Returns
Type Description
Pipeline

buildPartial()

public Pipeline buildPartial()
Returns
Type Description
Pipeline

clear()

public Pipeline.Builder clear()
Returns
Type Description
Pipeline.Builder
Overrides

clearActions()

public Pipeline.Builder clearActions()

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

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

Returns
Type Description
Pipeline.Builder

clearEncryptedEnvironment()

public Pipeline.Builder clearEncryptedEnvironment()

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
Pipeline.Builder

clearEnvironment()

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

clearField(Descriptors.FieldDescriptor field)

public Pipeline.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Pipeline.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Pipeline.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Pipeline.Builder
Overrides

clearResources()

public Pipeline.Builder clearResources()

The resources required for execution.

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

Returns
Type Description
Pipeline.Builder

clearTimeout()

public Pipeline.Builder clearTimeout()

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
Pipeline.Builder

clone()

public Pipeline.Builder clone()
Returns
Type Description
Pipeline.Builder
Overrides

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

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

getActionsBuilder(int index)

public Action.Builder getActionsBuilder(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.Builder

getActionsBuilderList()

public List<Action.Builder> getActionsBuilderList()

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

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

Returns
Type Description
List<Builder>

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getEncryptedEnvironmentBuilder()

public Secret.Builder getEncryptedEnvironmentBuilder()

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

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

getMutableEnvironment() (deprecated)

public Map<String,String> getMutableEnvironment()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getResources()

public Resources getResources()

The resources required for execution.

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

Returns
Type Description
Resources

The resources.

getResourcesBuilder()

public Resources.Builder getResourcesBuilder()

The resources required for execution.

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

Returns
Type Description
Resources.Builder

getResourcesOrBuilder()

public ResourcesOrBuilder getResourcesOrBuilder()

The resources required for execution.

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

Returns
Type Description
ResourcesOrBuilder

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.

getTimeoutBuilder()

public Duration.Builder getTimeoutBuilder()

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
Builder

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.

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEncryptedEnvironment(Secret value)

public Pipeline.Builder mergeEncryptedEnvironment(Secret value)

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;

Parameter
Name Description
value Secret
Returns
Type Description
Pipeline.Builder

mergeFrom(Pipeline other)

public Pipeline.Builder mergeFrom(Pipeline other)
Parameter
Name Description
other Pipeline
Returns
Type Description
Pipeline.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Pipeline.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Pipeline.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Pipeline.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Pipeline.Builder
Overrides

mergeResources(Resources value)

public Pipeline.Builder mergeResources(Resources value)

The resources required for execution.

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

Parameter
Name Description
value Resources
Returns
Type Description
Pipeline.Builder

mergeTimeout(Duration value)

public Pipeline.Builder mergeTimeout(Duration value)

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;

Parameter
Name Description
value Duration
Returns
Type Description
Pipeline.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Pipeline.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Pipeline.Builder
Overrides

putAllEnvironment(Map<String,String> values)

public Pipeline.Builder putAllEnvironment(Map<String,String> values)

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
values Map<String,String>
Returns
Type Description
Pipeline.Builder

putEnvironment(String key, String value)

public Pipeline.Builder putEnvironment(String key, String value)

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
value String
Returns
Type Description
Pipeline.Builder

removeActions(int index)

public Pipeline.Builder removeActions(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
Pipeline.Builder

removeEnvironment(String key)

public Pipeline.Builder removeEnvironment(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
Pipeline.Builder

setActions(int index, Action value)

public Pipeline.Builder setActions(int index, Action value)

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

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

Parameters
Name Description
index int
value Action
Returns
Type Description
Pipeline.Builder

setActions(int index, Action.Builder builderForValue)

public Pipeline.Builder setActions(int index, Action.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue Action.Builder
Returns
Type Description
Pipeline.Builder

setEncryptedEnvironment(Secret value)

public Pipeline.Builder setEncryptedEnvironment(Secret value)

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;

Parameter
Name Description
value Secret
Returns
Type Description
Pipeline.Builder

setEncryptedEnvironment(Secret.Builder builderForValue)

public Pipeline.Builder setEncryptedEnvironment(Secret.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Secret.Builder
Returns
Type Description
Pipeline.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Pipeline.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Pipeline.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Pipeline.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Pipeline.Builder
Overrides

setResources(Resources value)

public Pipeline.Builder setResources(Resources value)

The resources required for execution.

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

Parameter
Name Description
value Resources
Returns
Type Description
Pipeline.Builder

setResources(Resources.Builder builderForValue)

public Pipeline.Builder setResources(Resources.Builder builderForValue)

The resources required for execution.

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

Parameter
Name Description
builderForValue Resources.Builder
Returns
Type Description
Pipeline.Builder

setTimeout(Duration value)

public Pipeline.Builder setTimeout(Duration value)

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;

Parameter
Name Description
value Duration
Returns
Type Description
Pipeline.Builder

setTimeout(Duration.Builder builderForValue)

public Pipeline.Builder setTimeout(Duration.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Pipeline.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Pipeline.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Pipeline.Builder
Overrides