diff --git a/Workflows/metadata/Executions/V1/Executions.php b/Workflows/metadata/Executions/V1/Executions.php index 1cbda3d791d5..84359f945f1b 100644 Binary files a/Workflows/metadata/Executions/V1/Executions.php and b/Workflows/metadata/Executions/V1/Executions.php differ diff --git a/Workflows/src/Executions/V1/Execution.php b/Workflows/src/Executions/V1/Execution.php index 65244a78c61e..8ec358514dcb 100644 --- a/Workflows/src/Executions/V1/Execution.php +++ b/Workflows/src/Executions/V1/Execution.php @@ -36,6 +36,12 @@ class Execution extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.protobuf.Timestamp end_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; */ private $end_time = null; + /** + * Output only. Measures the duration of the execution. + * + * Generated from protobuf field .google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $duration = null; /** * Output only. Current state of the execution. * @@ -79,6 +85,33 @@ class Execution extends \Google\Protobuf\Internal\Message * Generated from protobuf field .google.cloud.workflows.executions.v1.Execution.CallLogLevel call_log_level = 9; */ private $call_log_level = 0; + /** + * Output only. Status tracks the current steps and progress data of this + * execution. + * + * Generated from protobuf field .google.cloud.workflows.executions.v1.Execution.Status status = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $status = null; + /** + * Labels associated with this execution. + * Labels can contain at most 64 entries. Keys and values can be no longer + * than 63 characters and can only contain lowercase letters, numeric + * characters, underscores, and dashes. Label keys must start with a letter. + * International characters are allowed. + * By default, labels are inherited from the workflow but are overridden by + * any labels associated with the execution. + * + * Generated from protobuf field map labels = 11; + */ + private $labels; + /** + * Output only. Error regarding the state of the Execution resource. For + * example, this field will have error details if the execution data is + * unavailable due to revoked KMS key permissions. + * + * Generated from protobuf field .google.cloud.workflows.executions.v1.Execution.StateError state_error = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; + */ + private $state_error = null; /** * Constructor. @@ -94,6 +127,8 @@ class Execution extends \Google\Protobuf\Internal\Message * Output only. Marks the beginning of execution. * @type \Google\Protobuf\Timestamp $end_time * Output only. Marks the end of execution, successful or not. + * @type \Google\Protobuf\Duration $duration + * Output only. Measures the duration of the execution. * @type int $state * Output only. Current state of the execution. * @type string $argument @@ -113,6 +148,21 @@ class Execution extends \Google\Protobuf\Internal\Message * Output only. Revision of the workflow this execution is using. * @type int $call_log_level * The call logging level associated to this execution. + * @type \Google\Cloud\Workflows\Executions\V1\Execution\Status $status + * Output only. Status tracks the current steps and progress data of this + * execution. + * @type array|\Google\Protobuf\Internal\MapField $labels + * Labels associated with this execution. + * Labels can contain at most 64 entries. Keys and values can be no longer + * than 63 characters and can only contain lowercase letters, numeric + * characters, underscores, and dashes. Label keys must start with a letter. + * International characters are allowed. + * By default, labels are inherited from the workflow but are overridden by + * any labels associated with the execution. + * @type \Google\Cloud\Workflows\Executions\V1\Execution\StateError $state_error + * Output only. Error regarding the state of the Execution resource. For + * example, this field will have error details if the execution data is + * unavailable due to revoked KMS key permissions. * } */ public function __construct($data = NULL) { @@ -222,6 +272,42 @@ public function setEndTime($var) return $this; } + /** + * Output only. Measures the duration of the execution. + * + * Generated from protobuf field .google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Protobuf\Duration|null + */ + public function getDuration() + { + return $this->duration; + } + + public function hasDuration() + { + return isset($this->duration); + } + + public function clearDuration() + { + unset($this->duration); + } + + /** + * Output only. Measures the duration of the execution. + * + * Generated from protobuf field .google.protobuf.Duration duration = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Protobuf\Duration $var + * @return $this + */ + public function setDuration($var) + { + GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class); + $this->duration = $var; + + return $this; + } + /** * Output only. Current state of the execution. * @@ -402,5 +488,121 @@ public function setCallLogLevel($var) return $this; } + /** + * Output only. Status tracks the current steps and progress data of this + * execution. + * + * Generated from protobuf field .google.cloud.workflows.executions.v1.Execution.Status status = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Cloud\Workflows\Executions\V1\Execution\Status|null + */ + public function getStatus() + { + return $this->status; + } + + public function hasStatus() + { + return isset($this->status); + } + + public function clearStatus() + { + unset($this->status); + } + + /** + * Output only. Status tracks the current steps and progress data of this + * execution. + * + * Generated from protobuf field .google.cloud.workflows.executions.v1.Execution.Status status = 10 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Cloud\Workflows\Executions\V1\Execution\Status $var + * @return $this + */ + public function setStatus($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Workflows\Executions\V1\Execution\Status::class); + $this->status = $var; + + return $this; + } + + /** + * Labels associated with this execution. + * Labels can contain at most 64 entries. Keys and values can be no longer + * than 63 characters and can only contain lowercase letters, numeric + * characters, underscores, and dashes. Label keys must start with a letter. + * International characters are allowed. + * By default, labels are inherited from the workflow but are overridden by + * any labels associated with the execution. + * + * Generated from protobuf field map labels = 11; + * @return \Google\Protobuf\Internal\MapField + */ + public function getLabels() + { + return $this->labels; + } + + /** + * Labels associated with this execution. + * Labels can contain at most 64 entries. Keys and values can be no longer + * than 63 characters and can only contain lowercase letters, numeric + * characters, underscores, and dashes. Label keys must start with a letter. + * International characters are allowed. + * By default, labels are inherited from the workflow but are overridden by + * any labels associated with the execution. + * + * Generated from protobuf field map labels = 11; + * @param array|\Google\Protobuf\Internal\MapField $var + * @return $this + */ + public function setLabels($var) + { + $arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING); + $this->labels = $arr; + + return $this; + } + + /** + * Output only. Error regarding the state of the Execution resource. For + * example, this field will have error details if the execution data is + * unavailable due to revoked KMS key permissions. + * + * Generated from protobuf field .google.cloud.workflows.executions.v1.Execution.StateError state_error = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @return \Google\Cloud\Workflows\Executions\V1\Execution\StateError|null + */ + public function getStateError() + { + return $this->state_error; + } + + public function hasStateError() + { + return isset($this->state_error); + } + + public function clearStateError() + { + unset($this->state_error); + } + + /** + * Output only. Error regarding the state of the Execution resource. For + * example, this field will have error details if the execution data is + * unavailable due to revoked KMS key permissions. + * + * Generated from protobuf field .google.cloud.workflows.executions.v1.Execution.StateError state_error = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; + * @param \Google\Cloud\Workflows\Executions\V1\Execution\StateError $var + * @return $this + */ + public function setStateError($var) + { + GPBUtil::checkMessage($var, \Google\Cloud\Workflows\Executions\V1\Execution\StateError::class); + $this->state_error = $var; + + return $this; + } + } diff --git a/Workflows/src/Executions/V1/Execution/CallLogLevel.php b/Workflows/src/Executions/V1/Execution/CallLogLevel.php index dbc2fd0a6d5e..ff6b5532dbfb 100644 --- a/Workflows/src/Executions/V1/Execution/CallLogLevel.php +++ b/Workflows/src/Executions/V1/Execution/CallLogLevel.php @@ -15,7 +15,7 @@ class CallLogLevel { /** - * No call logging specified. + * No call logging level specified. * * Generated from protobuf enum CALL_LOG_LEVEL_UNSPECIFIED = 0; */ @@ -33,11 +33,18 @@ class CallLogLevel * Generated from protobuf enum LOG_ERRORS_ONLY = 2; */ const LOG_ERRORS_ONLY = 2; + /** + * Explicitly log nothing. + * + * Generated from protobuf enum LOG_NONE = 3; + */ + const LOG_NONE = 3; private static $valueToName = [ self::CALL_LOG_LEVEL_UNSPECIFIED => 'CALL_LOG_LEVEL_UNSPECIFIED', self::LOG_ALL_CALLS => 'LOG_ALL_CALLS', self::LOG_ERRORS_ONLY => 'LOG_ERRORS_ONLY', + self::LOG_NONE => 'LOG_NONE', ]; public static function name($value) diff --git a/Workflows/src/Executions/V1/Execution/State.php b/Workflows/src/Executions/V1/Execution/State.php index 5b5702c3bb32..79500707a958 100644 --- a/Workflows/src/Executions/V1/Execution/State.php +++ b/Workflows/src/Executions/V1/Execution/State.php @@ -44,6 +44,18 @@ class State * Generated from protobuf enum CANCELLED = 4; */ const CANCELLED = 4; + /** + * Execution data is unavailable. See the `state_error` field. + * + * Generated from protobuf enum UNAVAILABLE = 5; + */ + const UNAVAILABLE = 5; + /** + * Request has been placed in the backlog for processing at a later time. + * + * Generated from protobuf enum QUEUED = 6; + */ + const QUEUED = 6; private static $valueToName = [ self::STATE_UNSPECIFIED => 'STATE_UNSPECIFIED', @@ -51,6 +63,8 @@ class State self::SUCCEEDED => 'SUCCEEDED', self::FAILED => 'FAILED', self::CANCELLED => 'CANCELLED', + self::UNAVAILABLE => 'UNAVAILABLE', + self::QUEUED => 'QUEUED', ]; public static function name($value) diff --git a/Workflows/src/Executions/V1/Execution/StateError.php b/Workflows/src/Executions/V1/Execution/StateError.php new file mode 100644 index 000000000000..3fe8c06d64a0 --- /dev/null +++ b/Workflows/src/Executions/V1/Execution/StateError.php @@ -0,0 +1,104 @@ +google.cloud.workflows.executions.v1.Execution.StateError + */ +class StateError extends \Google\Protobuf\Internal\Message +{ + /** + * Provides specifics about the error. + * + * Generated from protobuf field string details = 1; + */ + private $details = ''; + /** + * The type of this state error. + * + * Generated from protobuf field .google.cloud.workflows.executions.v1.Execution.StateError.Type type = 2; + */ + private $type = 0; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $details + * Provides specifics about the error. + * @type int $type + * The type of this state error. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Workflows\Executions\V1\Executions::initOnce(); + parent::__construct($data); + } + + /** + * Provides specifics about the error. + * + * Generated from protobuf field string details = 1; + * @return string + */ + public function getDetails() + { + return $this->details; + } + + /** + * Provides specifics about the error. + * + * Generated from protobuf field string details = 1; + * @param string $var + * @return $this + */ + public function setDetails($var) + { + GPBUtil::checkString($var, True); + $this->details = $var; + + return $this; + } + + /** + * The type of this state error. + * + * Generated from protobuf field .google.cloud.workflows.executions.v1.Execution.StateError.Type type = 2; + * @return int + */ + public function getType() + { + return $this->type; + } + + /** + * The type of this state error. + * + * Generated from protobuf field .google.cloud.workflows.executions.v1.Execution.StateError.Type type = 2; + * @param int $var + * @return $this + */ + public function setType($var) + { + GPBUtil::checkEnum($var, \Google\Cloud\Workflows\Executions\V1\Execution\StateError\Type::class); + $this->type = $var; + + return $this; + } + +} + +// Adding a class alias for backwards compatibility with the previous class name. +class_alias(StateError::class, \Google\Cloud\Workflows\Executions\V1\Execution_StateError::class); + diff --git a/Workflows/src/Executions/V1/Execution/StateError/Type.php b/Workflows/src/Executions/V1/Execution/StateError/Type.php new file mode 100644 index 000000000000..82ea0cbcf588 --- /dev/null +++ b/Workflows/src/Executions/V1/Execution/StateError/Type.php @@ -0,0 +1,57 @@ +google.cloud.workflows.executions.v1.Execution.StateError.Type + */ +class Type +{ + /** + * No type specified. + * + * Generated from protobuf enum TYPE_UNSPECIFIED = 0; + */ + const TYPE_UNSPECIFIED = 0; + /** + * Caused by an issue with KMS. + * + * Generated from protobuf enum KMS_ERROR = 1; + */ + const KMS_ERROR = 1; + + private static $valueToName = [ + self::TYPE_UNSPECIFIED => 'TYPE_UNSPECIFIED', + self::KMS_ERROR => 'KMS_ERROR', + ]; + + public static function name($value) + { + if (!isset(self::$valueToName[$value])) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no name defined for value %s', __CLASS__, $value)); + } + return self::$valueToName[$value]; + } + + + public static function value($name) + { + $const = __CLASS__ . '::' . strtoupper($name); + if (!defined($const)) { + throw new UnexpectedValueException(sprintf( + 'Enum %s has no value defined for name %s', __CLASS__, $name)); + } + return constant($const); + } +} + +// Adding a class alias for backwards compatibility with the previous class name. +class_alias(Type::class, \Google\Cloud\Workflows\Executions\V1\Execution_StateError_Type::class); + diff --git a/Workflows/src/Executions/V1/Execution/Status.php b/Workflows/src/Executions/V1/Execution/Status.php new file mode 100644 index 000000000000..e561ba569538 --- /dev/null +++ b/Workflows/src/Executions/V1/Execution/Status.php @@ -0,0 +1,94 @@ +google.cloud.workflows.executions.v1.Execution.Status + */ +class Status extends \Google\Protobuf\Internal\Message +{ + /** + * A list of currently executing or last executed step names for the + * workflow execution currently running. If the workflow has succeeded or + * failed, this is the last attempted or executed step. Presently, if the + * current step is inside a subworkflow, the list only includes that step. + * In the future, the list will contain items for each step in the call + * stack, starting with the outermost step in the `main` subworkflow, and + * ending with the most deeply nested step. + * + * Generated from protobuf field repeated .google.cloud.workflows.executions.v1.Execution.Status.Step current_steps = 1; + */ + private $current_steps; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type array<\Google\Cloud\Workflows\Executions\V1\Execution\Status\Step>|\Google\Protobuf\Internal\RepeatedField $current_steps + * A list of currently executing or last executed step names for the + * workflow execution currently running. If the workflow has succeeded or + * failed, this is the last attempted or executed step. Presently, if the + * current step is inside a subworkflow, the list only includes that step. + * In the future, the list will contain items for each step in the call + * stack, starting with the outermost step in the `main` subworkflow, and + * ending with the most deeply nested step. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Workflows\Executions\V1\Executions::initOnce(); + parent::__construct($data); + } + + /** + * A list of currently executing or last executed step names for the + * workflow execution currently running. If the workflow has succeeded or + * failed, this is the last attempted or executed step. Presently, if the + * current step is inside a subworkflow, the list only includes that step. + * In the future, the list will contain items for each step in the call + * stack, starting with the outermost step in the `main` subworkflow, and + * ending with the most deeply nested step. + * + * Generated from protobuf field repeated .google.cloud.workflows.executions.v1.Execution.Status.Step current_steps = 1; + * @return \Google\Protobuf\Internal\RepeatedField + */ + public function getCurrentSteps() + { + return $this->current_steps; + } + + /** + * A list of currently executing or last executed step names for the + * workflow execution currently running. If the workflow has succeeded or + * failed, this is the last attempted or executed step. Presently, if the + * current step is inside a subworkflow, the list only includes that step. + * In the future, the list will contain items for each step in the call + * stack, starting with the outermost step in the `main` subworkflow, and + * ending with the most deeply nested step. + * + * Generated from protobuf field repeated .google.cloud.workflows.executions.v1.Execution.Status.Step current_steps = 1; + * @param array<\Google\Cloud\Workflows\Executions\V1\Execution\Status\Step>|\Google\Protobuf\Internal\RepeatedField $var + * @return $this + */ + public function setCurrentSteps($var) + { + $arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Workflows\Executions\V1\Execution\Status\Step::class); + $this->current_steps = $arr; + + return $this; + } + +} + +// Adding a class alias for backwards compatibility with the previous class name. +class_alias(Status::class, \Google\Cloud\Workflows\Executions\V1\Execution_Status::class); + diff --git a/Workflows/src/Executions/V1/Execution/Status/Step.php b/Workflows/src/Executions/V1/Execution/Status/Step.php new file mode 100644 index 000000000000..04744bc3bc09 --- /dev/null +++ b/Workflows/src/Executions/V1/Execution/Status/Step.php @@ -0,0 +1,104 @@ +google.cloud.workflows.executions.v1.Execution.Status.Step + */ +class Step extends \Google\Protobuf\Internal\Message +{ + /** + * Name of a routine within the workflow. + * + * Generated from protobuf field string routine = 1; + */ + private $routine = ''; + /** + * Name of a step within the routine. + * + * Generated from protobuf field string step = 2; + */ + private $step = ''; + + /** + * Constructor. + * + * @param array $data { + * Optional. Data for populating the Message object. + * + * @type string $routine + * Name of a routine within the workflow. + * @type string $step + * Name of a step within the routine. + * } + */ + public function __construct($data = NULL) { + \GPBMetadata\Google\Cloud\Workflows\Executions\V1\Executions::initOnce(); + parent::__construct($data); + } + + /** + * Name of a routine within the workflow. + * + * Generated from protobuf field string routine = 1; + * @return string + */ + public function getRoutine() + { + return $this->routine; + } + + /** + * Name of a routine within the workflow. + * + * Generated from protobuf field string routine = 1; + * @param string $var + * @return $this + */ + public function setRoutine($var) + { + GPBUtil::checkString($var, True); + $this->routine = $var; + + return $this; + } + + /** + * Name of a step within the routine. + * + * Generated from protobuf field string step = 2; + * @return string + */ + public function getStep() + { + return $this->step; + } + + /** + * Name of a step within the routine. + * + * Generated from protobuf field string step = 2; + * @param string $var + * @return $this + */ + public function setStep($var) + { + GPBUtil::checkString($var, True); + $this->step = $var; + + return $this; + } + +} + +// Adding a class alias for backwards compatibility with the previous class name. +class_alias(Step::class, \Google\Cloud\Workflows\Executions\V1\Execution_Status_Step::class); + diff --git a/Workflows/src/Executions/V1/ExecutionView.php b/Workflows/src/Executions/V1/ExecutionView.php index 589d3628b918..3cf62b861520 100644 --- a/Workflows/src/Executions/V1/ExecutionView.php +++ b/Workflows/src/Executions/V1/ExecutionView.php @@ -21,8 +21,8 @@ class ExecutionView const EXECUTION_VIEW_UNSPECIFIED = 0; /** * Includes only basic metadata about the execution. - * Following fields are returned: name, start_time, end_time, state - * and workflow_revision_id. + * The following fields are returned: name, start_time, end_time, duration, + * state, and workflow_revision_id. * * Generated from protobuf enum BASIC = 1; */ diff --git a/Workflows/src/Executions/V1/GetExecutionRequest.php b/Workflows/src/Executions/V1/GetExecutionRequest.php index a754d7d49def..fd2c9fb63909 100644 --- a/Workflows/src/Executions/V1/GetExecutionRequest.php +++ b/Workflows/src/Executions/V1/GetExecutionRequest.php @@ -26,8 +26,8 @@ class GetExecutionRequest extends \Google\Protobuf\Internal\Message */ private $name = ''; /** - * Optional. A view defining which fields should be filled in the returned execution. - * The API will default to the FULL view. + * Optional. A view defining which fields should be filled in the returned + * execution. The API will default to the FULL view. * * Generated from protobuf field .google.cloud.workflows.executions.v1.ExecutionView view = 2 [(.google.api.field_behavior) = OPTIONAL]; */ @@ -60,8 +60,8 @@ public static function build(string $name): self * Format: * projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} * @type int $view - * Optional. A view defining which fields should be filled in the returned execution. - * The API will default to the FULL view. + * Optional. A view defining which fields should be filled in the returned + * execution. The API will default to the FULL view. * } */ public function __construct($data = NULL) { @@ -100,8 +100,8 @@ public function setName($var) } /** - * Optional. A view defining which fields should be filled in the returned execution. - * The API will default to the FULL view. + * Optional. A view defining which fields should be filled in the returned + * execution. The API will default to the FULL view. * * Generated from protobuf field .google.cloud.workflows.executions.v1.ExecutionView view = 2 [(.google.api.field_behavior) = OPTIONAL]; * @return int @@ -112,8 +112,8 @@ public function getView() } /** - * Optional. A view defining which fields should be filled in the returned execution. - * The API will default to the FULL view. + * Optional. A view defining which fields should be filled in the returned + * execution. The API will default to the FULL view. * * Generated from protobuf field .google.cloud.workflows.executions.v1.ExecutionView view = 2 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var diff --git a/Workflows/src/Executions/V1/ListExecutionsRequest.php b/Workflows/src/Executions/V1/ListExecutionsRequest.php index ff2582a940dd..e2e457023463 100644 --- a/Workflows/src/Executions/V1/ListExecutionsRequest.php +++ b/Workflows/src/Executions/V1/ListExecutionsRequest.php @@ -26,7 +26,7 @@ class ListExecutionsRequest extends \Google\Protobuf\Internal\Message private $parent = ''; /** * Maximum number of executions to return per call. - * Max supported value depends on the selected Execution view: it's 10000 for + * Max supported value depends on the selected Execution view: it's 1000 for * BASIC and 100 for FULL. The default value used if the field is not * specified is 100, regardless of the selected view. Values greater than * the max value will be coerced down to it. @@ -39,17 +39,37 @@ class ListExecutionsRequest extends \Google\Protobuf\Internal\Message * Provide this to retrieve the subsequent page. * When paginating, all other parameters provided to `ListExecutions` must * match the call that provided the page token. + * Note that pagination is applied to dynamic data. The list of executions + * returned can change between page requests. * * Generated from protobuf field string page_token = 3; */ private $page_token = ''; /** - * Optional. A view defining which fields should be filled in the returned executions. - * The API will default to the BASIC view. + * Optional. A view defining which fields should be filled in the returned + * executions. The API will default to the BASIC view. * * Generated from protobuf field .google.cloud.workflows.executions.v1.ExecutionView view = 4 [(.google.api.field_behavior) = OPTIONAL]; */ private $view = 0; + /** + * Optional. Filters applied to the [Executions.ListExecutions] results. + * The following fields are supported for filtering: + * executionID, state, startTime, endTime, duration, workflowRevisionID, + * stepName, and label. + * + * Generated from protobuf field string filter = 5 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $filter = ''; + /** + * Optional. The ordering applied to the [Executions.ListExecutions] results. + * By default the ordering is based on descending start time. + * The following fields are supported for order by: + * executionID, startTime, endTime, duration, state, and workflowRevisionID. + * + * Generated from protobuf field string order_by = 6 [(.google.api.field_behavior) = OPTIONAL]; + */ + private $order_by = ''; /** * @param string $parent Required. Name of the workflow for which the executions should be listed. @@ -77,7 +97,7 @@ public static function build(string $parent): self * Format: projects/{project}/locations/{location}/workflows/{workflow} * @type int $page_size * Maximum number of executions to return per call. - * Max supported value depends on the selected Execution view: it's 10000 for + * Max supported value depends on the selected Execution view: it's 1000 for * BASIC and 100 for FULL. The default value used if the field is not * specified is 100, regardless of the selected view. Values greater than * the max value will be coerced down to it. @@ -86,9 +106,21 @@ public static function build(string $parent): self * Provide this to retrieve the subsequent page. * When paginating, all other parameters provided to `ListExecutions` must * match the call that provided the page token. + * Note that pagination is applied to dynamic data. The list of executions + * returned can change between page requests. * @type int $view - * Optional. A view defining which fields should be filled in the returned executions. - * The API will default to the BASIC view. + * Optional. A view defining which fields should be filled in the returned + * executions. The API will default to the BASIC view. + * @type string $filter + * Optional. Filters applied to the [Executions.ListExecutions] results. + * The following fields are supported for filtering: + * executionID, state, startTime, endTime, duration, workflowRevisionID, + * stepName, and label. + * @type string $order_by + * Optional. The ordering applied to the [Executions.ListExecutions] results. + * By default the ordering is based on descending start time. + * The following fields are supported for order by: + * executionID, startTime, endTime, duration, state, and workflowRevisionID. * } */ public function __construct($data = NULL) { @@ -126,7 +158,7 @@ public function setParent($var) /** * Maximum number of executions to return per call. - * Max supported value depends on the selected Execution view: it's 10000 for + * Max supported value depends on the selected Execution view: it's 1000 for * BASIC and 100 for FULL. The default value used if the field is not * specified is 100, regardless of the selected view. Values greater than * the max value will be coerced down to it. @@ -141,7 +173,7 @@ public function getPageSize() /** * Maximum number of executions to return per call. - * Max supported value depends on the selected Execution view: it's 10000 for + * Max supported value depends on the selected Execution view: it's 1000 for * BASIC and 100 for FULL. The default value used if the field is not * specified is 100, regardless of the selected view. Values greater than * the max value will be coerced down to it. @@ -163,6 +195,8 @@ public function setPageSize($var) * Provide this to retrieve the subsequent page. * When paginating, all other parameters provided to `ListExecutions` must * match the call that provided the page token. + * Note that pagination is applied to dynamic data. The list of executions + * returned can change between page requests. * * Generated from protobuf field string page_token = 3; * @return string @@ -177,6 +211,8 @@ public function getPageToken() * Provide this to retrieve the subsequent page. * When paginating, all other parameters provided to `ListExecutions` must * match the call that provided the page token. + * Note that pagination is applied to dynamic data. The list of executions + * returned can change between page requests. * * Generated from protobuf field string page_token = 3; * @param string $var @@ -191,8 +227,8 @@ public function setPageToken($var) } /** - * Optional. A view defining which fields should be filled in the returned executions. - * The API will default to the BASIC view. + * Optional. A view defining which fields should be filled in the returned + * executions. The API will default to the BASIC view. * * Generated from protobuf field .google.cloud.workflows.executions.v1.ExecutionView view = 4 [(.google.api.field_behavior) = OPTIONAL]; * @return int @@ -203,8 +239,8 @@ public function getView() } /** - * Optional. A view defining which fields should be filled in the returned executions. - * The API will default to the BASIC view. + * Optional. A view defining which fields should be filled in the returned + * executions. The API will default to the BASIC view. * * Generated from protobuf field .google.cloud.workflows.executions.v1.ExecutionView view = 4 [(.google.api.field_behavior) = OPTIONAL]; * @param int $var @@ -218,5 +254,69 @@ public function setView($var) return $this; } + /** + * Optional. Filters applied to the [Executions.ListExecutions] results. + * The following fields are supported for filtering: + * executionID, state, startTime, endTime, duration, workflowRevisionID, + * stepName, and label. + * + * Generated from protobuf field string filter = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getFilter() + { + return $this->filter; + } + + /** + * Optional. Filters applied to the [Executions.ListExecutions] results. + * The following fields are supported for filtering: + * executionID, state, startTime, endTime, duration, workflowRevisionID, + * stepName, and label. + * + * Generated from protobuf field string filter = 5 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setFilter($var) + { + GPBUtil::checkString($var, True); + $this->filter = $var; + + return $this; + } + + /** + * Optional. The ordering applied to the [Executions.ListExecutions] results. + * By default the ordering is based on descending start time. + * The following fields are supported for order by: + * executionID, startTime, endTime, duration, state, and workflowRevisionID. + * + * Generated from protobuf field string order_by = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @return string + */ + public function getOrderBy() + { + return $this->order_by; + } + + /** + * Optional. The ordering applied to the [Executions.ListExecutions] results. + * By default the ordering is based on descending start time. + * The following fields are supported for order by: + * executionID, startTime, endTime, duration, state, and workflowRevisionID. + * + * Generated from protobuf field string order_by = 6 [(.google.api.field_behavior) = OPTIONAL]; + * @param string $var + * @return $this + */ + public function setOrderBy($var) + { + GPBUtil::checkString($var, True); + $this->order_by = $var; + + return $this; + } + }