Class RunPipelineRequest.Builder (0.37.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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RunPipelineRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
RunPipelineRequest.Builder
Overrides

build()

public RunPipelineRequest build()
Returns
TypeDescription
RunPipelineRequest

buildPartial()

public RunPipelineRequest buildPartial()
Returns
TypeDescription
RunPipelineRequest

clear()

public RunPipelineRequest.Builder clear()
Returns
TypeDescription
RunPipelineRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public RunPipelineRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
RunPipelineRequest.Builder
Overrides

clearLabels()

public RunPipelineRequest.Builder clearLabels()
Returns
TypeDescription
RunPipelineRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public RunPipelineRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
RunPipelineRequest.Builder
Overrides

clearParent()

public RunPipelineRequest.Builder clearParent()

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

string parent = 4;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
RunPipelineRequest.Builder

This builder for chaining.

clone()

public RunPipelineRequest.Builder clone()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

getDefaultInstanceForType()

public RunPipelineRequest getDefaultInstanceForType()
Returns
TypeDescription
RunPipelineRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

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

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getParent()

public String getParent()

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

string parent = 4;

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

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

string parent = 4;

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

Whether the pipeline field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(RunPipelineRequest other)

public RunPipelineRequest.Builder mergeFrom(RunPipelineRequest other)
Parameter
NameDescription
otherRunPipelineRequest
Returns
TypeDescription
RunPipelineRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RunPipelineRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RunPipelineRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public RunPipelineRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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
NameDescription
valuePipeline
Returns
TypeDescription
RunPipelineRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RunPipelineRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valuesMap<String,String>
Returns
TypeDescription
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
NameDescription
keyString
valueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
RunPipelineRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public RunPipelineRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The parent to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
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
NameDescription
valuePipeline
Returns
TypeDescription
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
NameDescription
builderForValuePipeline.Builder
Returns
TypeDescription
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
NameDescription
valueString

The pubSubTopic to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for pubSubTopic to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
RunPipelineRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final RunPipelineRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
RunPipelineRequest.Builder
Overrides