Class GatewayOuterClass.FailJobRequest.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<GatewayOuterClass.FailJobRequest.Builder>
io.camunda.zeebe.gateway.protocol.GatewayOuterClass.FailJobRequest.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,GatewayOuterClass.FailJobRequestOrBuilder,Cloneable
- Enclosing class:
- GatewayOuterClass.FailJobRequest
public static final class GatewayOuterClass.FailJobRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<GatewayOuterClass.FailJobRequest.Builder>
implements GatewayOuterClass.FailJobRequestOrBuilder
Protobuf type
gateway_protocol.FailJobRequest-
Method Summary
Modifier and TypeMethodDescriptionaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()clear()an optional message describing why the job failed this is particularly useful if a job runs out of retries and an incident is raised, as it this message can help explain why an incident was raisedclearField(com.google.protobuf.Descriptors.FieldDescriptor field) the unique job identifier, as obtained when activating the jobclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) the amount of retries the job should have leftthe backoff timeout (in ms) for the next retryJSON document that will instantiate the variables at the local scope of the job's associated task; it must be a JSON object, as variables will be mapped in a key-value fashion.clone()static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.Descriptoran optional message describing why the job failed this is particularly useful if a job runs out of retries and an incident is raised, as it this message can help explain why an incident was raisedcom.google.protobuf.ByteStringan optional message describing why the job failed this is particularly useful if a job runs out of retries and an incident is raised, as it this message can help explain why an incident was raisedlongthe unique job identifier, as obtained when activating the jobintthe amount of retries the job should have leftlongthe backoff timeout (in ms) for the next retryJSON document that will instantiate the variables at the local scope of the job's associated task; it must be a JSON object, as variables will be mapped in a key-value fashion.com.google.protobuf.ByteStringJSON document that will instantiate the variables at the local scope of the job's associated task; it must be a JSON object, as variables will be mapped in a key-value fashion.protected 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) setErrorMessage(String value) an optional message describing why the job failed this is particularly useful if a job runs out of retries and an incident is raised, as it this message can help explain why an incident was raisedsetErrorMessageBytes(com.google.protobuf.ByteString value) an optional message describing why the job failed this is particularly useful if a job runs out of retries and an incident is raised, as it this message can help explain why an incident was raisedsetJobKey(long value) the unique job identifier, as obtained when activating the jobsetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setRetries(int value) the amount of retries the job should have leftsetRetryBackOff(long value) the backoff timeout (in ms) for the next retrysetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) setVariables(String value) JSON document that will instantiate the variables at the local scope of the job's associated task; it must be a JSON object, as variables will be mapped in a key-value fashion.setVariablesBytes(com.google.protobuf.ByteString value) JSON document that will instantiate the variables at the local scope of the job's associated task; it must be a JSON object, as variables will be mapped in a key-value fashion.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, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods 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.FailJobRequest.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.FailJobRequest.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.FailJobRequest.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.FailJobRequest.Builder>
-
setField
public GatewayOuterClass.FailJobRequest.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.FailJobRequest.Builder>
-
clearField
public GatewayOuterClass.FailJobRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field) - Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<GatewayOuterClass.FailJobRequest.Builder>
-
clearOneof
public GatewayOuterClass.FailJobRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) - Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<GatewayOuterClass.FailJobRequest.Builder>
-
setRepeatedField
public GatewayOuterClass.FailJobRequest.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.FailJobRequest.Builder>
-
addRepeatedField
public GatewayOuterClass.FailJobRequest.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.FailJobRequest.Builder>
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<GatewayOuterClass.FailJobRequest.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<GatewayOuterClass.FailJobRequest.Builder>
-
mergeFrom
public GatewayOuterClass.FailJobRequest.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.FailJobRequest.Builder>- Throws:
IOException
-
getJobKey
public long getJobKey()the unique job identifier, as obtained when activating the job
int64 jobKey = 1;- Specified by:
getJobKeyin interfaceGatewayOuterClass.FailJobRequestOrBuilder- Returns:
- The jobKey.
-
setJobKey
the unique job identifier, as obtained when activating the job
int64 jobKey = 1;- Parameters:
value- The jobKey to set.- Returns:
- This builder for chaining.
-
clearJobKey
the unique job identifier, as obtained when activating the job
int64 jobKey = 1;- Returns:
- This builder for chaining.
-
getRetries
public int getRetries()the amount of retries the job should have left
int32 retries = 2;- Specified by:
getRetriesin interfaceGatewayOuterClass.FailJobRequestOrBuilder- Returns:
- The retries.
-
setRetries
the amount of retries the job should have left
int32 retries = 2;- Parameters:
value- The retries to set.- Returns:
- This builder for chaining.
-
clearRetries
the amount of retries the job should have left
int32 retries = 2;- Returns:
- This builder for chaining.
-
getErrorMessage
an optional message describing why the job failed this is particularly useful if a job runs out of retries and an incident is raised, as it this message can help explain why an incident was raised
string errorMessage = 3;- Specified by:
getErrorMessagein interfaceGatewayOuterClass.FailJobRequestOrBuilder- Returns:
- The errorMessage.
-
getErrorMessageBytes
public com.google.protobuf.ByteString getErrorMessageBytes()an optional message describing why the job failed this is particularly useful if a job runs out of retries and an incident is raised, as it this message can help explain why an incident was raised
string errorMessage = 3;- Specified by:
getErrorMessageBytesin interfaceGatewayOuterClass.FailJobRequestOrBuilder- Returns:
- The bytes for errorMessage.
-
setErrorMessage
an optional message describing why the job failed this is particularly useful if a job runs out of retries and an incident is raised, as it this message can help explain why an incident was raised
string errorMessage = 3;- Parameters:
value- The errorMessage to set.- Returns:
- This builder for chaining.
-
clearErrorMessage
an optional message describing why the job failed this is particularly useful if a job runs out of retries and an incident is raised, as it this message can help explain why an incident was raised
string errorMessage = 3;- Returns:
- This builder for chaining.
-
setErrorMessageBytes
public GatewayOuterClass.FailJobRequest.Builder setErrorMessageBytes(com.google.protobuf.ByteString value) an optional message describing why the job failed this is particularly useful if a job runs out of retries and an incident is raised, as it this message can help explain why an incident was raised
string errorMessage = 3;- Parameters:
value- The bytes for errorMessage to set.- Returns:
- This builder for chaining.
-
getRetryBackOff
public long getRetryBackOff()the backoff timeout (in ms) for the next retry
int64 retryBackOff = 4;- Specified by:
getRetryBackOffin interfaceGatewayOuterClass.FailJobRequestOrBuilder- Returns:
- The retryBackOff.
-
setRetryBackOff
the backoff timeout (in ms) for the next retry
int64 retryBackOff = 4;- Parameters:
value- The retryBackOff to set.- Returns:
- This builder for chaining.
-
clearRetryBackOff
the backoff timeout (in ms) for the next retry
int64 retryBackOff = 4;- Returns:
- This builder for chaining.
-
getVariables
JSON document that will instantiate the variables at the local scope of the job's associated task; it must be a JSON object, as variables will be mapped in a key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a valid argument, as the root of the JSON document is an array and not an object.string variables = 5;- Specified by:
getVariablesin interfaceGatewayOuterClass.FailJobRequestOrBuilder- Returns:
- The variables.
-
getVariablesBytes
public com.google.protobuf.ByteString getVariablesBytes()JSON document that will instantiate the variables at the local scope of the job's associated task; it must be a JSON object, as variables will be mapped in a key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a valid argument, as the root of the JSON document is an array and not an object.string variables = 5;- Specified by:
getVariablesBytesin interfaceGatewayOuterClass.FailJobRequestOrBuilder- Returns:
- The bytes for variables.
-
setVariables
JSON document that will instantiate the variables at the local scope of the job's associated task; it must be a JSON object, as variables will be mapped in a key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a valid argument, as the root of the JSON document is an array and not an object.string variables = 5;- Parameters:
value- The variables to set.- Returns:
- This builder for chaining.
-
clearVariables
JSON document that will instantiate the variables at the local scope of the job's associated task; it must be a JSON object, as variables will be mapped in a key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a valid argument, as the root of the JSON document is an array and not an object.string variables = 5;- Returns:
- This builder for chaining.
-
setVariablesBytes
public GatewayOuterClass.FailJobRequest.Builder setVariablesBytes(com.google.protobuf.ByteString value) JSON document that will instantiate the variables at the local scope of the job's associated task; it must be a JSON object, as variables will be mapped in a key-value fashion. e.g. { "a": 1, "b": 2 } will create two variables, named "a" and "b" respectively, with their associated values. [{ "a": 1, "b": 2 }] would not be a valid argument, as the root of the JSON document is an array and not an object.string variables = 5;- Parameters:
value- The bytes for variables to set.- Returns:
- This builder for chaining.
-
setUnknownFields
public final GatewayOuterClass.FailJobRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<GatewayOuterClass.FailJobRequest.Builder>
-
mergeUnknownFields
public final GatewayOuterClass.FailJobRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<GatewayOuterClass.FailJobRequest.Builder>
-