Package com.google.cloud.workflows.v1

Class ListWorkflowsRequest

  • All Implemented Interfaces:
    ListWorkflowsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ListWorkflowsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListWorkflowsRequestOrBuilder
     Request for the
 [ListWorkflows][google.cloud.workflows.v1.Workflows.ListWorkflows]
 method.
    Protobuf type google.cloud.workflows.v1.ListWorkflowsRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ListWorkflowsRequest.Builder
      Request for the [ListWorkflows][google.cloud.workflows.v1.Workflows.ListWorkflows] method.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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.

      • 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.

      • 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.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         Filter to restrict results to specific workflows.
        string filter = 4;
        Specified by:
        getFilterBytes in interface ListWorkflowsRequestOrBuilder
        Returns:
        The bytes for filter.

      • 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.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ListWorkflowsRequest parseFrom​(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListWorkflowsRequest parseFrom​(ByteBuffer data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListWorkflowsRequest parseFrom​(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListWorkflowsRequest parseFrom​(com.google.protobuf.ByteString data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListWorkflowsRequest parseFrom​(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ListWorkflowsRequest parseFrom​(byte[] data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected ListWorkflowsRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ListWorkflowsRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

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