Package com.google.cloud.workflows.v1

Interface ListWorkflowsRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    Filter to restrict results to specific workflows.
    com.google.protobuf.ByteString
    getFilterBytes()
    Filter to restrict results to specific workflows.
    String
    getOrderBy()
    Comma-separated list of fields that specify the order of the results.
    com.google.protobuf.ByteString
    getOrderByBytes()
    Comma-separated list of fields that specify the order of the results.
    int
    getPageSize()
    Maximum number of workflows to return per call.
    String
    getPageToken()
    A page token, received from a previous `ListWorkflows` call.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    A page token, received from a previous `ListWorkflows` call.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.

    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. Project and location from which the workflows should be listed.
 Format: projects/{project}/locations/{location}
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The parent.

    • getParentBytes

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

    • getPageSize

      int getPageSize()
       Maximum number of workflows to return per call. The service might return
 fewer than this value even if not at the end of the collection. If a value
 is not specified, a default value of 500 is used. The maximum permitted
 value is 1000 and values greater than 1000 are coerced down to 1000.
      int32 page_size = 2;
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       A page token, received from a previous `ListWorkflows` call.
 Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to `ListWorkflows` must
 match the call that provided the page token.
      string page_token = 3;
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       A page token, received from a previous `ListWorkflows` call.
 Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to `ListWorkflows` must
 match the call that provided the page token.
      string page_token = 3;
      Returns:
      The bytes for pageToken.

    • getFilter

      String getFilter()
       Filter to restrict results to specific workflows.
 For details, see <a href="https://google.aip.dev/160"
 class="external">AIP-160</a>.

 For example, if you are using the Google APIs Explorer:

 `state="SUCCEEDED"`

 or

 `createTime>"2023-08-01" AND state="FAILED"`
      string filter = 4;
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       Filter to restrict results to specific workflows.
 For details, see <a href="https://google.aip.dev/160"
 class="external">AIP-160</a>.

 For example, if you are using the Google APIs Explorer:

 `state="SUCCEEDED"`

 or

 `createTime>"2023-08-01" AND state="FAILED"`
      string filter = 4;
      Returns:
      The bytes for filter.

    • getOrderBy

      String getOrderBy()
       Comma-separated list of fields that specify the order of the results.
 Default sorting order for a field is ascending. To specify descending order
 for a field, append a "desc" suffix.
 If not specified, the results are returned in an unspecified order.
      string order_by = 5;
      Returns:
      The orderBy.

    • getOrderByBytes

      com.google.protobuf.ByteString getOrderByBytes()
       Comma-separated list of fields that specify the order of the results.
 Default sorting order for a field is ascending. To specify descending order
 for a field, append a "desc" suffix.
 If not specified, the results are returned in an unspecified order.
      string order_by = 5;
      Returns:
      The bytes for orderBy.