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

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

PIPELINE_FIELD_NUMBER

public static final int PIPELINE_FIELD_NUMBER
Field Value
TypeDescription
int

PUB_SUB_TOPIC_FIELD_NUMBER

public static final int PUB_SUB_TOPIC_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static RunPipelineRequest getDefaultInstance()
Returns
TypeDescription
RunPipelineRequest

getDescriptor()

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

newBuilder()

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

newBuilder(RunPipelineRequest prototype)

public static RunPipelineRequest.Builder newBuilder(RunPipelineRequest prototype)
Parameter
NameDescription
prototypeRunPipelineRequest
Returns
TypeDescription
RunPipelineRequest.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public RunPipelineRequest getDefaultInstanceForType()
Returns
TypeDescription
RunPipelineRequest

getLabels()

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

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.

getParserForType()

public Parser<RunPipelineRequest> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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
TypeDescription
boolean

Whether the pipeline 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 RunPipelineRequest.Builder newBuilderForType()
Returns
TypeDescription
RunPipelineRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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