Class RunPipelineRequest (0.46.0)

public final class RunPipelineRequest extends GeneratedMessageV3 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 Fields

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

PIPELINE_FIELD_NUMBER

public static final int PIPELINE_FIELD_NUMBER
Field Value
Type Description
int

PUB_SUB_TOPIC_FIELD_NUMBER

public static final int PUB_SUB_TOPIC_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RunPipelineRequest getDefaultInstance()
Returns
Type Description
RunPipelineRequest

getDescriptor()

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

newBuilder()

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

newBuilder(RunPipelineRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

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

equals(Object obj)

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

getDefaultInstanceForType()

public RunPipelineRequest getDefaultInstanceForType()
Returns
Type Description
RunPipelineRequest

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

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.

getParserForType()

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

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.

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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 RunPipelineRequest.Builder newBuilderForType()
Returns
Type Description
RunPipelineRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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