Package com.oracle.bmc.dataintegration.model

Class Pipeline

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.dataintegration.model.Pipeline

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200430")
public final class Pipeline
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

A pipeline is a logical grouping of tasks that together perform a higher level operation.

For example, a pipeline could contain a set of tasks that load and clean data, then execute a dataflow to analyze the data. The pipeline allows you to manage the activities as a unit instead of individually. Users can also schedule the pipeline instead of the tasks independently.
Note: Objects should always be created or deserialized using the Pipeline.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Pipeline.Builder, which maintain a set of all explicitly set fields called Pipeline.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Pipeline.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
Pipeline(String key, String modelVersion, ParentReference parentRef, String name, String description, String modelType, Integer objectVersion, Integer objectStatus, String identifier, List<FlowNode> nodes, List<Parameter> parameters, ConfigValues flowConfigValues, List<Variable> variables, ObjectMetadata metadata)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static Pipeline.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getDescription()	Detailed description for the object.
ConfigValues	getFlowConfigValues()
String	getIdentifier()	Value can only contain upper case letters, underscore, and numbers.
String	getKey()	Generated key that can be used in API calls to identify pipeline.
ObjectMetadata	getMetadata()
String	getModelType()	The type of the object.
String	getModelVersion()	This is a version number that is used by the service to upgrade objects if needed through releases of the service.
String	getName()	Free form text without any restriction on permitted characters.
List<FlowNode>	getNodes()	A list of nodes attached to the pipeline.
Integer	getObjectStatus()	The status of an object that can be set to value 1 for shallow references across objects, other values reserved.
Integer	getObjectVersion()	This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object.
List<Parameter>	getParameters()	A list of parameters for the pipeline, this allows certain aspects of the pipeline to be configured when the pipeline is executed.
ParentReference	getParentRef()
List<Variable>	getVariables()	The list of variables required in pipeline, variables can be used to store values that can be used as inputs to tasks in the pipeline.
int	hashCode()
Pipeline.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Pipeline

@Deprecated
@ConstructorProperties({"key","modelVersion","parentRef","name","description","modelType","objectVersion","objectStatus","identifier","nodes","parameters","flowConfigValues","variables","metadata"})
public Pipeline(String key,
                String modelVersion,
                ParentReference parentRef,
                String name,
                String description,
                String modelType,
                Integer objectVersion,
                Integer objectStatus,
                String identifier,
                List<FlowNode> nodes,
                List<Parameter> parameters,
                ConfigValues flowConfigValues,
                List<Variable> variables,
                ObjectMetadata metadata)

Deprecated.

Method Detail

builder

public static Pipeline.Builder builder()

Create a new builder.

toBuilder

public Pipeline.Builder toBuilder()

getKey

public String getKey()

Generated key that can be used in API calls to identify pipeline.

On scenarios where reference to the pipeline is needed, a value can be passed in create.

Returns:

the value

getModelVersion

public String getModelVersion()

This is a version number that is used by the service to upgrade objects if needed through releases of the service.

Returns:

the value

getParentRef

public ParentReference getParentRef()

getName

public String getName()

Free form text without any restriction on permitted characters.

Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Returns:

the value

getDescription

public String getDescription()

Detailed description for the object.

Returns:

the value

getModelType

public String getModelType()

The type of the object.

Returns:

the value

getObjectVersion

public Integer getObjectVersion()

This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object.

Returns:

the value

getObjectStatus

public Integer getObjectStatus()

The status of an object that can be set to value 1 for shallow references across objects, other values reserved.

Returns:

the value

getIdentifier

public String getIdentifier()

Value can only contain upper case letters, underscore, and numbers.

It should begin with upper case letter or underscore. The value can be modified.

Returns:

the value

getNodes

public List<FlowNode> getNodes()

A list of nodes attached to the pipeline.

Returns:

the value

getParameters

public List<Parameter> getParameters()

A list of parameters for the pipeline, this allows certain aspects of the pipeline to be configured when the pipeline is executed.

Returns:

the value

getFlowConfigValues

public ConfigValues getFlowConfigValues()

getVariables

public List<Variable> getVariables()

The list of variables required in pipeline, variables can be used to store values that can be used as inputs to tasks in the pipeline.

Returns:

the value

getMetadata

public ObjectMetadata getMetadata()

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel