Interface StartNexusOperationExecutionRequestOrBuilder

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

  • Method Details

    • getNamespace

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

    • getNamespaceBytes

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

    • getIdentity

      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

      String getRequestId()
       A unique identifier for this caller-side start request. Typically UUIDv4.
 StartOperation requests sent to the handler will use a server-generated request ID.
      string request_id = 3;
      Returns:
      The requestId.

    • getRequestIdBytes

      com.google.protobuf.ByteString getRequestIdBytes()
       A unique identifier for this caller-side start request. Typically UUIDv4.
 StartOperation requests sent to the handler will use a server-generated request ID.
      string request_id = 3;
      Returns:
      The bytes for requestId.

    • getOperationId

      String getOperationId()
       Identifier for this operation. This is a caller-side ID, distinct from any internal
 operation identifiers generated by the handler. Must be unique among operations in the
 same namespace, subject to the rules imposed by id_reuse_policy and id_conflict_policy.
      string operation_id = 4;
      Returns:
      The operationId.

    • getOperationIdBytes

      com.google.protobuf.ByteString getOperationIdBytes()
       Identifier for this operation. This is a caller-side ID, distinct from any internal
 operation identifiers generated by the handler. Must be unique among operations in the
 same namespace, subject to the rules imposed by id_reuse_policy and id_conflict_policy.
      string operation_id = 4;
      Returns:
      The bytes for operationId.

    • getEndpoint

      String getEndpoint()
       Endpoint name, resolved to a URL via the cluster's endpoint registry.
      string endpoint = 5;
      Returns:
      The endpoint.

    • getEndpointBytes

      com.google.protobuf.ByteString getEndpointBytes()
       Endpoint name, resolved to a URL via the cluster's endpoint registry.
      string endpoint = 5;
      Returns:
      The bytes for endpoint.

    • getService

      String getService()
       Service name.
      string service = 6;
      Returns:
      The service.

    • getServiceBytes

      com.google.protobuf.ByteString getServiceBytes()
       Service name.
      string service = 6;
      Returns:
      The bytes for service.

    • getOperation

      String getOperation()
       Operation name.
      string operation = 7;
      Returns:
      The operation.

    • getOperationBytes

      com.google.protobuf.ByteString getOperationBytes()
       Operation name.
      string operation = 7;
      Returns:
      The bytes for operation.

    • hasScheduleToCloseTimeout

      boolean hasScheduleToCloseTimeout()
       Schedule-to-close timeout for this operation.
 Indicates how long the caller is willing to wait for operation completion.
 Calls are retried internally by the server.
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
      .google.protobuf.Duration schedule_to_close_timeout = 8;
      Returns:
      Whether the scheduleToCloseTimeout field is set.

    • getScheduleToCloseTimeout

      com.google.protobuf.Duration getScheduleToCloseTimeout()
       Schedule-to-close timeout for this operation.
 Indicates how long the caller is willing to wait for operation completion.
 Calls are retried internally by the server.
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
      .google.protobuf.Duration schedule_to_close_timeout = 8;
      Returns:
      The scheduleToCloseTimeout.

    • getScheduleToCloseTimeoutOrBuilder

      com.google.protobuf.DurationOrBuilder getScheduleToCloseTimeoutOrBuilder()
       Schedule-to-close timeout for this operation.
 Indicates how long the caller is willing to wait for operation completion.
 Calls are retried internally by the server.
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
      .google.protobuf.Duration schedule_to_close_timeout = 8;

    • hasScheduleToStartTimeout

      boolean hasScheduleToStartTimeout()
       Schedule-to-start timeout for this operation.
 Indicates how long the caller is willing to wait for the operation to be started (or completed if synchronous)
 by the handler.
 If not set or zero, no schedule-to-start timeout is enforced.
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
      .google.protobuf.Duration schedule_to_start_timeout = 9;
      Returns:
      Whether the scheduleToStartTimeout field is set.

    • getScheduleToStartTimeout

      com.google.protobuf.Duration getScheduleToStartTimeout()
       Schedule-to-start timeout for this operation.
 Indicates how long the caller is willing to wait for the operation to be started (or completed if synchronous)
 by the handler.
 If not set or zero, no schedule-to-start timeout is enforced.
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
      .google.protobuf.Duration schedule_to_start_timeout = 9;
      Returns:
      The scheduleToStartTimeout.

    • getScheduleToStartTimeoutOrBuilder

      com.google.protobuf.DurationOrBuilder getScheduleToStartTimeoutOrBuilder()
       Schedule-to-start timeout for this operation.
 Indicates how long the caller is willing to wait for the operation to be started (or completed if synchronous)
 by the handler.
 If not set or zero, no schedule-to-start timeout is enforced.
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
      .google.protobuf.Duration schedule_to_start_timeout = 9;

    • hasStartToCloseTimeout

      boolean hasStartToCloseTimeout()
       Start-to-close timeout for this operation.
 Indicates how long the caller is willing to wait for an asynchronous operation to complete after it has been
 started. Synchronous operations ignore this timeout.
 If not set or zero, no start-to-close timeout is enforced.
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
      .google.protobuf.Duration start_to_close_timeout = 10;
      Returns:
      Whether the startToCloseTimeout field is set.

    • getStartToCloseTimeout

      com.google.protobuf.Duration getStartToCloseTimeout()
       Start-to-close timeout for this operation.
 Indicates how long the caller is willing to wait for an asynchronous operation to complete after it has been
 started. Synchronous operations ignore this timeout.
 If not set or zero, no start-to-close timeout is enforced.
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
      .google.protobuf.Duration start_to_close_timeout = 10;
      Returns:
      The startToCloseTimeout.

    • getStartToCloseTimeoutOrBuilder

      com.google.protobuf.DurationOrBuilder getStartToCloseTimeoutOrBuilder()
       Start-to-close timeout for this operation.
 Indicates how long the caller is willing to wait for an asynchronous operation to complete after it has been
 started. Synchronous operations ignore this timeout.
 If not set or zero, no start-to-close timeout is enforced.
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: "to" is used to indicate interval. --)
      .google.protobuf.Duration start_to_close_timeout = 10;

    • hasInput

      boolean hasInput()
       Serialized input to the operation. Passed as the request payload.
      .temporal.api.common.v1.Payload input = 11;
      Returns:
      Whether the input field is set.

    • getInput

      Payload getInput()
       Serialized input to the operation. Passed as the request payload.
      .temporal.api.common.v1.Payload input = 11;
      Returns:
      The input.

    • getInputOrBuilder

      PayloadOrBuilder getInputOrBuilder()
       Serialized input to the operation. Passed as the request payload.
      .temporal.api.common.v1.Payload input = 11;

    • getIdReusePolicyValue

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

    • getIdReusePolicy

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

    • getIdConflictPolicyValue

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

    • getIdConflictPolicy

      NexusOperationIdConflictPolicy getIdConflictPolicy()
       Defines how to resolve an operation id conflict with a *running* operation.
 The default policy is NEXUS_OPERATION_ID_CONFLICT_POLICY_FAIL.
      .temporal.api.enums.v1.NexusOperationIdConflictPolicy id_conflict_policy = 13;
      Returns:
      The idConflictPolicy.

    • hasSearchAttributes

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

    • getSearchAttributes

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

    • getSearchAttributesOrBuilder

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

    • getNexusHeaderCount

      int getNexusHeaderCount()
       Header to attach to the Nexus request.
 Users are responsible for encrypting sensitive data in this header as it is stored in workflow history and
 transmitted to external services as-is.
 This is useful for propagating tracing information.
 Note these headers are not the same as Temporal headers on internal activities and child workflows, these are
 transmitted to Nexus operations that may be external and are not traditional payloads.
      map<string, string> nexus_header = 15;

    • containsNexusHeader

      boolean containsNexusHeader(String key)
       Header to attach to the Nexus request.
 Users are responsible for encrypting sensitive data in this header as it is stored in workflow history and
 transmitted to external services as-is.
 This is useful for propagating tracing information.
 Note these headers are not the same as Temporal headers on internal activities and child workflows, these are
 transmitted to Nexus operations that may be external and are not traditional payloads.
      map<string, string> nexus_header = 15;

    • getNexusHeader

      @Deprecated Map<String,String> getNexusHeader()
      Deprecated.
      Use getNexusHeaderMap() instead.

    • getNexusHeaderMap

      Map<String,String> getNexusHeaderMap()
       Header to attach to the Nexus request.
 Users are responsible for encrypting sensitive data in this header as it is stored in workflow history and
 transmitted to external services as-is.
 This is useful for propagating tracing information.
 Note these headers are not the same as Temporal headers on internal activities and child workflows, these are
 transmitted to Nexus operations that may be external and are not traditional payloads.
      map<string, string> nexus_header = 15;

    • getNexusHeaderOrDefault

      String getNexusHeaderOrDefault(String key, String defaultValue)
       Header to attach to the Nexus request.
 Users are responsible for encrypting sensitive data in this header as it is stored in workflow history and
 transmitted to external services as-is.
 This is useful for propagating tracing information.
 Note these headers are not the same as Temporal headers on internal activities and child workflows, these are
 transmitted to Nexus operations that may be external and are not traditional payloads.
      map<string, string> nexus_header = 15;

    • getNexusHeaderOrThrow

      String getNexusHeaderOrThrow(String key)
       Header to attach to the Nexus request.
 Users are responsible for encrypting sensitive data in this header as it is stored in workflow history and
 transmitted to external services as-is.
 This is useful for propagating tracing information.
 Note these headers are not the same as Temporal headers on internal activities and child workflows, these are
 transmitted to Nexus operations that may be external and are not traditional payloads.
      map<string, string> nexus_header = 15;

    • hasUserMetadata

      boolean hasUserMetadata()
       Metadata for use by user interfaces to display the fixed as-of-start summary and details of the operation.
      .temporal.api.sdk.v1.UserMetadata user_metadata = 16;
      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 operation.
      .temporal.api.sdk.v1.UserMetadata user_metadata = 16;
      Returns:
      The userMetadata.

    • getUserMetadataOrBuilder

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