Package io.temporal.api.workflowservice.v1

Interface StartActivityExecutionRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    StartActivityExecutionRequest, StartActivityExecutionRequest.Builder
    @Generated(value="protoc",
           comments="annotations:StartActivityExecutionRequestOrBuilder.java.pb.meta")
public interface StartActivityExecutionRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getNamespace

        java.lang.String getNamespace()
        string namespace = 1;
        Returns:
        The namespace.

      • getNamespaceBytes

        com.google.protobuf.ByteString getNamespaceBytes()
        string namespace = 1;
        Returns:
        The bytes for namespace.

      • getIdentity

        java.lang.String getIdentity()
         The identity of the client who initiated this request
        string identity = 2;
        Returns:
        The identity.

      • getIdentityBytes

        com.google.protobuf.ByteString getIdentityBytes()
         The identity of the client who initiated this request
        string identity = 2;
        Returns:
        The bytes for identity.

      • getRequestId

        java.lang.String getRequestId()
         A unique identifier for this start request. Typically UUIDv4.
        string request_id = 3;
        Returns:
        The requestId.

      • getRequestIdBytes

        com.google.protobuf.ByteString getRequestIdBytes()
         A unique identifier for this start request. Typically UUIDv4.
        string request_id = 3;
        Returns:
        The bytes for requestId.

      • getActivityId

        java.lang.String getActivityId()
         Identifier for this activity. Required. This identifier should be meaningful in the user's
 own system. It must be unique among activities in the same namespace, subject to the rules
 imposed by id_reuse_policy and id_conflict_policy.
        string activity_id = 4;
        Returns:
        The activityId.

      • getActivityIdBytes

        com.google.protobuf.ByteString getActivityIdBytes()
         Identifier for this activity. Required. This identifier should be meaningful in the user's
 own system. It must be unique among activities in the same namespace, subject to the rules
 imposed by id_reuse_policy and id_conflict_policy.
        string activity_id = 4;
        Returns:
        The bytes for activityId.

      • hasActivityType

        boolean hasActivityType()
         The type of the activity, a string that corresponds to a registered activity on a worker.
        .temporal.api.common.v1.ActivityType activity_type = 5;
        Returns:
        Whether the activityType field is set.

      • getActivityType

        ActivityType getActivityType()
         The type of the activity, a string that corresponds to a registered activity on a worker.
        .temporal.api.common.v1.ActivityType activity_type = 5;
        Returns:
        The activityType.

      • getActivityTypeOrBuilder

        ActivityTypeOrBuilder getActivityTypeOrBuilder()
         The type of the activity, a string that corresponds to a registered activity on a worker.
        .temporal.api.common.v1.ActivityType activity_type = 5;

      • hasTaskQueue

        boolean hasTaskQueue()
         Task queue to schedule this activity on.
        .temporal.api.taskqueue.v1.TaskQueue task_queue = 6;
        Returns:
        Whether the taskQueue field is set.

      • getTaskQueue

        TaskQueue getTaskQueue()
         Task queue to schedule this activity on.
        .temporal.api.taskqueue.v1.TaskQueue task_queue = 6;
        Returns:
        The taskQueue.

      • getTaskQueueOrBuilder

        TaskQueueOrBuilder getTaskQueueOrBuilder()
         Task queue to schedule this activity on.
        .temporal.api.taskqueue.v1.TaskQueue task_queue = 6;

      • hasScheduleToCloseTimeout

        boolean hasScheduleToCloseTimeout()
         Indicates how long the caller is willing to wait for an activity completion. Limits how long
 retries will be attempted. Either this or `start_to_close_timeout` must be specified.

 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration schedule_to_close_timeout = 7;
        Returns:
        Whether the scheduleToCloseTimeout field is set.

      • getScheduleToCloseTimeout

        com.google.protobuf.Duration getScheduleToCloseTimeout()
         Indicates how long the caller is willing to wait for an activity completion. Limits how long
 retries will be attempted. Either this or `start_to_close_timeout` must be specified.

 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration schedule_to_close_timeout = 7;
        Returns:
        The scheduleToCloseTimeout.

      • getScheduleToCloseTimeoutOrBuilder

        com.google.protobuf.DurationOrBuilder getScheduleToCloseTimeoutOrBuilder()
         Indicates how long the caller is willing to wait for an activity completion. Limits how long
 retries will be attempted. Either this or `start_to_close_timeout` must be specified.

 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration schedule_to_close_timeout = 7;

      • hasScheduleToStartTimeout

        boolean hasScheduleToStartTimeout()
         Limits time an activity task can stay in a task queue before a worker picks it up. This
 timeout is always non retryable, as all a retry would achieve is to put it back into the same
 queue. Defaults to `schedule_to_close_timeout` if not specified.

 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration schedule_to_start_timeout = 8;
        Returns:
        Whether the scheduleToStartTimeout field is set.

      • getScheduleToStartTimeout

        com.google.protobuf.Duration getScheduleToStartTimeout()
         Limits time an activity task can stay in a task queue before a worker picks it up. This
 timeout is always non retryable, as all a retry would achieve is to put it back into the same
 queue. Defaults to `schedule_to_close_timeout` if not specified.

 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration schedule_to_start_timeout = 8;
        Returns:
        The scheduleToStartTimeout.

      • getScheduleToStartTimeoutOrBuilder

        com.google.protobuf.DurationOrBuilder getScheduleToStartTimeoutOrBuilder()
         Limits time an activity task can stay in a task queue before a worker picks it up. This
 timeout is always non retryable, as all a retry would achieve is to put it back into the same
 queue. Defaults to `schedule_to_close_timeout` if not specified.

 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration schedule_to_start_timeout = 8;

      • hasStartToCloseTimeout

        boolean hasStartToCloseTimeout()
         Maximum time an activity is allowed to execute after being picked up by a worker. This
 timeout is always retryable. Either this or `schedule_to_close_timeout` must be
 specified.

 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration start_to_close_timeout = 9;
        Returns:
        Whether the startToCloseTimeout field is set.

      • getStartToCloseTimeout

        com.google.protobuf.Duration getStartToCloseTimeout()
         Maximum time an activity is allowed to execute after being picked up by a worker. This
 timeout is always retryable. Either this or `schedule_to_close_timeout` must be
 specified.

 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration start_to_close_timeout = 9;
        Returns:
        The startToCloseTimeout.

      • getStartToCloseTimeoutOrBuilder

        com.google.protobuf.DurationOrBuilder getStartToCloseTimeoutOrBuilder()
         Maximum time an activity is allowed to execute after being picked up by a worker. This
 timeout is always retryable. Either this or `schedule_to_close_timeout` must be
 specified.

 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
        .google.protobuf.Duration start_to_close_timeout = 9;

      • hasHeartbeatTimeout

        boolean hasHeartbeatTimeout()
         Maximum permitted time between successful worker heartbeats.
        .google.protobuf.Duration heartbeat_timeout = 10;
        Returns:
        Whether the heartbeatTimeout field is set.

      • getHeartbeatTimeout

        com.google.protobuf.Duration getHeartbeatTimeout()
         Maximum permitted time between successful worker heartbeats.
        .google.protobuf.Duration heartbeat_timeout = 10;
        Returns:
        The heartbeatTimeout.

      • getHeartbeatTimeoutOrBuilder

        com.google.protobuf.DurationOrBuilder getHeartbeatTimeoutOrBuilder()
         Maximum permitted time between successful worker heartbeats.
        .google.protobuf.Duration heartbeat_timeout = 10;

      • hasRetryPolicy

        boolean hasRetryPolicy()
         The retry policy for the activity. Will never exceed `schedule_to_close_timeout`.
        .temporal.api.common.v1.RetryPolicy retry_policy = 11;
        Returns:
        Whether the retryPolicy field is set.

      • getRetryPolicy

        RetryPolicy getRetryPolicy()
         The retry policy for the activity. Will never exceed `schedule_to_close_timeout`.
        .temporal.api.common.v1.RetryPolicy retry_policy = 11;
        Returns:
        The retryPolicy.

      • getRetryPolicyOrBuilder

        RetryPolicyOrBuilder getRetryPolicyOrBuilder()
         The retry policy for the activity. Will never exceed `schedule_to_close_timeout`.
        .temporal.api.common.v1.RetryPolicy retry_policy = 11;

      • hasInput

        boolean hasInput()
         Serialized arguments to the activity. These are passed as arguments to the activity function.
        .temporal.api.common.v1.Payloads input = 12;
        Returns:
        Whether the input field is set.

      • getInput

        Payloads getInput()
         Serialized arguments to the activity. These are passed as arguments to the activity function.
        .temporal.api.common.v1.Payloads input = 12;
        Returns:
        The input.

      • getInputOrBuilder

        PayloadsOrBuilder getInputOrBuilder()
         Serialized arguments to the activity. These are passed as arguments to the activity function.
        .temporal.api.common.v1.Payloads input = 12;

      • getIdReusePolicyValue

        int getIdReusePolicyValue()
         Defines whether to allow re-using the activity id from a previously *closed* activity.
 The default policy is ACTIVITY_ID_REUSE_POLICY_ALLOW_DUPLICATE.
        .temporal.api.enums.v1.ActivityIdReusePolicy id_reuse_policy = 13;
        Returns:
        The enum numeric value on the wire for idReusePolicy.

      • getIdReusePolicy

        ActivityIdReusePolicy getIdReusePolicy()
         Defines whether to allow re-using the activity id from a previously *closed* activity.
 The default policy is ACTIVITY_ID_REUSE_POLICY_ALLOW_DUPLICATE.
        .temporal.api.enums.v1.ActivityIdReusePolicy id_reuse_policy = 13;
        Returns:
        The idReusePolicy.

      • getIdConflictPolicyValue

        int getIdConflictPolicyValue()
         Defines how to resolve an activity id conflict with a *running* activity.
 The default policy is ACTIVITY_ID_CONFLICT_POLICY_FAIL.
        .temporal.api.enums.v1.ActivityIdConflictPolicy id_conflict_policy = 14;
        Returns:
        The enum numeric value on the wire for idConflictPolicy.

      • getIdConflictPolicy

        ActivityIdConflictPolicy getIdConflictPolicy()
         Defines how to resolve an activity id conflict with a *running* activity.
 The default policy is ACTIVITY_ID_CONFLICT_POLICY_FAIL.
        .temporal.api.enums.v1.ActivityIdConflictPolicy id_conflict_policy = 14;
        Returns:
        The idConflictPolicy.

      • hasSearchAttributes

        boolean hasSearchAttributes()
         Search attributes for indexing.
        .temporal.api.common.v1.SearchAttributes search_attributes = 15;
        Returns:
        Whether the searchAttributes field is set.

      • getSearchAttributes

        SearchAttributes getSearchAttributes()
         Search attributes for indexing.
        .temporal.api.common.v1.SearchAttributes search_attributes = 15;
        Returns:
        The searchAttributes.

      • getSearchAttributesOrBuilder

        SearchAttributesOrBuilder getSearchAttributesOrBuilder()
         Search attributes for indexing.
        .temporal.api.common.v1.SearchAttributes search_attributes = 15;

      • hasHeader

        boolean hasHeader()
         Header for context propagation and tracing purposes.
        .temporal.api.common.v1.Header header = 16;
        Returns:
        Whether the header field is set.

      • getHeader

        Header getHeader()
         Header for context propagation and tracing purposes.
        .temporal.api.common.v1.Header header = 16;
        Returns:
        The header.

      • getHeaderOrBuilder

        HeaderOrBuilder getHeaderOrBuilder()
         Header for context propagation and tracing purposes.
        .temporal.api.common.v1.Header header = 16;

      • hasUserMetadata

        boolean hasUserMetadata()
         Metadata for use by user interfaces to display the fixed as-of-start summary and details of the activity.
        .temporal.api.sdk.v1.UserMetadata user_metadata = 17;
        Returns:
        Whether the userMetadata field is set.

      • getUserMetadata

        UserMetadata getUserMetadata()
         Metadata for use by user interfaces to display the fixed as-of-start summary and details of the activity.
        .temporal.api.sdk.v1.UserMetadata user_metadata = 17;
        Returns:
        The userMetadata.

      • getUserMetadataOrBuilder

        UserMetadataOrBuilder getUserMetadataOrBuilder()
         Metadata for use by user interfaces to display the fixed as-of-start summary and details of the activity.
        .temporal.api.sdk.v1.UserMetadata user_metadata = 17;

      • hasPriority

        boolean hasPriority()
         Priority metadata.
        .temporal.api.common.v1.Priority priority = 18;
        Returns:
        Whether the priority field is set.

      • getPriority

        Priority getPriority()
         Priority metadata.
        .temporal.api.common.v1.Priority priority = 18;
        Returns:
        The priority.

      • getPriorityOrBuilder

        PriorityOrBuilder getPriorityOrBuilder()
         Priority metadata.
        .temporal.api.common.v1.Priority priority = 18;