Class Step (0.56.0)

public final class Step extends GeneratedMessageV3 implements StepOrBuilder

Defines a particular step within a Cloud Dataflow job.

A job consists of multiple steps, each of which performs some specific operation as part of the overall job. Data is typically passed from one step to another as part of the job.

Here's an example of a sequence of steps which together implement a Map-Reduce job:

  • Read a collection of data from some source, parsing the collection's elements.

  • Validate the elements.

  • Apply a user-defined function to map each element to some value and extract an element-specific key value.

  • Group elements with the same key into a single element with that key, transforming a multiply-keyed collection into a uniquely-keyed collection.

  • Write the elements out to some data sink.

    Note that the Cloud Dataflow service may be used to run many different types of jobs, not just Map-Reduce.

Protobuf type google.dataflow.v1beta3.Step

Implements

StepOrBuilder

Static Fields

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PROPERTIES_FIELD_NUMBER

public static final int PROPERTIES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Step getDefaultInstance()
Returns
Type Description
Step

getDescriptor()

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

newBuilder()

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

newBuilder(Step prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Step getDefaultInstanceForType()
Returns
Type Description
Step

getKind()

public String getKind()

The kind of step in the Cloud Dataflow job.

string kind = 1;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

The kind of step in the Cloud Dataflow job.

string kind = 1;

Returns
Type Description
ByteString

The bytes for kind.

getName()

public String getName()

The name that identifies the step. This must be unique for each step with respect to all other steps in the Cloud Dataflow job.

string name = 2;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name that identifies the step. This must be unique for each step with respect to all other steps in the Cloud Dataflow job.

string name = 2;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getProperties()

public Struct getProperties()

Named properties associated with the step. Each kind of predefined step has its own required set of properties. Must be provided on Create. Only retrieved with JOB_VIEW_ALL.

.google.protobuf.Struct properties = 3;

Returns
Type Description
Struct

The properties.

getPropertiesOrBuilder()

public StructOrBuilder getPropertiesOrBuilder()

Named properties associated with the step. Each kind of predefined step has its own required set of properties. Must be provided on Create. Only retrieved with JOB_VIEW_ALL.

.google.protobuf.Struct properties = 3;

Returns
Type Description
StructOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasProperties()

public boolean hasProperties()

Named properties associated with the step. Each kind of predefined step has its own required set of properties. Must be provided on Create. Only retrieved with JOB_VIEW_ALL.

.google.protobuf.Struct properties = 3;

Returns
Type Description
boolean

Whether the properties 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 Step.Builder newBuilderForType()
Returns
Type Description
Step.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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