Class RunPipelineRequest.Builder (0.44.0)

public static final class RunPipelineRequest.Builder extends GeneratedMessageV3.Builder<RunPipelineRequest.Builder> implements RunPipelineRequestOrBuilder

The arguments to the RunPipeline method. The requesting user must have the iam.serviceAccounts.actAs permission for the Cloud Life Sciences service account or the request will fail.

Protobuf type google.cloud.lifesciences.v2beta.RunPipelineRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public RunPipelineRequest build()
Returns
Type Description
RunPipelineRequest

buildPartial()

public RunPipelineRequest buildPartial()
Returns
Type Description
RunPipelineRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearLabels()

public RunPipelineRequest.Builder clearLabels()
Returns
Type Description
RunPipelineRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearParent()

public RunPipelineRequest.Builder clearParent()

The project and location that this request should be executed against.

string parent = 4;

Returns
Type Description
RunPipelineRequest.Builder

This builder for chaining.

clearPipeline()

public RunPipelineRequest.Builder clearPipeline()

Required. The description of the pipeline to run.

.google.cloud.lifesciences.v2beta.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
RunPipelineRequest.Builder

clearPubSubTopic()

public RunPipelineRequest.Builder clearPubSubTopic()

The name of an existing Pub/Sub topic. The server will publish messages to this topic whenever the status of the operation changes. The Life Sciences Service Agent account must have publisher permissions to the specified topic or notifications will not be sent.

string pub_sub_topic = 3;

Returns
Type Description
RunPipelineRequest.Builder

This builder for chaining.

clone()

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

containsLabels(String key)

public boolean containsLabels(String key)

User-defined labels to associate with the returned operation. These labels are not propagated to any Google Cloud Platform resources used by the operation, and can be modified at any time.

To associate labels with resources created while executing the operation, see the appropriate resource message (for example, VirtualMachine).

map<string, string> labels = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

getDefaultInstanceForType()

public RunPipelineRequest getDefaultInstanceForType()
Returns
Type Description
RunPipelineRequest

getDescriptorForType()

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

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

User-defined labels to associate with the returned operation. These labels are not propagated to any Google Cloud Platform resources used by the operation, and can be modified at any time.

To associate labels with resources created while executing the operation, see the appropriate resource message (for example, VirtualMachine).

map<string, string> labels = 2;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

User-defined labels to associate with the returned operation. These labels are not propagated to any Google Cloud Platform resources used by the operation, and can be modified at any time.

To associate labels with resources created while executing the operation, see the appropriate resource message (for example, VirtualMachine).

map<string, string> labels = 2;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

User-defined labels to associate with the returned operation. These labels are not propagated to any Google Cloud Platform resources used by the operation, and can be modified at any time.

To associate labels with resources created while executing the operation, see the appropriate resource message (for example, VirtualMachine).

map<string, string> labels = 2;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

User-defined labels to associate with the returned operation. These labels are not propagated to any Google Cloud Platform resources used by the operation, and can be modified at any time.

To associate labels with resources created while executing the operation, see the appropriate resource message (for example, VirtualMachine).

map<string, string> labels = 2;

Parameter
Name Description
key String
Returns
Type Description
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getParent()

public String getParent()

The project and location that this request should be executed against.

string parent = 4;

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

The project and location that this request should be executed against.

string parent = 4;

Returns
Type Description
ByteString

The bytes for parent.

getPipeline()

public Pipeline getPipeline()

Required. The description of the pipeline to run.

.google.cloud.lifesciences.v2beta.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Pipeline

The pipeline.

getPipelineBuilder()

public Pipeline.Builder getPipelineBuilder()

Required. The description of the pipeline to run.

.google.cloud.lifesciences.v2beta.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Pipeline.Builder

getPipelineOrBuilder()

public PipelineOrBuilder getPipelineOrBuilder()

Required. The description of the pipeline to run.

.google.cloud.lifesciences.v2beta.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
PipelineOrBuilder

getPubSubTopic()

public String getPubSubTopic()

The name of an existing Pub/Sub topic. The server will publish messages to this topic whenever the status of the operation changes. The Life Sciences Service Agent account must have publisher permissions to the specified topic or notifications will not be sent.

