Package com.oracle.bmc.mediaservices.model

Class MediaWorkflowTask

java.lang.Object

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

com.oracle.bmc.mediaservices.model.MediaWorkflowTask

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

Defines the type of processing to be run at a given point in the workflow, parameters to configure the processing, and any processing that must be completed before this processing begins.
Note: Objects should always be created or deserialized using the MediaWorkflowTask.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 MediaWorkflowTask.Builder, which maintain a set of all explicitly set fields called MediaWorkflowTask.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	MediaWorkflowTask.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
MediaWorkflowTask(String type, Long version, String key, List<String> prerequisites, String enableParameterReference, Map<String,Object> enableWhenReferencedParameterEquals, Map<String,Object> parameters)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static MediaWorkflowTask.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getEnableParameterReference()	Allows this task to be conditionally enabled.
Map<String,Object>	getEnableWhenReferencedParameterEquals()	Used in conjunction with enableParameterReference to conditionally enable a task.
String	getKey()	A unique identifier for this task within its workflow.
Map<String,Object>	getParameters()	Data specifiying how this task is to be run.
List<String>	getPrerequisites()	Keys to the other tasks in this workflow that must be completed before execution of this task can begin.
String	getType()	The type of process to run at this task.
Long	getVersion()	The version of the MediaWorkflowTaskDeclaration.
int	hashCode()
MediaWorkflowTask.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

MediaWorkflowTask

@Deprecated
@ConstructorProperties({"type","version","key","prerequisites","enableParameterReference","enableWhenReferencedParameterEquals","parameters"})
public MediaWorkflowTask(String type,
                         Long version,
                         String key,
                         List<String> prerequisites,
                         String enableParameterReference,
                         Map<String,Object> enableWhenReferencedParameterEquals,
                         Map<String,Object> parameters)

Deprecated.

Method Detail

builder

public static MediaWorkflowTask.Builder builder()

Create a new builder.

toBuilder

public MediaWorkflowTask.Builder toBuilder()

getType

public String getType()

The type of process to run at this task.

Refers to the name of a MediaWorkflowTaskDeclaration.

Returns:

the value

getVersion

public Long getVersion()

The version of the MediaWorkflowTaskDeclaration.

Returns:

the value

getKey

public String getKey()

A unique identifier for this task within its workflow.

Keys are used to reference a task within workflows and MediaWorkflowJobs. Tasks are referenced as prerequisites and to track output and state.

Returns:

the value

getPrerequisites

public List<String> getPrerequisites()

Keys to the other tasks in this workflow that must be completed before execution of this task can begin.

Returns:

the value

getEnableParameterReference

public String getEnableParameterReference()

Allows this task to be conditionally enabled.

If no value or a blank value is given, the task is unconditionally enbled. Otherwise the given string specifies a parameter of the job created for this task’s workflow using the JSON pointer syntax. The JSON pointer is validated when a job is created from the workflow of this task.

Returns:

the value

getEnableWhenReferencedParameterEquals

public Map<String,Object> getEnableWhenReferencedParameterEquals()

Used in conjunction with enableParameterReference to conditionally enable a task.

When a job is created from the workflow of this task, the task will only be enabled if the value of the parameter specified by enableParameterReference is equal to the value of this property. This property must be prenset if and only if a enableParameterReference is given. The value is a JSON node.

Returns:

the value

getParameters

public Map<String,Object> getParameters()

Data specifiying how this task is to be run.

The data is a JSON object that must conform to the JSON Schema specified by the parameters of the MediaWorkflowTaskDeclaration this task references. The parameters may contain values or references to other parameters.

Returns:

the value

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