Class GatewayOuterClass.ActivateJobsRequest
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.camunda.zeebe.gateway.protocol.GatewayOuterClass.ActivateJobsRequest
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,GatewayOuterClass.ActivateJobsRequestOrBuilder,Serializable
- Enclosing class:
- GatewayOuterClass
public static final class GatewayOuterClass.ActivateJobsRequest
extends com.google.protobuf.GeneratedMessageV3
implements GatewayOuterClass.ActivateJobsRequestOrBuilder
Protobuf type
gateway_protocol.ActivateJobsRequest- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classProtobuf typegateway_protocol.ActivateJobsRequestNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic final com.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 requestcom.google.protobuf.Parser<GatewayOuterClass.ActivateJobsRequest>longThe request will be completed when at least one job is activated or after the requestTimeout (in ms).intgetTenantIds(int index) a list of IDs of tenants for which to activate jobscom.google.protobuf.ByteStringgetTenantIdsBytes(int index) a list of IDs of tenants for which to activate jobsinta list of IDs of tenants for which to activate jobscom.google.protobuf.ProtocolStringLista list of IDs of tenants for which to activate jobslonga 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 purposesinthashCode()protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleannewBuilder(GatewayOuterClass.ActivateJobsRequest prototype) newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) parseDelimitedFrom(InputStream input) parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(byte[] data) parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.ByteString data) parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.CodedInputStream input) parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(InputStream input) parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(ByteBuffer data) parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<GatewayOuterClass.ActivateJobsRequest>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER- See Also:
-
WORKER_FIELD_NUMBER
public static final int WORKER_FIELD_NUMBER- See Also:
-
TIMEOUT_FIELD_NUMBER
public static final int TIMEOUT_FIELD_NUMBER- See Also:
-
MAXJOBSTOACTIVATE_FIELD_NUMBER
public static final int MAXJOBSTOACTIVATE_FIELD_NUMBER- See Also:
-
FETCHVARIABLE_FIELD_NUMBER
public static final int FETCHVARIABLE_FIELD_NUMBER- See Also:
-
REQUESTTIMEOUT_FIELD_NUMBER
public static final int REQUESTTIMEOUT_FIELD_NUMBER- See Also:
-
TENANTIDS_FIELD_NUMBER
public static final int TENANTIDS_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
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
-
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.
-
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.
-
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.
-
getMaxJobsToActivate
public int getMaxJobsToActivate()the maximum jobs to activate by this request
int32 maxJobsToActivate = 4;- Specified by:
getMaxJobsToActivatein interfaceGatewayOuterClass.ActivateJobsRequestOrBuilder- Returns:
- The maxJobsToActivate.
-
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.
-
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.
-
getTenantIdsList
public com.google.protobuf.ProtocolStringList getTenantIdsList()a list of IDs of tenants for which to activate jobs
repeated string tenantIds = 7;- Specified by:
getTenantIdsListin interfaceGatewayOuterClass.ActivateJobsRequestOrBuilder- Returns:
- A list containing the tenantIds.
-
getTenantIdsCount
public int getTenantIdsCount()a list of IDs of tenants for which to activate jobs
repeated string tenantIds = 7;- Specified by:
getTenantIdsCountin interfaceGatewayOuterClass.ActivateJobsRequestOrBuilder- Returns:
- The count of tenantIds.
-
getTenantIds
a list of IDs of tenants for which to activate jobs
repeated string tenantIds = 7;- Specified by:
getTenantIdsin interfaceGatewayOuterClass.ActivateJobsRequestOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The tenantIds at the given index.
-
getTenantIdsBytes
public com.google.protobuf.ByteString getTenantIdsBytes(int index) a list of IDs of tenants for which to activate jobs
repeated string tenantIds = 7;- Specified by:
getTenantIdsBytesin interfaceGatewayOuterClass.ActivateJobsRequestOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the tenantIds at the given index.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static GatewayOuterClass.ActivateJobsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static GatewayOuterClass.ActivateJobsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static GatewayOuterClass.ActivateJobsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static GatewayOuterClass.ActivateJobsRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static GatewayOuterClass.ActivateJobsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static GatewayOuterClass.ActivateJobsRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static GatewayOuterClass.ActivateJobsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static GatewayOuterClass.ActivateJobsRequest parseDelimitedFrom(InputStream input) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static GatewayOuterClass.ActivateJobsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static GatewayOuterClass.ActivateJobsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static GatewayOuterClass.ActivateJobsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
public static GatewayOuterClass.ActivateJobsRequest.Builder newBuilder(GatewayOuterClass.ActivateJobsRequest prototype) -
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected GatewayOuterClass.ActivateJobsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-