string pub_sub_topic = 3;

Returns
Type Description
String

The pubSubTopic.

getPubSubTopicBytes()

public ByteString getPubSubTopicBytes()

The name of an existing Pub/Sub topic. The server will publish messages to this topic whenever the status of the operation changes. The Life Sciences Service Agent account must have publisher permissions to the specified topic or notifications will not be sent.

string pub_sub_topic = 3;

Returns
Type Description
ByteString

The bytes for pubSubTopic.

hasPipeline()

public boolean hasPipeline()

Required. The description of the pipeline to run.

.google.cloud.lifesciences.v2beta.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the pipeline 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

mergeFrom(RunPipelineRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergePipeline(Pipeline value)

public RunPipelineRequest.Builder mergePipeline(Pipeline value)

Required. The description of the pipeline to run.

.google.cloud.lifesciences.v2beta.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Pipeline
Returns
Type Description
RunPipelineRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

putAllLabels(Map<String,String> values)

public RunPipelineRequest.Builder putAllLabels(Map<String,String> values)

User-defined labels to associate with the returned operation. These labels are not propagated to any Google Cloud Platform resources used by the operation, and can be modified at any time.

To associate labels with resources created while executing the operation, see the appropriate resource message (for example, VirtualMachine).

map<string, string> labels = 2;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
RunPipelineRequest.Builder

putLabels(String key, String value)

public RunPipelineRequest.Builder putLabels(String key, String value)

User-defined labels to associate with the returned operation. These labels are not propagated to any Google Cloud Platform resources used by the operation, and can be modified at any time.

To associate labels with resources created while executing the operation, see the appropriate resource message (for example, VirtualMachine).

map<string, string> labels = 2;

Parameters
Name Description
key String
value String
Returns
Type Description
RunPipelineRequest.Builder

removeLabels(String key)

public RunPipelineRequest.Builder removeLabels(String key)

User-defined labels to associate with the returned operation. These labels are not propagated to any Google Cloud Platform resources used by the operation, and can be modified at any time.

To associate labels with resources created while executing the operation, see the appropriate resource message (for example, VirtualMachine).

map<string, string> labels = 2;

Parameter
Name Description
key String
Returns
Type Description
RunPipelineRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setParent(String value)

public RunPipelineRequest.Builder setParent(String value)

The project and location that this request should be executed against.

string parent = 4;

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
RunPipelineRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public RunPipelineRequest.Builder setParentBytes(ByteString value)

The project and location that this request should be executed against.

string parent = 4;

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
RunPipelineRequest.Builder

This builder for chaining.

setPipeline(Pipeline value)

public RunPipelineRequest.Builder setPipeline(Pipeline value)

Required. The description of the pipeline to run.

.google.cloud.lifesciences.v2beta.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Pipeline
Returns
Type Description
RunPipelineRequest.Builder

setPipeline(Pipeline.Builder builderForValue)

public RunPipelineRequest.Builder setPipeline(Pipeline.Builder builderForValue)

Required. The description of the pipeline to run.

.google.cloud.lifesciences.v2beta.Pipeline pipeline = 1 [(.google.api.field_behavior) = REQUIRED];

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

setPubSubTopic(String value)

public RunPipelineRequest.Builder setPubSubTopic(String value)

The name of an existing Pub/Sub topic. The server will publish messages to this topic whenever the status of the operation changes. The Life Sciences Service Agent account must have publisher permissions to the specified topic or notifications will not be sent.

string pub_sub_topic = 3;

Parameter
Name Description
value String

The pubSubTopic to set.

Returns
Type Description
RunPipelineRequest.Builder

This builder for chaining.

setPubSubTopicBytes(ByteString value)

public RunPipelineRequest.Builder setPubSubTopicBytes(ByteString value)

The name of an existing Pub/Sub topic. The server will publish messages to this topic whenever the status of the operation changes. The Life Sciences Service Agent account must have publisher permissions to the specified topic or notifications will not be sent.

string pub_sub_topic = 3;

Parameter
Name Description
value ByteString

The bytes for pubSubTopic to set.

Returns
Type Description
RunPipelineRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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