Package com.google.cloud.workflows.executions.v1

Interface ListExecutionsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListExecutionsRequest, ListExecutionsRequest.Builder
@Generated public interface ListExecutionsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    Optional.
    com.google.protobuf.ByteString
    getFilterBytes()
    Optional.
    String
    getOrderBy()
    Optional.
    com.google.protobuf.ByteString
    getOrderByBytes()
    Optional.
    int
    getPageSize()
    Maximum number of executions to return per call.
    String
    getPageToken()
    A page token, received from a previous `ListExecutions` call.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    A page token, received from a previous `ListExecutions` call.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.
    ExecutionView
    getView()
    Optional.
    int
    getViewValue()
    Optional.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getParent

      String getParent()
       Required. Name of the workflow for which the executions should be listed.
 Format: projects/{project}/locations/{location}/workflows/{workflow}
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

      com.google.protobuf.ByteString getParentBytes()
       Required. Name of the workflow for which the executions should be listed.
 Format: projects/{project}/locations/{location}/workflows/{workflow}
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for parent.

    • getPageSize

      int getPageSize()
       Maximum number of executions to return per call.
 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.
      int32 page_size = 2;
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       A page token, received from a previous `ListExecutions` call.
 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.
      string page_token = 3;
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       A page token, received from a previous `ListExecutions` call.
 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.
      string page_token = 3;
      Returns:
      The bytes for pageToken.

    • getViewValue

      int getViewValue()
       Optional. A view defining which fields should be filled in the returned
 executions. The API will default to the BASIC view.
      .google.cloud.workflows.executions.v1.ExecutionView view = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for view.

    • getView

      ExecutionView getView()
       Optional. A view defining which fields should be filled in the returned
 executions. The API will default to the BASIC view.
      .google.cloud.workflows.executions.v1.ExecutionView view = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The view.

    • getFilter

      String getFilter()
       Optional. Filters applied to the [Executions.ListExecutions] results.
 The following fields are supported for filtering:
 executionID, state, startTime, endTime, duration, workflowRevisionID,
 stepName, and label.
      string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       Optional. Filters applied to the [Executions.ListExecutions] results.
 The following fields are supported for filtering:
 executionID, state, startTime, endTime, duration, workflowRevisionID,
 stepName, and label.
      string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for filter.

    • getOrderBy

      String getOrderBy()
       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.
      string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The orderBy.

    • getOrderByBytes

      com.google.protobuf.ByteString getOrderByBytes()
       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.
      string order_by = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for orderBy.