Package io.dapr.v1
Class DaprProtos.Job
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.dapr.v1.DaprProtos.Job
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,DaprProtos.JobOrBuilder,Serializable
- Enclosing class:
- DaprProtos
public static final class DaprProtos.Job
extends com.google.protobuf.GeneratedMessageV3
implements DaprProtos.JobOrBuilder
Job is the definition of a job. At least one of schedule or due_time must be provided but can also be provided together.Protobuf type
dapr.proto.runtime.v1.Job- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classJob is the definition of a job.Nested 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 TypeMethodDescriptionbooleancom.google.protobuf.AnygetData()payload is the serialized job payload that will be sent to the recipient when the job is triggered.com.google.protobuf.AnyOrBuilderpayload is the serialized job payload that will be sent to the recipient when the job is triggered.static DaprProtos.Jobstatic final com.google.protobuf.Descriptors.Descriptordue_time is the optional time at which the job should be active, or the "one shot" time if other scheduling type fields are not provided.com.google.protobuf.ByteStringdue_time is the optional time at which the job should be active, or the "one shot" time if other scheduling type fields are not provided.failure_policy is the optional policy for handling job failures.failure_policy is the optional policy for handling job failures.getName()The unique name for the job.com.google.protobuf.ByteStringThe unique name for the job.com.google.protobuf.Parser<DaprProtos.Job>intrepeats is the optional number of times in which the job should be triggered.schedule is an optional schedule at which the job is to be run.com.google.protobuf.ByteStringschedule is an optional schedule at which the job is to be run.intgetTtl()ttl is the optional time to live or expiration of the job.com.google.protobuf.ByteStringttl is the optional time to live or expiration of the job.booleanhasData()payload is the serialized job payload that will be sent to the recipient when the job is triggered.booleandue_time is the optional time at which the job should be active, or the "one shot" time if other scheduling type fields are not provided.booleanfailure_policy is the optional policy for handling job failures.inthashCode()booleanrepeats is the optional number of times in which the job should be triggered.booleanschedule is an optional schedule at which the job is to be run.booleanhasTtl()ttl is the optional time to live or expiration of the job.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanstatic DaprProtos.Job.Builderstatic DaprProtos.Job.BuildernewBuilder(DaprProtos.Job prototype) protected DaprProtos.Job.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static DaprProtos.JobparseDelimitedFrom(InputStream input) static DaprProtos.JobparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static DaprProtos.JobparseFrom(byte[] data) static DaprProtos.JobparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static DaprProtos.JobparseFrom(com.google.protobuf.ByteString data) static DaprProtos.JobparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static DaprProtos.JobparseFrom(com.google.protobuf.CodedInputStream input) static DaprProtos.JobparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static DaprProtos.JobparseFrom(InputStream input) static DaprProtos.JobparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static DaprProtos.JobparseFrom(ByteBuffer data) static DaprProtos.JobparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<DaprProtos.Job>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, internalGetMapFieldReflection, 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
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
SCHEDULE_FIELD_NUMBER
public static final int SCHEDULE_FIELD_NUMBER- See Also:
-
REPEATS_FIELD_NUMBER
public static final int REPEATS_FIELD_NUMBER- See Also:
-
DUE_TIME_FIELD_NUMBER
public static final int DUE_TIME_FIELD_NUMBER- See Also:
-
TTL_FIELD_NUMBER
public static final int TTL_FIELD_NUMBER- See Also:
-
DATA_FIELD_NUMBER
public static final int DATA_FIELD_NUMBER- See Also:
-
FAILURE_POLICY_FIELD_NUMBER
public static final int FAILURE_POLICY_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
-
getName
The unique name for the job.
string name = 1 [json_name = "name"];- Specified by:
getNamein interfaceDaprProtos.JobOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()The unique name for the job.
string name = 1 [json_name = "name"];- Specified by:
getNameBytesin interfaceDaprProtos.JobOrBuilder- Returns:
- The bytes for name.
-
hasSchedule
public boolean hasSchedule()schedule is an optional schedule at which the job is to be run. Accepts both systemd timer style cron expressions, as well as human readable '@' prefixed period strings as defined below. Systemd timer style cron accepts 6 fields: seconds | minutes | hours | day of month | month | day of week 0-59 | 0-59 | 0-23 | 1-31 | 1-12/jan-dec | 0-6/sun-sat "0 30 * * * *" - every hour on the half hour "0 15 3 * * *" - every day at 03:15 Period string expressions: Entry | Description | Equivalent To ----- | ----------- | ------------- @every `<duration>` | Run every `<duration>` (e.g. '@every 1h30m') | N/A @yearly (or @annually) | Run once a year, midnight, Jan. 1st | 0 0 0 1 1 * @monthly | Run once a month, midnight, first of month | 0 0 0 1 * * @weekly | Run once a week, midnight on Sunday | 0 0 0 * * 0 @daily (or @midnight) | Run once a day, midnight | 0 0 0 * * * @hourly | Run once an hour, beginning of hour | 0 0 * * * *
optional string schedule = 2 [json_name = "schedule"];- Specified by:
hasSchedulein interfaceDaprProtos.JobOrBuilder- Returns:
- Whether the schedule field is set.
-
getSchedule
schedule is an optional schedule at which the job is to be run. Accepts both systemd timer style cron expressions, as well as human readable '@' prefixed period strings as defined below. Systemd timer style cron accepts 6 fields: seconds | minutes | hours | day of month | month | day of week 0-59 | 0-59 | 0-23 | 1-31 | 1-12/jan-dec | 0-6/sun-sat "0 30 * * * *" - every hour on the half hour "0 15 3 * * *" - every day at 03:15 Period string expressions: Entry | Description | Equivalent To ----- | ----------- | ------------- @every `<duration>` | Run every `<duration>` (e.g. '@every 1h30m') | N/A @yearly (or @annually) | Run once a year, midnight, Jan. 1st | 0 0 0 1 1 * @monthly | Run once a month, midnight, first of month | 0 0 0 1 * * @weekly | Run once a week, midnight on Sunday | 0 0 0 * * 0 @daily (or @midnight) | Run once a day, midnight | 0 0 0 * * * @hourly | Run once an hour, beginning of hour | 0 0 * * * *
optional string schedule = 2 [json_name = "schedule"];- Specified by:
getSchedulein interfaceDaprProtos.JobOrBuilder- Returns:
- The schedule.
-
getScheduleBytes
public com.google.protobuf.ByteString getScheduleBytes()schedule is an optional schedule at which the job is to be run. Accepts both systemd timer style cron expressions, as well as human readable '@' prefixed period strings as defined below. Systemd timer style cron accepts 6 fields: seconds | minutes | hours | day of month | month | day of week 0-59 | 0-59 | 0-23 | 1-31 | 1-12/jan-dec | 0-6/sun-sat "0 30 * * * *" - every hour on the half hour "0 15 3 * * *" - every day at 03:15 Period string expressions: Entry | Description | Equivalent To ----- | ----------- | ------------- @every `<duration>` | Run every `<duration>` (e.g. '@every 1h30m') | N/A @yearly (or @annually) | Run once a year, midnight, Jan. 1st | 0 0 0 1 1 * @monthly | Run once a month, midnight, first of month | 0 0 0 1 * * @weekly | Run once a week, midnight on Sunday | 0 0 0 * * 0 @daily (or @midnight) | Run once a day, midnight | 0 0 0 * * * @hourly | Run once an hour, beginning of hour | 0 0 * * * *
optional string schedule = 2 [json_name = "schedule"];- Specified by:
getScheduleBytesin interfaceDaprProtos.JobOrBuilder- Returns:
- The bytes for schedule.
-
hasRepeats
public boolean hasRepeats()repeats is the optional number of times in which the job should be triggered. If not set, the job will run indefinitely or until expiration.
optional uint32 repeats = 3 [json_name = "repeats"];- Specified by:
hasRepeatsin interfaceDaprProtos.JobOrBuilder- Returns:
- Whether the repeats field is set.
-
getRepeats
public int getRepeats()repeats is the optional number of times in which the job should be triggered. If not set, the job will run indefinitely or until expiration.
optional uint32 repeats = 3 [json_name = "repeats"];- Specified by:
getRepeatsin interfaceDaprProtos.JobOrBuilder- Returns:
- The repeats.
-
hasDueTime
public boolean hasDueTime()due_time is the optional time at which the job should be active, or the "one shot" time if other scheduling type fields are not provided. Accepts a "point in time" string in the format of RFC3339, Go duration string (calculated from job creation time), or non-repeating ISO8601.
optional string due_time = 4 [json_name = "dueTime"];- Specified by:
hasDueTimein interfaceDaprProtos.JobOrBuilder- Returns:
- Whether the dueTime field is set.
-
getDueTime
due_time is the optional time at which the job should be active, or the "one shot" time if other scheduling type fields are not provided. Accepts a "point in time" string in the format of RFC3339, Go duration string (calculated from job creation time), or non-repeating ISO8601.
optional string due_time = 4 [json_name = "dueTime"];- Specified by:
getDueTimein interfaceDaprProtos.JobOrBuilder- Returns:
- The dueTime.
-
getDueTimeBytes
public com.google.protobuf.ByteString getDueTimeBytes()due_time is the optional time at which the job should be active, or the "one shot" time if other scheduling type fields are not provided. Accepts a "point in time" string in the format of RFC3339, Go duration string (calculated from job creation time), or non-repeating ISO8601.
optional string due_time = 4 [json_name = "dueTime"];- Specified by:
getDueTimeBytesin interfaceDaprProtos.JobOrBuilder- Returns:
- The bytes for dueTime.
-
hasTtl
public boolean hasTtl()ttl is the optional time to live or expiration of the job. Accepts a "point in time" string in the format of RFC3339, Go duration string (calculated from job creation time), or non-repeating ISO8601.
optional string ttl = 5 [json_name = "ttl"];- Specified by:
hasTtlin interfaceDaprProtos.JobOrBuilder- Returns:
- Whether the ttl field is set.
-
getTtl
ttl is the optional time to live or expiration of the job. Accepts a "point in time" string in the format of RFC3339, Go duration string (calculated from job creation time), or non-repeating ISO8601.
optional string ttl = 5 [json_name = "ttl"];- Specified by:
getTtlin interfaceDaprProtos.JobOrBuilder- Returns:
- The ttl.
-
getTtlBytes
public com.google.protobuf.ByteString getTtlBytes()ttl is the optional time to live or expiration of the job. Accepts a "point in time" string in the format of RFC3339, Go duration string (calculated from job creation time), or non-repeating ISO8601.
optional string ttl = 5 [json_name = "ttl"];- Specified by:
getTtlBytesin interfaceDaprProtos.JobOrBuilder- Returns:
- The bytes for ttl.
-
hasData
public boolean hasData()payload is the serialized job payload that will be sent to the recipient when the job is triggered.
.google.protobuf.Any data = 6 [json_name = "data"];- Specified by:
hasDatain interfaceDaprProtos.JobOrBuilder- Returns:
- Whether the data field is set.
-
getData
public com.google.protobuf.Any getData()payload is the serialized job payload that will be sent to the recipient when the job is triggered.
.google.protobuf.Any data = 6 [json_name = "data"];- Specified by:
getDatain interfaceDaprProtos.JobOrBuilder- Returns:
- The data.
-
getDataOrBuilder
public com.google.protobuf.AnyOrBuilder getDataOrBuilder()payload is the serialized job payload that will be sent to the recipient when the job is triggered.
.google.protobuf.Any data = 6 [json_name = "data"];- Specified by:
getDataOrBuilderin interfaceDaprProtos.JobOrBuilder
-
hasFailurePolicy
public boolean hasFailurePolicy()failure_policy is the optional policy for handling job failures.
optional .dapr.proto.common.v1.JobFailurePolicy failure_policy = 7 [json_name = "failurePolicy"];- Specified by:
hasFailurePolicyin interfaceDaprProtos.JobOrBuilder- Returns:
- Whether the failurePolicy field is set.
-
getFailurePolicy
failure_policy is the optional policy for handling job failures.
optional .dapr.proto.common.v1.JobFailurePolicy failure_policy = 7 [json_name = "failurePolicy"];- Specified by:
getFailurePolicyin interfaceDaprProtos.JobOrBuilder- Returns:
- The failurePolicy.
-
getFailurePolicyOrBuilder
failure_policy is the optional policy for handling job failures.
optional .dapr.proto.common.v1.JobFailurePolicy failure_policy = 7 [json_name = "failurePolicy"];- Specified by:
getFailurePolicyOrBuilderin interfaceDaprProtos.JobOrBuilder
-
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 DaprProtos.Job parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static DaprProtos.Job parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static DaprProtos.Job parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static DaprProtos.Job parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static DaprProtos.Job parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static DaprProtos.Job parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static DaprProtos.Job parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static DaprProtos.Job parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static DaprProtos.Job parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static DaprProtos.Job 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
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected DaprProtos.Job.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
-