target.apidocs.com.google.api.services.dataflow.model.Step.html Maven / Gradle / Ivy
Step (Dataflow API v1b3-rev20231112-2.0.0)
com.google.api.services.dataflow.model
Class Step
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.dataflow.model.Step
-
public final class Step
extends com.google.api.client.json.GenericJson
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.
This is the Java data model class that specifies how to parse/serialize into the JSON that is
transmitted over HTTP when working with the Dataflow API. For a detailed explanation see:
https://developers.google.com/api-client-library/java/google-http-java-client/json
- Author:
- Google, Inc.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
Step()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
Step
clone()
String
getKind()
The kind of step in the Cloud Dataflow job.
String
getName()
The name that identifies the step.
Map<String,Object>
getProperties()
Named properties associated with the step.
Step
set(String fieldName,
Object value)
Step
setKind(String kind)
The kind of step in the Cloud Dataflow job.
Step
setName(String name)
The name that identifies the step.
Step
setProperties(Map<String,Object> properties)
Named properties associated with the step.
-
Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString
-
Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Method Detail
-
getKind
public String getKind()
The kind of step in the Cloud Dataflow job.
- Returns:
- value or
null
for none
-
setKind
public Step setKind(String kind)
The kind of step in the Cloud Dataflow job.
- Parameters:
kind
- kind or null
for none
-
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.
- Returns:
- value or
null
for none
-
setName
public Step setName(String name)
The name that identifies the step. This must be unique for each step with respect to all other
steps in the Cloud Dataflow job.
- Parameters:
name
- name or null
for none
-
getProperties
public Map<String,Object> 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.
- Returns:
- value or
null
for none
-
setProperties
public Step setProperties(Map<String,Object> properties)
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.
- Parameters:
properties
- properties or null
for none
-
set
public Step set(String fieldName,
Object value)
- Overrides:
set
in class com.google.api.client.json.GenericJson
-
clone
public Step clone()
- Overrides:
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2023 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy