Interface OrchestratorService.PurgeInstancesRequestOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
OrchestratorService.PurgeInstancesRequest,OrchestratorService.PurgeInstancesRequest.Builder
- Enclosing class:
- OrchestratorService
public static interface OrchestratorService.PurgeInstancesRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionbooleangetForce()force will force a purge of a workflow, regardless of its current runtime state, or whether an active worker can process it, the backend will attempt to delete it anyway.string instanceId = 1;com.google.protobuf.ByteStringstring instanceId = 1;.PurgeInstanceFilter purgeInstanceFilter = 2;.PurgeInstanceFilter purgeInstanceFilter = 2;booleanbool recursive = 3;booleanhasForce()force will force a purge of a workflow, regardless of its current runtime state, or whether an active worker can process it, the backend will attempt to delete it anyway.booleanstring instanceId = 1;boolean.PurgeInstanceFilter purgeInstanceFilter = 2;Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
hasInstanceId
boolean hasInstanceId()string instanceId = 1;- Returns:
- Whether the instanceId field is set.
-
getInstanceId
String getInstanceId()string instanceId = 1;- Returns:
- The instanceId.
-
getInstanceIdBytes
com.google.protobuf.ByteString getInstanceIdBytes()string instanceId = 1;- Returns:
- The bytes for instanceId.
-
hasPurgeInstanceFilter
boolean hasPurgeInstanceFilter().PurgeInstanceFilter purgeInstanceFilter = 2;- Returns:
- Whether the purgeInstanceFilter field is set.
-
getPurgeInstanceFilter
OrchestratorService.PurgeInstanceFilter getPurgeInstanceFilter().PurgeInstanceFilter purgeInstanceFilter = 2;- Returns:
- The purgeInstanceFilter.
-
getPurgeInstanceFilterOrBuilder
OrchestratorService.PurgeInstanceFilterOrBuilder getPurgeInstanceFilterOrBuilder().PurgeInstanceFilter purgeInstanceFilter = 2; -
getRecursive
boolean getRecursive()bool recursive = 3;- Returns:
- The recursive.
-
hasForce
boolean hasForce()force will force a purge of a workflow, regardless of its current runtime state, or whether an active worker can process it, the backend will attempt to delete it anyway. This neccessarily means the purging is executed out side of the workflow state machine, and therefore, can lead to corrupt state or broken workflow execution. Usage of this should _only_ be used when the client knows the workflow is not being currently processed. It is highly recommended to avoid using this flag unless absolutely necessary. Defaults to false.
optional bool force = 4;- Returns:
- Whether the force field is set.
-
getForce
boolean getForce()force will force a purge of a workflow, regardless of its current runtime state, or whether an active worker can process it, the backend will attempt to delete it anyway. This neccessarily means the purging is executed out side of the workflow state machine, and therefore, can lead to corrupt state or broken workflow execution. Usage of this should _only_ be used when the client knows the workflow is not being currently processed. It is highly recommended to avoid using this flag unless absolutely necessary. Defaults to false.
optional bool force = 4;- Returns:
- The force.
-
getRequestCase
OrchestratorService.PurgeInstancesRequest.RequestCase getRequestCase()
-