Class GatewayOuterClass.ActivateJobsRequest.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderType>
com.google.protobuf.GeneratedMessageV3.Builder<GatewayOuterClass.ActivateJobsRequest.Builder>
io.camunda.zeebe.gateway.protocol.GatewayOuterClass.ActivateJobsRequest.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,GatewayOuterClass.ActivateJobsRequestOrBuilder,Cloneable
- Enclosing class:
- GatewayOuterClass.ActivateJobsRequest
public static final class GatewayOuterClass.ActivateJobsRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<GatewayOuterClass.ActivateJobsRequest.Builder>
implements GatewayOuterClass.ActivateJobsRequestOrBuilder
Protobuf type
gateway_protocol.ActivateJobsRequest-
Method Summary
Modifier and TypeMethodDescriptionaddAllFetchVariable(Iterable<String> values) a list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returnedaddFetchVariable(String value) a list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returnedaddFetchVariableBytes(com.google.protobuf.ByteString value) a list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returnedaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()clear()a list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returnedclearField(com.google.protobuf.Descriptors.FieldDescriptor field) the maximum jobs to activate by this requestclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) The request will be completed when at least one job is activated or after the requestTimeout (in ms).a job returned after this call will not be activated by another call until the timeout (in ms) has been reachedthe job type, as defined in the BPMN process (e.g.the name of the worker activating the jobs, mostly used for logging purposesclone()static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorgetFetchVariable(int index) a list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returnedcom.google.protobuf.ByteStringgetFetchVariableBytes(int index) a list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returnedinta list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returnedcom.google.protobuf.ProtocolStringLista list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returnedintthe maximum jobs to activate by this requestlongThe request will be completed when at least one job is activated or after the requestTimeout (in ms).longa job returned after this call will not be activated by another call until the timeout (in ms) has been reachedgetType()the job type, as defined in the BPMN process (e.g.com.google.protobuf.ByteStringthe job type, as defined in the BPMN process (e.g.the name of the worker activating the jobs, mostly used for logging purposescom.google.protobuf.ByteStringthe name of the worker activating the jobs, mostly used for logging purposesprotected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanmergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) setFetchVariable(int index, String value) a list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returnedsetMaxJobsToActivate(int value) the maximum jobs to activate by this requestsetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setRequestTimeout(long value) The request will be completed when at least one job is activated or after the requestTimeout (in ms).setTimeout(long value) a job returned after this call will not be activated by another call until the timeout (in ms) has been reachedthe job type, as defined in the BPMN process (e.g.setTypeBytes(com.google.protobuf.ByteString value) the job type, as defined in the BPMN process (e.g.setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) the name of the worker activating the jobs, mostly used for logging purposessetWorkerBytes(com.google.protobuf.ByteString value) the name of the worker activating the jobs, mostly used for logging purposesMethods 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, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<GatewayOuterClass.ActivateJobsRequest.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<GatewayOuterClass.ActivateJobsRequest.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<GatewayOuterClass.ActivateJobsRequest.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<GatewayOuterClass.ActivateJobsRequest.Builder>
-
setField
public GatewayOuterClass.ActivateJobsRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<GatewayOuterClass.ActivateJobsRequest.Builder>
-
clearField
public GatewayOuterClass.ActivateJobsRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field) - Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<GatewayOuterClass.ActivateJobsRequest.Builder>
-
clearOneof
public GatewayOuterClass.ActivateJobsRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) - Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<GatewayOuterClass.ActivateJobsRequest.Builder>
-
setRepeatedField
public GatewayOuterClass.ActivateJobsRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<GatewayOuterClass.ActivateJobsRequest.Builder>
-
addRepeatedField
public GatewayOuterClass.ActivateJobsRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<GatewayOuterClass.ActivateJobsRequest.Builder>
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<GatewayOuterClass.ActivateJobsRequest.Builder>
-
mergeFrom
public GatewayOuterClass.ActivateJobsRequest.Builder mergeFrom(GatewayOuterClass.ActivateJobsRequest other) -
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<GatewayOuterClass.ActivateJobsRequest.Builder>
-
mergeFrom
public GatewayOuterClass.ActivateJobsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<GatewayOuterClass.ActivateJobsRequest.Builder>- Throws:
IOException
-
getType
the job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition type="payment-service" />)
string type = 1;- Specified by:
getTypein interfaceGatewayOuterClass.ActivateJobsRequestOrBuilder- Returns:
- The type.
-
getTypeBytes
public com.google.protobuf.ByteString getTypeBytes()the job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition type="payment-service" />)
string type = 1;- Specified by:
getTypeBytesin interfaceGatewayOuterClass.ActivateJobsRequestOrBuilder- Returns:
- The bytes for type.
-
setType
the job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition type="payment-service" />)
string type = 1;- Parameters:
value- The type to set.- Returns:
- This builder for chaining.
-
clearType
the job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition type="payment-service" />)
string type = 1;- Returns:
- This builder for chaining.
-
setTypeBytes
public GatewayOuterClass.ActivateJobsRequest.Builder setTypeBytes(com.google.protobuf.ByteString value) the job type, as defined in the BPMN process (e.g. <zeebe:taskDefinition type="payment-service" />)
string type = 1;- Parameters:
value- The bytes for type to set.- Returns:
- This builder for chaining.
-
getWorker
the name of the worker activating the jobs, mostly used for logging purposes
string worker = 2;- Specified by:
getWorkerin interfaceGatewayOuterClass.ActivateJobsRequestOrBuilder- Returns:
- The worker.
-
getWorkerBytes
public com.google.protobuf.ByteString getWorkerBytes()the name of the worker activating the jobs, mostly used for logging purposes
string worker = 2;- Specified by:
getWorkerBytesin interfaceGatewayOuterClass.ActivateJobsRequestOrBuilder- Returns:
- The bytes for worker.
-
setWorker
the name of the worker activating the jobs, mostly used for logging purposes
string worker = 2;- Parameters:
value- The worker to set.- Returns:
- This builder for chaining.
-
clearWorker
the name of the worker activating the jobs, mostly used for logging purposes
string worker = 2;- Returns:
- This builder for chaining.
-
setWorkerBytes
public GatewayOuterClass.ActivateJobsRequest.Builder setWorkerBytes(com.google.protobuf.ByteString value) the name of the worker activating the jobs, mostly used for logging purposes
string worker = 2;- Parameters:
value- The bytes for worker to set.- Returns:
- This builder for chaining.
-
getTimeout
public long getTimeout()a job returned after this call will not be activated by another call until the timeout (in ms) has been reached
int64 timeout = 3;- Specified by:
getTimeoutin interfaceGatewayOuterClass.ActivateJobsRequestOrBuilder- Returns:
- The timeout.
-
setTimeout
a job returned after this call will not be activated by another call until the timeout (in ms) has been reached
int64 timeout = 3;- Parameters:
value- The timeout to set.- Returns:
- This builder for chaining.
-
clearTimeout
a job returned after this call will not be activated by another call until the timeout (in ms) has been reached
int64 timeout = 3;- Returns:
- This builder for chaining.
-
getMaxJobsToActivate
public int getMaxJobsToActivate()the maximum jobs to activate by this request
int32 maxJobsToActivate = 4;- Specified by:
getMaxJobsToActivatein interfaceGatewayOuterClass.ActivateJobsRequestOrBuilder- Returns:
- The maxJobsToActivate.
-
setMaxJobsToActivate
the maximum jobs to activate by this request
int32 maxJobsToActivate = 4;- Parameters:
value- The maxJobsToActivate to set.- Returns:
- This builder for chaining.
-
clearMaxJobsToActivate
the maximum jobs to activate by this request
int32 maxJobsToActivate = 4;- Returns:
- This builder for chaining.
-
getFetchVariableList
public com.google.protobuf.ProtocolStringList getFetchVariableList()a list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returned
repeated string fetchVariable = 5;- Specified by:
getFetchVariableListin interfaceGatewayOuterClass.ActivateJobsRequestOrBuilder- Returns:
- A list containing the fetchVariable.
-
getFetchVariableCount
public int getFetchVariableCount()a list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returned
repeated string fetchVariable = 5;- Specified by:
getFetchVariableCountin interfaceGatewayOuterClass.ActivateJobsRequestOrBuilder- Returns:
- The count of fetchVariable.
-
getFetchVariable
a list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returned
repeated string fetchVariable = 5;- Specified by:
getFetchVariablein interfaceGatewayOuterClass.ActivateJobsRequestOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The fetchVariable at the given index.
-
getFetchVariableBytes
public com.google.protobuf.ByteString getFetchVariableBytes(int index) a list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returned
repeated string fetchVariable = 5;- Specified by:
getFetchVariableBytesin interfaceGatewayOuterClass.ActivateJobsRequestOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the fetchVariable at the given index.
-
setFetchVariable
a list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returned
repeated string fetchVariable = 5;- Parameters:
index- The index to set the value at.value- The fetchVariable to set.- Returns:
- This builder for chaining.
-
addFetchVariable
a list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returned
repeated string fetchVariable = 5;- Parameters:
value- The fetchVariable to add.- Returns:
- This builder for chaining.
-
addAllFetchVariable
a list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returned
repeated string fetchVariable = 5;- Parameters:
values- The fetchVariable to add.- Returns:
- This builder for chaining.
-
clearFetchVariable
a list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returned
repeated string fetchVariable = 5;- Returns:
- This builder for chaining.
-
addFetchVariableBytes
public GatewayOuterClass.ActivateJobsRequest.Builder addFetchVariableBytes(com.google.protobuf.ByteString value) a list of variables to fetch as the job variables; if empty, all visible variables at the time of activation for the scope of the job will be returned
repeated string fetchVariable = 5;- Parameters:
value- The bytes of the fetchVariable to add.- Returns:
- This builder for chaining.
-
getRequestTimeout
public long getRequestTimeout()The request will be completed when at least one job is activated or after the requestTimeout (in ms). if the requestTimeout = 0, a default timeout is used. if the requestTimeout < 0, long polling is disabled and the request is completed immediately, even when no job is activated.
int64 requestTimeout = 6;- Specified by:
getRequestTimeoutin interfaceGatewayOuterClass.ActivateJobsRequestOrBuilder- Returns:
- The requestTimeout.
-
setRequestTimeout
The request will be completed when at least one job is activated or after the requestTimeout (in ms). if the requestTimeout = 0, a default timeout is used. if the requestTimeout < 0, long polling is disabled and the request is completed immediately, even when no job is activated.
int64 requestTimeout = 6;- Parameters:
value- The requestTimeout to set.- Returns:
- This builder for chaining.
-
clearRequestTimeout
The request will be completed when at least one job is activated or after the requestTimeout (in ms). if the requestTimeout = 0, a default timeout is used. if the requestTimeout < 0, long polling is disabled and the request is completed immediately, even when no job is activated.
int64 requestTimeout = 6;- Returns:
- This builder for chaining.
-
setUnknownFields
public final GatewayOuterClass.ActivateJobsRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<GatewayOuterClass.ActivateJobsRequest.Builder>
-
mergeUnknownFields
public final GatewayOuterClass.ActivateJobsRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<GatewayOuterClass.ActivateJobsRequest.Builder>
-