Class Step.Builder (0.59.0) 

public static final class Step.Builder extends GeneratedMessageV3.Builder<Step.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Step.Builder

Implements

StepOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Step.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Step.Builder
Overrides

build()

public Step build()
Returns
Type Description
Step

buildPartial()

public Step buildPartial()
Returns
Type Description
Step

clear()

public Step.Builder clear()
Returns
Type Description
Step.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Step.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Step.Builder
Overrides

clearKind()

public Step.Builder clearKind()

The kind of step in the Cloud Dataflow job.

string kind = 1;

Returns
Type Description
Step.Builder

This builder for chaining.

clearName()

public Step.Builder clearName()

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
Step.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Step.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Step.Builder
Overrides

clearProperties()

public Step.Builder clearProperties()

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
Step.Builder

clone()

public Step.Builder clone()
Returns
Type Description
Step.Builder
Overrides

getDefaultInstanceForType()

public Step getDefaultInstanceForType()
Returns
Type Description
Step

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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.

getPropertiesBuilder()

public Struct.Builder getPropertiesBuilder()

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
Builder

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Step other)

public Step.Builder mergeFrom(Step other)
Parameter
Name Description
other Step
Returns
Type Description
Step.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Step.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Step.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Step.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Step.Builder
Overrides

mergeProperties(Struct value)

public Step.Builder mergeProperties(Struct value)

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;

Parameter
Name Description
value Struct
Returns
Type Description
Step.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Step.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Step.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public Step.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Step.Builder
Overrides

setKind(String value)

public Step.Builder setKind(String value)

The kind of step in the Cloud Dataflow job.

string kind = 1;

Parameter
Name Description
value String

The kind to set.
Returns
Type Description
Step.Builder

This builder for chaining.

setKindBytes(ByteString value)

public Step.Builder setKindBytes(ByteString value)

The kind of step in the Cloud Dataflow job.

string kind = 1;

Parameter
Name Description
value ByteString

The bytes for kind to set.
Returns
Type Description
Step.Builder

This builder for chaining.

setName(String value)

public Step.Builder setName(String value)

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;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Step.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Step.Builder setNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Step.Builder

This builder for chaining.

setProperties(Struct value)

public Step.Builder setProperties(Struct value)

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;

Parameter
Name Description
value Struct
Returns
Type Description
Step.Builder

setProperties(Struct.Builder builderForValue)

public Step.Builder setProperties(Struct.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Step.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Step.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Step.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Step.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Step.Builder
Overrides