Class Step.Builder

  • All Implemented Interfaces:
    StepOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    Step

    public static final class Step.Builder
    extends com.google.protobuf.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
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Step.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)  
      Step build()  
      Step buildPartial()  
      Step.Builder clear()  
      Step.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)  
      Step.Builder clearKind()
      The kind of step in the Cloud Dataflow job.
      Step.Builder clearName()
      The name that identifies the step.
      Step.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)  
      Step.Builder clearProperties()
      Named properties associated with the step.
      Step.Builder clone()  
      Step getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Descriptors.Descriptor getDescriptorForType()  
      String getKind()
      The kind of step in the Cloud Dataflow job.
      com.google.protobuf.ByteString getKindBytes()
      The kind of step in the Cloud Dataflow job.
      String getName()
      The name that identifies the step.
      com.google.protobuf.ByteString getNameBytes()
      The name that identifies the step.
      com.google.protobuf.Struct getProperties()
      Named properties associated with the step.
      com.google.protobuf.Struct.Builder getPropertiesBuilder()
      Named properties associated with the step.
      com.google.protobuf.StructOrBuilder getPropertiesOrBuilder()
      Named properties associated with the step.
      boolean hasProperties()
      Named properties associated with the step.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      Step.Builder mergeFrom​(Step other)  
      Step.Builder mergeFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      Step.Builder mergeFrom​(com.google.protobuf.Message other)  
      Step.Builder mergeProperties​(com.google.protobuf.Struct value)
      Named properties associated with the step.
      Step.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)  
      Step.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)  
      Step.Builder setKind​(String value)
      The kind of step in the Cloud Dataflow job.
      Step.Builder setKindBytes​(com.google.protobuf.ByteString value)
      The kind of step in the Cloud Dataflow job.
      Step.Builder setName​(String value)
      The name that identifies the step.
      Step.Builder setNameBytes​(com.google.protobuf.ByteString value)
      The name that identifies the step.
      Step.Builder setProperties​(com.google.protobuf.Struct value)
      Named properties associated with the step.
      Step.Builder setProperties​(com.google.protobuf.Struct.Builder builderForValue)
      Named properties associated with the step.
      Step.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)  
      Step.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)  
      • Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

        getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
      • Methods inherited from class com.google.protobuf.AbstractMessage.Builder

        findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
      • Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

        addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
      • Methods inherited from interface com.google.protobuf.Message.Builder

        mergeDelimitedFrom, mergeDelimitedFrom
      • Methods inherited from interface com.google.protobuf.MessageLite.Builder

        mergeFrom
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Step.Builder>
      • clear

        public Step.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Step.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Step.Builder>
      • getDefaultInstanceForType

        public Step getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

        public Step build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder
      • buildPartial

        public Step buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder
      • clone

        public Step.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Step.Builder>
      • setField

        public Step.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                     Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Step.Builder>
      • clearField

        public Step.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Step.Builder>
      • clearOneof

        public Step.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Step.Builder>
      • setRepeatedField

        public Step.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             int index,
                                             Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Step.Builder>
      • addRepeatedField

        public Step.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Step.Builder>
      • mergeFrom

        public Step.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Step.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Step.Builder>
      • mergeFrom

        public Step.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Step.Builder>
        Throws:
        IOException
      • getKind

        public String getKind()
         The kind of step in the Cloud Dataflow job.
         
        string kind = 1;
        Specified by:
        getKind in interface StepOrBuilder
        Returns:
        The kind.
      • getKindBytes

        public com.google.protobuf.ByteString getKindBytes()
         The kind of step in the Cloud Dataflow job.
         
        string kind = 1;
        Specified by:
        getKindBytes in interface StepOrBuilder
        Returns:
        The bytes for kind.
      • setKind

        public Step.Builder setKind​(String value)
         The kind of step in the Cloud Dataflow job.
         
        string kind = 1;
        Parameters:
        value - The kind to set.
        Returns:
        This builder for chaining.
      • clearKind

        public Step.Builder clearKind()
         The kind of step in the Cloud Dataflow job.
         
        string kind = 1;
        Returns:
        This builder for chaining.
      • setKindBytes

        public Step.Builder setKindBytes​(com.google.protobuf.ByteString value)
         The kind of step in the Cloud Dataflow job.
         
        string kind = 1;
        Parameters:
        value - The bytes for kind to set.
        Returns:
        This builder for chaining.
      • 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;
        Specified by:
        getName in interface StepOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.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;
        Specified by:
        getNameBytes in interface StepOrBuilder
        Returns:
        The bytes for name.
      • setName

        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;
        Parameters:
        value - The name to set.
        Returns:
        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:
        This builder for chaining.
      • setNameBytes

        public Step.Builder setNameBytes​(com.google.protobuf.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;
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.
      • 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;
        Specified by:
        hasProperties in interface StepOrBuilder
        Returns:
        Whether the properties field is set.
      • getProperties

        public com.google.protobuf.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;
        Specified by:
        getProperties in interface StepOrBuilder
        Returns:
        The properties.
      • setProperties

        public Step.Builder setProperties​(com.google.protobuf.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;
      • setProperties

        public Step.Builder setProperties​(com.google.protobuf.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;
      • mergeProperties

        public Step.Builder mergeProperties​(com.google.protobuf.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;
      • 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;
      • getPropertiesBuilder

        public com.google.protobuf.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;
      • getPropertiesOrBuilder

        public com.google.protobuf.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;
        Specified by:
        getPropertiesOrBuilder in interface StepOrBuilder
      • setUnknownFields

        public final Step.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Step.Builder>
      • mergeUnknownFields

        public final Step.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Step.Builder>