Class WorkflowInvocationAction (0.75.0) 

public final class WorkflowInvocationAction extends GeneratedMessageV3 implements WorkflowInvocationActionOrBuilder

Represents a single action in a workflow invocation.

Protobuf type google.cloud.dataform.v1.WorkflowInvocationAction

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > WorkflowInvocationAction

Static Fields

BIGQUERY_ACTION_FIELD_NUMBER

public static final int BIGQUERY_ACTION_FIELD_NUMBER
Field Value
Type Description
int

CANONICAL_TARGET_FIELD_NUMBER

public static final int CANONICAL_TARGET_FIELD_NUMBER
Field Value
Type Description
int

DATA_PREPARATION_ACTION_FIELD_NUMBER

public static final int DATA_PREPARATION_ACTION_FIELD_NUMBER
Field Value
Type Description
int

FAILURE_REASON_FIELD_NUMBER

public static final int FAILURE_REASON_FIELD_NUMBER
Field Value
Type Description
int

INTERNAL_METADATA_FIELD_NUMBER

public static final int INTERNAL_METADATA_FIELD_NUMBER
Field Value
Type Description
int

INVOCATION_TIMING_FIELD_NUMBER

public static final int INVOCATION_TIMING_FIELD_NUMBER
Field Value
Type Description
int

NOTEBOOK_ACTION_FIELD_NUMBER

public static final int NOTEBOOK_ACTION_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

TARGET_FIELD_NUMBER

public static final int TARGET_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static WorkflowInvocationAction getDefaultInstance()
Returns
Type Description
WorkflowInvocationAction

getDescriptor()

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

newBuilder()

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

newBuilder(WorkflowInvocationAction prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getActionCase()

public WorkflowInvocationAction.ActionCase getActionCase()
Returns
Type Description
WorkflowInvocationAction.ActionCase

getBigqueryAction()

public WorkflowInvocationAction.BigQueryAction getBigqueryAction()

Output only. The workflow action's bigquery action details.

.google.cloud.dataform.v1.WorkflowInvocationAction.BigQueryAction bigquery_action = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
WorkflowInvocationAction.BigQueryAction

The bigqueryAction.

getBigqueryActionOrBuilder()

public WorkflowInvocationAction.BigQueryActionOrBuilder getBigqueryActionOrBuilder()

Output only. The workflow action's bigquery action details.

.google.cloud.dataform.v1.WorkflowInvocationAction.BigQueryAction bigquery_action = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
WorkflowInvocationAction.BigQueryActionOrBuilder

getCanonicalTarget()

public Target getCanonicalTarget()

Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.

.google.cloud.dataform.v1.Target canonical_target = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Target

The canonicalTarget.

getCanonicalTargetOrBuilder()

public TargetOrBuilder getCanonicalTargetOrBuilder()

Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.

.google.cloud.dataform.v1.Target canonical_target = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TargetOrBuilder

getDataPreparationAction()

public WorkflowInvocationAction.DataPreparationAction getDataPreparationAction()

Output only. The workflow action's data preparation action details.

.google.cloud.dataform.v1.WorkflowInvocationAction.DataPreparationAction data_preparation_action = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
WorkflowInvocationAction.DataPreparationAction

The dataPreparationAction.

getDataPreparationActionOrBuilder()

public WorkflowInvocationAction.DataPreparationActionOrBuilder getDataPreparationActionOrBuilder()

Output only. The workflow action's data preparation action details.

.google.cloud.dataform.v1.WorkflowInvocationAction.DataPreparationAction data_preparation_action = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
WorkflowInvocationAction.DataPreparationActionOrBuilder

getDefaultInstanceForType()

public WorkflowInvocationAction getDefaultInstanceForType()
Returns
Type Description
WorkflowInvocationAction

getFailureReason()

public String getFailureReason()

Output only. If and only if action's state is FAILED a failure reason is set.

string failure_reason = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The failureReason.

getFailureReasonBytes()

public ByteString getFailureReasonBytes()

Output only. If and only if action's state is FAILED a failure reason is set.

string failure_reason = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for failureReason.

getInternalMetadata()

public String getInternalMetadata()

Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.

optional string internal_metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The internalMetadata.

getInternalMetadataBytes()

public ByteString getInternalMetadataBytes()

Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.

optional string internal_metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for internalMetadata.

getInvocationTiming()

public Interval getInvocationTiming()

Output only. This action's timing details. start_time will be set if the action is in [RUNNING, SUCCEEDED, CANCELLED, FAILED] state. end_time will be set if the action is in [SUCCEEDED, CANCELLED, FAILED] state.

.google.type.Interval invocation_timing = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.Interval

The invocationTiming.

getInvocationTimingOrBuilder()

public IntervalOrBuilder getInvocationTimingOrBuilder()

Output only. This action's timing details. start_time will be set if the action is in [RUNNING, SUCCEEDED, CANCELLED, FAILED] state. end_time will be set if the action is in [SUCCEEDED, CANCELLED, FAILED] state.

.google.type.Interval invocation_timing = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.type.IntervalOrBuilder

getNotebookAction()

public WorkflowInvocationAction.NotebookAction getNotebookAction()

Output only. The workflow action's notebook action details.

.google.cloud.dataform.v1.WorkflowInvocationAction.NotebookAction notebook_action = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
WorkflowInvocationAction.NotebookAction

The notebookAction.

getNotebookActionOrBuilder()

public WorkflowInvocationAction.NotebookActionOrBuilder getNotebookActionOrBuilder()

Output only. The workflow action's notebook action details.

.google.cloud.dataform.v1.WorkflowInvocationAction.NotebookAction notebook_action = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
WorkflowInvocationAction.NotebookActionOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public WorkflowInvocationAction.State getState()

Output only. This action's current state.

.google.cloud.dataform.v1.WorkflowInvocationAction.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
WorkflowInvocationAction.State

The state.

getStateValue()

public int getStateValue()

Output only. This action's current state.

.google.cloud.dataform.v1.WorkflowInvocationAction.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getTarget()

public Target getTarget()

Output only. This action's identifier. Unique within the workflow invocation.

.google.cloud.dataform.v1.Target target = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Target

The target.

getTargetOrBuilder()

public TargetOrBuilder getTargetOrBuilder()

Output only. This action's identifier. Unique within the workflow invocation.

.google.cloud.dataform.v1.Target target = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TargetOrBuilder

hasBigqueryAction()

public boolean hasBigqueryAction()

Output only. The workflow action's bigquery action details.

.google.cloud.dataform.v1.WorkflowInvocationAction.BigQueryAction bigquery_action = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the bigqueryAction field is set.

hasCanonicalTarget()

public boolean hasCanonicalTarget()

Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.

.google.cloud.dataform.v1.Target canonical_target = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the canonicalTarget field is set.

hasDataPreparationAction()

public boolean hasDataPreparationAction()

Output only. The workflow action's data preparation action details.

.google.cloud.dataform.v1.WorkflowInvocationAction.DataPreparationAction data_preparation_action = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the dataPreparationAction field is set.

hasInternalMetadata()

public boolean hasInternalMetadata()

Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.

optional string internal_metadata = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the internalMetadata field is set.

hasInvocationTiming()

public boolean hasInvocationTiming()

Output only. This action's timing details. start_time will be set if the action is in [RUNNING, SUCCEEDED, CANCELLED, FAILED] state. end_time will be set if the action is in [SUCCEEDED, CANCELLED, FAILED] state.

.google.type.Interval invocation_timing = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the invocationTiming field is set.

hasNotebookAction()

public boolean hasNotebookAction()

Output only. The workflow action's notebook action details.

.google.cloud.dataform.v1.WorkflowInvocationAction.NotebookAction notebook_action = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the notebookAction field is set.

hasTarget()

public boolean hasTarget()

Output only. This action's identifier. Unique within the workflow invocation.

.google.cloud.dataform.v1.Target target = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the target field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public WorkflowInvocationAction.Builder newBuilderForType()
Returns
Type Description
WorkflowInvocationAction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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