Package com.google.cloud.workflows.v1

Class ListWorkflowsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ListWorkflowsRequest.Builder>
com.google.cloud.workflows.v1.ListWorkflowsRequest.Builder
All Implemented Interfaces:
ListWorkflowsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ListWorkflowsRequest
public static final class ListWorkflowsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ListWorkflowsRequest.Builder> implements ListWorkflowsRequestOrBuilder
 Request for the
 [ListWorkflows][google.cloud.workflows.v1.Workflows.ListWorkflows]
 method.
Protobuf type google.cloud.workflows.v1.ListWorkflowsRequest

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ListWorkflowsRequest.Builder>

    • clear

      public ListWorkflowsRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ListWorkflowsRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ListWorkflowsRequest.Builder>

    • getDefaultInstanceForType

      public ListWorkflowsRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public ListWorkflowsRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public ListWorkflowsRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public ListWorkflowsRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListWorkflowsRequest.Builder>

    • mergeFrom

      public ListWorkflowsRequest.Builder mergeFrom(ListWorkflowsRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListWorkflowsRequest.Builder>

    • mergeFrom

      public ListWorkflowsRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListWorkflowsRequest.Builder>
      Throws:
      IOException

    • getParent

      public 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) = { ... }
      Specified by:
      getParent in interface ListWorkflowsRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public 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) = { ... }
      Specified by:
      getParentBytes in interface ListWorkflowsRequestOrBuilder
      Returns:
      The bytes for parent.

    • setParent

      public ListWorkflowsRequest.Builder setParent(String value)
       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) = { ... }
      Parameters:
      value - The parent to set.
      Returns:
      This builder for chaining.

    • clearParent

      public ListWorkflowsRequest.Builder clearParent()
       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:
      This builder for chaining.

    • setParentBytes

      public ListWorkflowsRequest.Builder setParentBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for parent to set.
      Returns:
      This builder for chaining.

    • getPageSize

      public 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;
      Specified by:
      getPageSize in interface ListWorkflowsRequestOrBuilder
      Returns:
      The pageSize.

    • setPageSize

      public ListWorkflowsRequest.Builder setPageSize(int value)
       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;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public ListWorkflowsRequest.Builder clearPageSize()
       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:
      This builder for chaining.

    • getPageToken

      public 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;
      Specified by:
      getPageToken in interface ListWorkflowsRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public 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;
      Specified by:
      getPageTokenBytes in interface ListWorkflowsRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • setPageToken

      public ListWorkflowsRequest.Builder setPageToken(String value)
       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;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public ListWorkflowsRequest.Builder clearPageToken()
       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:
      This builder for chaining.

    • setPageTokenBytes

      public ListWorkflowsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

    • getFilter

      public 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;
      Specified by:
      getFilter in interface ListWorkflowsRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public 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;
      Specified by:
      getFilterBytes in interface ListWorkflowsRequestOrBuilder
      Returns:
      The bytes for filter.

    • setFilter

      public ListWorkflowsRequest.Builder setFilter(String value)
       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;
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

    • clearFilter

      public ListWorkflowsRequest.Builder clearFilter()
       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:
      This builder for chaining.

    • setFilterBytes

      public ListWorkflowsRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.

    • getOrderBy

      public 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;
      Specified by:
      getOrderBy in interface ListWorkflowsRequestOrBuilder
      Returns:
      The orderBy.

    • getOrderByBytes

      public 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;
      Specified by:
      getOrderByBytes in interface ListWorkflowsRequestOrBuilder
      Returns:
      The bytes for orderBy.

    • setOrderBy

      public ListWorkflowsRequest.Builder setOrderBy(String value)
       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;
      Parameters:
      value - The orderBy to set.
      Returns:
      This builder for chaining.

    • clearOrderBy

      public ListWorkflowsRequest.Builder clearOrderBy()
       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:
      This builder for chaining.

    • setOrderByBytes

      public ListWorkflowsRequest.Builder setOrderByBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for orderBy to set.
      Returns:
      This builder for chaining.