JobApi.RunJobRequest.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.RunJobRequest.Builder>
    - - org.apache.beam.sdk.common.runner.v1.JobApi.RunJobRequest.Builder

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

Enclosing class:: JobApi.RunJobRequest

public static final class JobApi.RunJobRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<JobApi.RunJobRequest.Builder>
implements JobApi.RunJobRequestOrBuilder

 Run is a synchronous request that returns a jobId back.
 Throws error GRPC_STATUS_UNAVAILABLE if server is down
 Throws error NOT_FOUND if the preparation ID does not exist
 Throws error UNKNOWN for all other issues

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JobApi.RunJobRequest.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`JobApi.RunJobRequest`	`build()`
`JobApi.RunJobRequest`	`buildPartial()`
`JobApi.RunJobRequest.Builder`	`clear()`
`JobApi.RunJobRequest.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`JobApi.RunJobRequest.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`JobApi.RunJobRequest.Builder`	`clearPreparationId()` (required) The ID provided by an earlier call to prepare.
`JobApi.RunJobRequest.Builder`	`clearStagingToken()` (optional) If any artifacts have been staged for this job, contains the staging_token returned from the CommitManifestResponse.
`JobApi.RunJobRequest.Builder`	`clone()`
`JobApi.RunJobRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getPreparationId()` (required) The ID provided by an earlier call to prepare.
`com.google.protobuf.ByteString`	`getPreparationIdBytes()` (required) The ID provided by an earlier call to prepare.
`String`	`getStagingToken()` (optional) If any artifacts have been staged for this job, contains the staging_token returned from the CommitManifestResponse.
`com.google.protobuf.ByteString`	`getStagingTokenBytes()` (optional) If any artifacts have been staged for this job, contains the staging_token returned from the CommitManifestResponse.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`JobApi.RunJobRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`JobApi.RunJobRequest.Builder`	`mergeFrom(JobApi.RunJobRequest other)`
`JobApi.RunJobRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`JobApi.RunJobRequest.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`JobApi.RunJobRequest.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`JobApi.RunJobRequest.Builder`	`setPreparationId(String value)` (required) The ID provided by an earlier call to prepare.
`JobApi.RunJobRequest.Builder`	`setPreparationIdBytes(com.google.protobuf.ByteString value)` (required) The ID provided by an earlier call to prepare.
`JobApi.RunJobRequest.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`JobApi.RunJobRequest.Builder`	`setStagingToken(String value)` (optional) If any artifacts have been staged for this job, contains the staging_token returned from the CommitManifestResponse.
`JobApi.RunJobRequest.Builder`	`setStagingTokenBytes(com.google.protobuf.ByteString value)` (optional) If any artifacts have been staged for this job, contains the staging_token returned from the CommitManifestResponse.
`JobApi.RunJobRequest.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.RunJobRequest.Builder>
  - clear
```
public JobApi.RunJobRequest.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.RunJobRequest.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.RunJobRequest.Builder>
  - getDefaultInstanceForType
```
public JobApi.RunJobRequest getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public JobApi.RunJobRequest build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public JobApi.RunJobRequest buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public JobApi.RunJobRequest.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.RunJobRequest.Builder>
  - setField
```
public JobApi.RunJobRequest.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.RunJobRequest.Builder>
  - clearField
```
public JobApi.RunJobRequest.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.RunJobRequest.Builder>
  - clearOneof
```
public JobApi.RunJobRequest.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.RunJobRequest.Builder>
  - setRepeatedField
```
public JobApi.RunJobRequest.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.RunJobRequest.Builder>
  - addRepeatedField
```
public JobApi.RunJobRequest.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.RunJobRequest.Builder>
  - mergeFrom
```
public JobApi.RunJobRequest.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.RunJobRequest.Builder>
  - mergeFrom
```
public JobApi.RunJobRequest.Builder mergeFrom(JobApi.RunJobRequest 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.RunJobRequest.Builder>
  - mergeFrom
```
public JobApi.RunJobRequest.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.RunJobRequest.Builder>
    
    Throws:
    
    IOException
  - getPreparationId
```
public String getPreparationId()
```
```
 (required) The ID provided by an earlier call to prepare. Runs the job. All prerequisite tasks
 must have been completed.
 
```
    string preparation_id = 1;
    Specified by:
    
    getPreparationId in interface JobApi.RunJobRequestOrBuilder
  - getPreparationIdBytes
```
public com.google.protobuf.ByteString getPreparationIdBytes()
```
```
 (required) The ID provided by an earlier call to prepare. Runs the job. All prerequisite tasks
 must have been completed.
 
```
    string preparation_id = 1;
    Specified by:
    
    getPreparationIdBytes in interface JobApi.RunJobRequestOrBuilder
  - setPreparationId
```
public JobApi.RunJobRequest.Builder setPreparationId(String value)
```
```
 (required) The ID provided by an earlier call to prepare. Runs the job. All prerequisite tasks
 must have been completed.
 
```
    string preparation_id = 1;
  - clearPreparationId
```
public JobApi.RunJobRequest.Builder clearPreparationId()
```
```
 (required) The ID provided by an earlier call to prepare. Runs the job. All prerequisite tasks
 must have been completed.
 
```
    string preparation_id = 1;
  - setPreparationIdBytes
```
public JobApi.RunJobRequest.Builder setPreparationIdBytes(com.google.protobuf.ByteString value)
```
```
 (required) The ID provided by an earlier call to prepare. Runs the job. All prerequisite tasks
 must have been completed.
 
```
    string preparation_id = 1;
  - getStagingToken
```
public String getStagingToken()
```
```
 (optional) If any artifacts have been staged for this job, contains the staging_token returned
 from the CommitManifestResponse.
 
```
    string staging_token = 2;
    Specified by:
    
    getStagingToken in interface JobApi.RunJobRequestOrBuilder
  - getStagingTokenBytes
```
public com.google.protobuf.ByteString getStagingTokenBytes()
```
```
 (optional) If any artifacts have been staged for this job, contains the staging_token returned
 from the CommitManifestResponse.
 
```
    string staging_token = 2;
    Specified by:
    
    getStagingTokenBytes in interface JobApi.RunJobRequestOrBuilder
  - setStagingToken
```
public JobApi.RunJobRequest.Builder setStagingToken(String value)
```
```
 (optional) If any artifacts have been staged for this job, contains the staging_token returned
 from the CommitManifestResponse.
 
```
    string staging_token = 2;
  - clearStagingToken
```
public JobApi.RunJobRequest.Builder clearStagingToken()
```
```
 (optional) If any artifacts have been staged for this job, contains the staging_token returned
 from the CommitManifestResponse.
 
```
    string staging_token = 2;
  - setStagingTokenBytes
```
public JobApi.RunJobRequest.Builder setStagingTokenBytes(com.google.protobuf.ByteString value)
```
```
 (optional) If any artifacts have been staged for this job, contains the staging_token returned
 from the CommitManifestResponse.
 
```
    string staging_token = 2;
  - setUnknownFields
```
public final JobApi.RunJobRequest.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.RunJobRequest.Builder>
  - mergeUnknownFields
```
public final JobApi.RunJobRequest.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.RunJobRequest.Builder>

Class JobApi.RunJobRequest.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

getPreparationId

getPreparationIdBytes

setPreparationId

clearPreparationId

setPreparationIdBytes

getStagingToken

getStagingTokenBytes

setStagingToken

clearStagingToken

setStagingTokenBytes

setUnknownFields

mergeUnknownFields