Class Pipeline

  • All Implemented Interfaces:
    PipelineOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class Pipeline
    extends com.google.protobuf.GeneratedMessageV3
    implements PipelineOrBuilder
     Specifies a series of actions to execute, expressed as Docker containers.
     
    Protobuf type google.cloud.lifesciences.v2beta.Pipeline
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Pipeline.Builder
      Specifies a series of actions to execute, expressed as Docker containers.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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;
        Specified by:
        getActionsList in interface PipelineOrBuilder
      • getActionsCount

        public int getActionsCount()
         The list of actions to execute, in the order they are specified.
         
        repeated .google.cloud.lifesciences.v2beta.Action actions = 1;
        Specified by:
        getActionsCount in interface PipelineOrBuilder
      • getActions

        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;
        Specified by:
        getActions in interface PipelineOrBuilder
      • getActionsOrBuilder

        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;
        Specified by:
        getActionsOrBuilder in interface PipelineOrBuilder
      • hasResources

        public boolean hasResources()
         The resources required for execution.
         
        .google.cloud.lifesciences.v2beta.Resources resources = 2;
        Specified by:
        hasResources in interface PipelineOrBuilder
        Returns:
        Whether the resources field is set.
      • getResources

        public Resources getResources()
         The resources required for execution.
         
        .google.cloud.lifesciences.v2beta.Resources resources = 2;
        Specified by:
        getResources in interface PipelineOrBuilder
        Returns:
        The resources.
      • getEnvironmentCount

        public int getEnvironmentCount()
        Description copied from interface: PipelineOrBuilder
         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;
        Specified by:
        getEnvironmentCount in interface PipelineOrBuilder
      • containsEnvironment

        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;
        Specified by:
        containsEnvironment in interface PipelineOrBuilder
      • 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;
        Specified by:
        getEnvironmentMap in interface PipelineOrBuilder
      • getEnvironmentOrDefault

        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;
        Specified by:
        getEnvironmentOrDefault in interface PipelineOrBuilder
      • getEnvironmentOrThrow

        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;
        Specified by:
        getEnvironmentOrThrow in interface PipelineOrBuilder
      • 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;
        Specified by:
        hasEncryptedEnvironment in interface PipelineOrBuilder
        Returns:
        Whether the encryptedEnvironment field is set.
      • 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;
        Specified by:
        getEncryptedEnvironment in interface PipelineOrBuilder
        Returns:
        The encryptedEnvironment.
      • 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;
        Specified by:
        getEncryptedEnvironmentOrBuilder in interface PipelineOrBuilder
      • 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;
        Specified by:
        hasTimeout in interface PipelineOrBuilder
        Returns:
        Whether the timeout field is set.
      • getTimeout

        public com.google.protobuf.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;
        Specified by:
        getTimeout in interface PipelineOrBuilder
        Returns:
        The timeout.
      • getTimeoutOrBuilder

        public com.google.protobuf.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;
        Specified by:
        getTimeoutOrBuilder in interface PipelineOrBuilder
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static Pipeline parseFrom​(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Pipeline parseFrom​(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Pipeline parseFrom​(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Pipeline parseFrom​(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Pipeline parseFrom​(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Pipeline parseFrom​(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Pipeline parseFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
        Throws:
        IOException
      • newBuilderForType

        public Pipeline.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public Pipeline.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected Pipeline.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static Pipeline getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<Pipeline> parser()
      • getParserForType

        public com.google.protobuf.Parser<Pipeline> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public Pipeline getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder