Reference documentation and code samples for the Dataflow V1beta3 API class Google::Cloud::Dataflow::V1beta3::Step.
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.
Note: The properties of this object are not stable and might change.
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.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#kind
defkind()->::String
Returns
(::String) — The kind of step in the Cloud Dataflow job.
#kind=
defkind=(value)->::String
Parameter
value (::String) — The kind of step in the Cloud Dataflow job.
Returns
(::String) — The kind of step in the Cloud Dataflow job.
#name
defname()->::String
Returns
(::String) — The name that identifies the step. This must be unique for each
step with respect to all other steps in the Cloud Dataflow job.
#name=
defname=(value)->::String
Parameter
value (::String) — The name that identifies the step. This must be unique for each
step with respect to all other steps in the Cloud Dataflow job.
Returns
(::String) — The name that identifies the step. This must be unique for each
step with respect to all other steps in the Cloud Dataflow job.
#properties
defproperties()->::Google::Protobuf::Struct
Returns
(::Google::Protobuf::Struct) — 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.
#properties=
defproperties=(value)->::Google::Protobuf::Struct
Parameter
value (::Google::Protobuf::Struct) — 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.
Returns
(::Google::Protobuf::Struct) — 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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Dataflow V1beta3 API - Class Google::Cloud::Dataflow::V1beta3::Step (v0.13.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.13.1 (latest)](/ruby/docs/reference/google-cloud-dataflow-v1beta3/latest/Google-Cloud-Dataflow-V1beta3-Step)\n- [0.13.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.13.0/Google-Cloud-Dataflow-V1beta3-Step)\n- [0.12.1](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.12.1/Google-Cloud-Dataflow-V1beta3-Step)\n- [0.11.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.11.0/Google-Cloud-Dataflow-V1beta3-Step)\n- [0.10.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.10.0/Google-Cloud-Dataflow-V1beta3-Step)\n- [0.9.1](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.9.1/Google-Cloud-Dataflow-V1beta3-Step)\n- [0.8.2](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.8.2/Google-Cloud-Dataflow-V1beta3-Step)\n- [0.7.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.7.0/Google-Cloud-Dataflow-V1beta3-Step)\n- [0.6.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.6.0/Google-Cloud-Dataflow-V1beta3-Step)\n- [0.5.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.5.0/Google-Cloud-Dataflow-V1beta3-Step)\n- [0.4.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.4.0/Google-Cloud-Dataflow-V1beta3-Step)\n- [0.3.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.3.0/Google-Cloud-Dataflow-V1beta3-Step)\n- [0.2.0](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.2.0/Google-Cloud-Dataflow-V1beta3-Step)\n- [0.1.4](/ruby/docs/reference/google-cloud-dataflow-v1beta3/0.1.4/Google-Cloud-Dataflow-V1beta3-Step) \nReference documentation and code samples for the Dataflow V1beta3 API class Google::Cloud::Dataflow::V1beta3::Step.\n\nDefines a particular step within a Cloud Dataflow job.\n\n\nA job consists of multiple steps, each of which performs some\nspecific operation as part of the overall job. Data is typically\npassed from one step to another as part of the job.\n\n**Note:** The properties of this object are not stable and might change.\n\nHere's an example of a sequence of steps which together implement a\nMap-Reduce job:\n\n- Read a collection of data from some source, parsing the\n collection's elements.\n\n- Validate the elements.\n\n- Apply a user-defined function to map each element to some value\n and extract an element-specific key value.\n\n- Group elements with the same key into a single element with\n that key, transforming a multiply-keyed collection into a\n uniquely-keyed collection.\n\n- Write the elements out to some data sink.\n\n\u003cbr /\u003e\n\nNote that the Cloud Dataflow service may be used to run many different\ntypes of jobs, not just Map-Reduce. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #kind\n\n def kind() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The kind of step in the Cloud Dataflow job.\n\n### #kind=\n\n def kind=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The kind of step in the Cloud Dataflow job. \n**Returns**\n\n- (::String) --- The kind of step in the Cloud Dataflow job.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The name that identifies the step. This must be unique for each step with respect to all other steps in the Cloud Dataflow job.\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The name that identifies the step. This must be unique for each step with respect to all other steps in the Cloud Dataflow job. \n**Returns**\n\n- (::String) --- The name that identifies the step. This must be unique for each step with respect to all other steps in the Cloud Dataflow job.\n\n### #properties\n\n def properties() -\u003e ::Google::Protobuf::Struct\n\n**Returns**\n\n- ([::Google::Protobuf::Struct](./Google-Protobuf-Struct)) --- 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.\n\n### #properties=\n\n def properties=(value) -\u003e ::Google::Protobuf::Struct\n\n**Parameter**\n\n- **value** ([::Google::Protobuf::Struct](./Google-Protobuf-Struct)) --- 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. \n**Returns**\n\n- ([::Google::Protobuf::Struct](./Google-Protobuf-Struct)) --- 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."]]