JobApi.PrepareJobRequest.Builder (Apache Beam SDK for Java, version 2.2.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<JobApi.PrepareJobRequest.Builder>
    - - org.apache.beam.sdk.common.runner.v1.JobApi.PrepareJobRequest.Builder

All Implemented Interfaces:: com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, JobApi.PrepareJobRequestOrBuilder

Enclosing class:: JobApi.PrepareJobRequest

public static final class JobApi.PrepareJobRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<JobApi.PrepareJobRequest.Builder>
implements JobApi.PrepareJobRequestOrBuilder

 Prepare is a synchronous request that returns a preparationId back
 Throws error GRPC_STATUS_UNAVAILABLE if server is down
 Throws error ALREADY_EXISTS if the jobName is reused. Runners are permitted to deduplicate based on the name of the job.
 Throws error UNKNOWN for all other issues

Protobuf type org.apache.beam.runner_api.v1.PrepareJobRequest

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JobApi.PrepareJobRequest.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`JobApi.PrepareJobRequest`	`build()`
`JobApi.PrepareJobRequest`	`buildPartial()`
`JobApi.PrepareJobRequest.Builder`	`clear()`
`JobApi.PrepareJobRequest.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`JobApi.PrepareJobRequest.Builder`	`clearJobName()` (required)
`JobApi.PrepareJobRequest.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`JobApi.PrepareJobRequest.Builder`	`clearPipeline()` (required)
`JobApi.PrepareJobRequest.Builder`	`clearPipelineOptions()` (required)
`JobApi.PrepareJobRequest.Builder`	`clone()`
`JobApi.PrepareJobRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getJobName()` (required)
`com.google.protobuf.ByteString`	`getJobNameBytes()` (required)
`RunnerApi.Pipeline`	`getPipeline()` (required)
`RunnerApi.Pipeline.Builder`	`getPipelineBuilder()` (required)
`com.google.protobuf.Struct`	`getPipelineOptions()` (required)
`com.google.protobuf.Struct.Builder`	`getPipelineOptionsBuilder()` (required)
`com.google.protobuf.StructOrBuilder`	`getPipelineOptionsOrBuilder()` (required)
`RunnerApi.PipelineOrBuilder`	`getPipelineOrBuilder()` (required)
`boolean`	`hasPipeline()` (required)
`boolean`	`hasPipelineOptions()` (required)
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`JobApi.PrepareJobRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`JobApi.PrepareJobRequest.Builder`	`mergeFrom(JobApi.PrepareJobRequest other)`
`JobApi.PrepareJobRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`JobApi.PrepareJobRequest.Builder`	`mergePipeline(RunnerApi.Pipeline value)` (required)
`JobApi.PrepareJobRequest.Builder`	`mergePipelineOptions(com.google.protobuf.Struct value)` (required)
`JobApi.PrepareJobRequest.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`JobApi.PrepareJobRequest.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`JobApi.PrepareJobRequest.Builder`	`setJobName(String value)` (required)
`JobApi.PrepareJobRequest.Builder`	`setJobNameBytes(com.google.protobuf.ByteString value)` (required)
`JobApi.PrepareJobRequest.Builder`	`setPipeline(RunnerApi.Pipeline.Builder builderForValue)` (required)
`JobApi.PrepareJobRequest.Builder`	`setPipeline(RunnerApi.Pipeline value)` (required)
`JobApi.PrepareJobRequest.Builder`	`setPipelineOptions(com.google.protobuf.Struct.Builder builderForValue)` (required)
`JobApi.PrepareJobRequest.Builder`	`setPipelineOptions(com.google.protobuf.Struct value)` (required)
`JobApi.PrepareJobRequest.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`JobApi.PrepareJobRequest.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, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, parseUnknownField

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

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- 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<JobApi.PrepareJobRequest.Builder>
  - clear
```
public JobApi.PrepareJobRequest.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<JobApi.PrepareJobRequest.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<JobApi.PrepareJobRequest.Builder>
  - getDefaultInstanceForType
```
public JobApi.PrepareJobRequest getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public JobApi.PrepareJobRequest build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public JobApi.PrepareJobRequest buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public JobApi.PrepareJobRequest.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<JobApi.PrepareJobRequest.Builder>
  - setField
```
public JobApi.PrepareJobRequest.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<JobApi.PrepareJobRequest.Builder>
  - clearField
```
public JobApi.PrepareJobRequest.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<JobApi.PrepareJobRequest.Builder>
  - clearOneof
```
public JobApi.PrepareJobRequest.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<JobApi.PrepareJobRequest.Builder>
  - setRepeatedField
```
public JobApi.PrepareJobRequest.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<JobApi.PrepareJobRequest.Builder>
  - addRepeatedField
```
public JobApi.PrepareJobRequest.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<JobApi.PrepareJobRequest.Builder>
  - mergeFrom
```
public JobApi.PrepareJobRequest.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<JobApi.PrepareJobRequest.Builder>
  - mergeFrom
```
public JobApi.PrepareJobRequest.Builder mergeFrom(JobApi.PrepareJobRequest other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<JobApi.PrepareJobRequest.Builder>
  - mergeFrom
```
public JobApi.PrepareJobRequest.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<JobApi.PrepareJobRequest.Builder>
    
    Throws:
    
    IOException
  - hasPipeline
```
public boolean hasPipeline()
```
```
 (required)
 
```
    .org.apache.beam.runner_api.v1.Pipeline pipeline = 1;
    Specified by:
    
    hasPipeline in interface JobApi.PrepareJobRequestOrBuilder
  - getPipeline
```
public RunnerApi.Pipeline getPipeline()
```
```
 (required)
 
```
    .org.apache.beam.runner_api.v1.Pipeline pipeline = 1;
    Specified by:
    
    getPipeline in interface JobApi.PrepareJobRequestOrBuilder
  - setPipeline
```
public JobApi.PrepareJobRequest.Builder setPipeline(RunnerApi.Pipeline value)
```
```
 (required)
 
```
    .org.apache.beam.runner_api.v1.Pipeline pipeline = 1;
  - setPipeline
```
public JobApi.PrepareJobRequest.Builder setPipeline(RunnerApi.Pipeline.Builder builderForValue)
```
```
 (required)
 
```
    .org.apache.beam.runner_api.v1.Pipeline pipeline = 1;
  - mergePipeline
```
public JobApi.PrepareJobRequest.Builder mergePipeline(RunnerApi.Pipeline value)
```
```
 (required)
 
```
    .org.apache.beam.runner_api.v1.Pipeline pipeline = 1;
  - clearPipeline
```
public JobApi.PrepareJobRequest.Builder clearPipeline()
```
```
 (required)
 
```
    .org.apache.beam.runner_api.v1.Pipeline pipeline = 1;
  - getPipelineBuilder
```
public RunnerApi.Pipeline.Builder getPipelineBuilder()
```
```
 (required)
 
```
    .org.apache.beam.runner_api.v1.Pipeline pipeline = 1;
  - getPipelineOrBuilder
```
public RunnerApi.PipelineOrBuilder getPipelineOrBuilder()
```
```
 (required)
 
```
    .org.apache.beam.runner_api.v1.Pipeline pipeline = 1;
    Specified by:
    
    getPipelineOrBuilder in interface JobApi.PrepareJobRequestOrBuilder
  - hasPipelineOptions
```
public boolean hasPipelineOptions()
```
```
 (required)
 
```
    .google.protobuf.Struct pipeline_options = 2;
    Specified by:
    
    hasPipelineOptions in interface JobApi.PrepareJobRequestOrBuilder
  - getPipelineOptions
```
public com.google.protobuf.Struct getPipelineOptions()
```
```
 (required)
 
```
    .google.protobuf.Struct pipeline_options = 2;
    Specified by:
    
    getPipelineOptions in interface JobApi.PrepareJobRequestOrBuilder
  - setPipelineOptions
```
public JobApi.PrepareJobRequest.Builder setPipelineOptions(com.google.protobuf.Struct value)
```
```
 (required)
 
```
    .google.protobuf.Struct pipeline_options = 2;
  - setPipelineOptions
```
public JobApi.PrepareJobRequest.Builder setPipelineOptions(com.google.protobuf.Struct.Builder builderForValue)
```
```
 (required)
 
```
    .google.protobuf.Struct pipeline_options = 2;
  - mergePipelineOptions
```
public JobApi.PrepareJobRequest.Builder mergePipelineOptions(com.google.protobuf.Struct value)
```
```
 (required)
 
```
    .google.protobuf.Struct pipeline_options = 2;
  - clearPipelineOptions
```
public JobApi.PrepareJobRequest.Builder clearPipelineOptions()
```
```
 (required)
 
```
    .google.protobuf.Struct pipeline_options = 2;
  - getPipelineOptionsBuilder
```
public com.google.protobuf.Struct.Builder getPipelineOptionsBuilder()
```
```
 (required)
 
```
    .google.protobuf.Struct pipeline_options = 2;
  - getPipelineOptionsOrBuilder
```
public com.google.protobuf.StructOrBuilder getPipelineOptionsOrBuilder()
```
```
 (required)
 
```
    .google.protobuf.Struct pipeline_options = 2;
    Specified by:
    
    getPipelineOptionsOrBuilder in interface JobApi.PrepareJobRequestOrBuilder
  - getJobName
```
public String getJobName()
```
```
 (required)
 
```
    string job_name = 3;
    Specified by:
    
    getJobName in interface JobApi.PrepareJobRequestOrBuilder
  - getJobNameBytes
```
public com.google.protobuf.ByteString getJobNameBytes()
```
```
 (required)
 
```
    string job_name = 3;
    Specified by:
    
    getJobNameBytes in interface JobApi.PrepareJobRequestOrBuilder
  - setJobName
```
public JobApi.PrepareJobRequest.Builder setJobName(String value)
```
```
 (required)
 
```
    string job_name = 3;
  - clearJobName
```
public JobApi.PrepareJobRequest.Builder clearJobName()
```
```
 (required)
 
```
    string job_name = 3;
  - setJobNameBytes
```
public JobApi.PrepareJobRequest.Builder setJobNameBytes(com.google.protobuf.ByteString value)
```
```
 (required)
 
```
    string job_name = 3;
  - setUnknownFields
```
public final JobApi.PrepareJobRequest.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<JobApi.PrepareJobRequest.Builder>
  - mergeUnknownFields
```
public final JobApi.PrepareJobRequest.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<JobApi.PrepareJobRequest.Builder>

Class JobApi.PrepareJobRequest.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

hasPipeline

getPipeline

setPipeline

setPipeline

mergePipeline

clearPipeline

getPipelineBuilder

getPipelineOrBuilder

hasPipelineOptions

getPipelineOptions

setPipelineOptions

setPipelineOptions

mergePipelineOptions

clearPipelineOptions

getPipelineOptionsBuilder

getPipelineOptionsOrBuilder

getJobName

getJobNameBytes

setJobName

clearJobName

setJobNameBytes

setUnknownFields

mergeUnknownFields