List workflows using Python or Ruby

Lists workflows using Python or Ruby.

Code sample

C#

Before trying this sample, follow the C# setup instructions in the Workflows quickstart using client libraries . For more information, see the Workflows C# API reference documentation .

To authenticate to Workflows, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  using 
  
  Google.Api.Gax 
 
 ; 
 using 
  
  Google.Api.Gax.ResourceNames 
 
 ; 
 using 
  
  Google.Cloud.Workflows.V1 
 
 ; 
 using 
  
 System 
 ; 
 public 
  
 sealed 
  
 partial 
  
 class 
  
 GeneratedWorkflowsClientSnippets 
 { 
  
 /// <summary>Snippet for ListWorkflows</summary> 
  
 /// <remarks> 
  
 /// This snippet has been automatically generated and should be regarded as a code template only. 
  
 /// It will require modifications to work: 
  
 /// - It may require correct/in-range values for request initialization. 
  
 /// - It may require specifying regional endpoints when creating the service client as shown in 
  
 ///   https://cloud.google.com/dotnet/docs/reference/help/client-configuration#endpoint. 
  
 /// </remarks> 
  
 public 
  
 void 
  
 ListWorkflowsRequestObject 
 () 
  
 { 
  
 // Create client 
  
  WorkflowsClient 
 
  
 workflowsClient 
  
 = 
  
  WorkflowsClient 
 
 . 
  Create 
 
 (); 
  
 // Initialize request argument(s) 
  
  ListWorkflowsRequest 
 
  
 request 
  
 = 
  
 new 
  
  ListWorkflowsRequest 
 
  
 { 
  
 ParentAsLocationName 
  
 = 
  
  LocationName 
 
 . 
  FromProjectLocation 
 
 ( 
 "[PROJECT]" 
 , 
  
 "[LOCATION]" 
 ), 
  
 Filter 
  
 = 
  
 "" 
 , 
  
 OrderBy 
  
 = 
  
 "" 
 , 
  
 }; 
  
 // Make the request 
  
 PagedEnumerable<ListWorkflowsResponse 
 , 
  
 Workflow 
>  
 response 
  
 = 
  
 workflowsClient 
 . 
  ListWorkflows 
 
 ( 
 request 
 ); 
  
 // Iterate over all response items, lazily performing RPCs as required 
  
 foreach 
  
 ( 
 Workflow 
  
 item 
  
 in 
  
 response 
 ) 
  
 { 
  
 // Do something with each item 
  
 Console 
 . 
 WriteLine 
 ( 
 item 
 ); 
  
 } 
  
 // Or iterate over pages (of server-defined size), performing one RPC per page 
  
 foreach 
  
 ( 
  ListWorkflowsResponse 
 
  
 page 
  
 in 
  
 response 
 . 
 AsRawResponses 
 ()) 
  
 { 
  
 // Do something with each page of items 
  
 Console 
 . 
 WriteLine 
 ( 
 "A page of results:" 
 ); 
  
 foreach 
  
 ( 
 Workflow 
  
 item 
  
 in 
  
 page 
 ) 
  
 { 
  
 // Do something with each item 
  
 Console 
 . 
 WriteLine 
 ( 
 item 
 ); 
  
 } 
  
 } 
  
 // Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required 
  
 int 
  
 pageSize 
  
 = 
  
 10 
 ; 
  
 Page<Workflow> 
  
 singlePage 
  
 = 
  
 response 
 . 
 ReadPage 
 ( 
 pageSize 
 ); 
  
 // Do something with the page of items 
  
 Console 
 . 
 WriteLine 
 ( 
 $"A page of {pageSize} results (unless it's the final page):" 
 ); 
  
 foreach 
  
 ( 
 Workflow 
  
 item 
  
 in 
  
 singlePage 
 ) 
  
 { 
  
 // Do something with each item 
  
 Console 
 . 
 WriteLine 
 ( 
 item 
 ); 
  
 } 
  
 // Store the pageToken, for when the next page is required. 
  
 string 
  
 nextPageToken 
  
 = 
  
 singlePage 
 . 
 NextPageToken 
 ; 
  
 } 
 } 
 

Go

Before trying this sample, follow the Go setup instructions in the Workflows quickstart using client libraries . For more information, see the Workflows Go API reference documentation .

To authenticate to Workflows, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  package 
  
 main 
 import 
  
 ( 
  
 "context" 
  
 workflows 
  
 "cloud.google.com/go/workflows/apiv1" 
  
 workflowspb 
  
 "cloud.google.com/go/workflows/apiv1/workflowspb" 
  
 "google.golang.org/api/iterator" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 // This snippet has been automatically generated and should be regarded as a code template only. 
  
 // It will require modifications to work: 
  
 // - It may require correct/in-range values for request initialization. 
  
 // - It may require specifying regional endpoints when creating the service client as shown in: 
  
 //   https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options 
  
 c 
 , 
  
 err 
  
 := 
  
 workflows 
 . 
  NewClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 defer 
  
 c 
 . 
  Close 
 
 () 
  
 req 
  
 := 
  
& workflowspb 
 . 
 ListWorkflowsRequest 
 { 
  
 // TODO: Fill request struct fields. 
  
 // See https://pkg.go.dev/cloud.google.com/go/workflows/apiv1/workflowspb#ListWorkflowsRequest. 
  
 } 
  
 it 
  
 := 
  
 c 
 . 
 ListWorkflows 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 for 
  
 { 
  
 resp 
 , 
  
 err 
  
 := 
  
 it 
 . 
 Next 
 () 
  
 if 
  
 err 
  
 == 
  
 iterator 
 . 
 Done 
  
 { 
  
 break 
  
 } 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 // TODO: Handle error. 
  
 } 
  
 // TODO: Use resp. 
  
 _ 
  
 = 
  
 resp 
  
 // If you need to access the underlying RPC response, 
  
 // you can do so by casting the `Response` as below. 
  
 // Otherwise, remove this line. Only populated after 
  
 // first call to Next(). Not safe for concurrent access. 
  
 _ 
  
 = 
  
 it 
 . 
 Response 
 .( 
 * 
 workflowspb 
 . 
 ListWorkflowsResponse 
 ) 
  
 } 
 } 
 

Java

Before trying this sample, follow the Java setup instructions in the Workflows quickstart using client libraries . For more information, see the Workflows Java API reference documentation .

To authenticate to Workflows, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  import 
  
 com.google.cloud.workflows.v1. ListWorkflowsRequest 
 
 ; 
 import 
  
 com.google.cloud.workflows.v1. LocationName 
 
 ; 
 import 
  
 com.google.cloud.workflows.v1. Workflow 
 
 ; 
 import 
  
 com.google.cloud.workflows.v1. WorkflowsClient 
 
 ; 
 public 
  
 class 
 SyncListWorkflows 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 [] 
  
 args 
 ) 
  
 throws 
  
 Exception 
  
 { 
  
 syncListWorkflows 
 (); 
  
 } 
  
 public 
  
 static 
  
 void 
  
 syncListWorkflows 
 () 
  
 throws 
  
 Exception 
  
 { 
  
 // This snippet has been automatically generated and should be regarded as a code template only. 
  
 // It will require modifications to work: 
  
 // - It may require correct/in-range values for request initialization. 
  
 // - It may require specifying regional endpoints when creating the service client as shown in 
  
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 
  
 try 
  
 ( 
  WorkflowsClient 
 
  
 workflowsClient 
  
 = 
  
  WorkflowsClient 
 
 . 
 create 
 ()) 
  
 { 
  
  ListWorkflowsRequest 
 
  
 request 
  
 = 
  
  ListWorkflowsRequest 
 
 . 
 newBuilder 
 () 
  
 . 
 setParent 
 ( 
  LocationName 
 
 . 
 of 
 ( 
 "[PROJECT]" 
 , 
  
 "[LOCATION]" 
 ). 
 toString 
 ()) 
  
 . 
 setPageSize 
 ( 
 883849137 
 ) 
  
 . 
 setPageToken 
 ( 
 "pageToken873572522" 
 ) 
  
 . 
  setFilter 
 
 ( 
 "filter-1274492040" 
 ) 
  
 . 
  setOrderBy 
 
 ( 
 "orderBy-1207110587" 
 ) 
  
 . 
 build 
 (); 
  
 for 
  
 ( 
  Workflow 
 
  
 element 
  
 : 
  
 workflowsClient 
 . 
 listWorkflows 
 ( 
 request 
 ). 
 iterateAll 
 ()) 
  
 { 
  
 // doThingsWith(element); 
  
 } 
  
 } 
  
 } 
 } 
 

Python

Before trying this sample, follow the Python setup instructions in the Workflows quickstart using client libraries . For more information, see the Workflows Python API reference documentation .

To authenticate to Workflows, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  # This snippet has been automatically generated and should be regarded as a 
 # code template only. 
 # It will require modifications to work: 
 # - It may require correct/in-range values for request initialization. 
 # - It may require specifying regional endpoints when creating the service 
 #   client as shown in: 
 #   https://googleapis.dev/python/google-api-core/latest/client_options.html 
 from 
  
 google.cloud 
  
 import 
  workflows 
 
_v1 def 
  
 sample_list_workflows 
 (): 
 # Create a client 
 client 
 = 
 workflows_v1 
 . 
  WorkflowsClient 
 
 () 
 # Initialize request argument(s) 
 request 
 = 
 workflows_v1 
 . 
  ListWorkflowsRequest 
 
 ( 
 parent 
 = 
 "parent_value" 
 , 
 ) 
 # Make the request 
 page_result 
 = 
 client 
 . 
  list_workflows 
 
 ( 
 request 
 = 
 request 
 ) 
 # Handle the response 
 for 
 response 
 in 
 page_result 
 : 
 print 
 ( 
 response 
 ) 
 

Ruby

Before trying this sample, follow the Ruby setup instructions in the Workflows quickstart using client libraries . For more information, see the Workflows Ruby API reference documentation .

To authenticate to Workflows, set up Application Default Credentials. For more information, see Set up authentication for a local development environment .

  require 
  
 "google/cloud/workflows/v1" 
 ## 
 # Snippet for the list_workflows call in the Workflows service 
 # 
 # This snippet has been automatically generated and should be regarded as a code 
 # template only. It will require modifications to work: 
 # - It may require correct/in-range values for request initialization. 
 # - It may require specifying regional endpoints when creating the service 
 # client as shown in https://cloud.google.com/ruby/docs/reference. 
 # 
 # This is an auto-generated example demonstrating basic usage of 
 # Google::Cloud::Workflows::V1::Workflows::Client#list_workflows. 
 # 
 def 
  
 list_workflows 
  
 # Create a client object. The client can be reused for multiple calls. 
  
 client 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
 Workflows 
 :: 
 V1 
 :: 
 Workflows 
 :: 
 Client 
 . 
 new 
  
 # Create a request. To set request fields, pass in keyword arguments. 
  
 request 
  
 = 
  
 Google 
 :: 
 Cloud 
 :: 
 Workflows 
 :: 
 V1 
 :: 
 ListWorkflowsRequest 
 . 
 new 
  
 # Call the list_workflows method. 
  
 result 
  
 = 
  
 client 
 . 
 list_workflows 
  
 request 
  
 # The returned object is of type Gapic::PagedEnumerable. You can iterate 
  
 # over elements, and API calls will be issued to fetch pages as needed. 
  
 result 
 . 
 each 
  
 do 
  
 | 
 item 
 | 
  
 # Each element is of type ::Google::Cloud::Workflows::V1::Workflow. 
  
 p 
  
 item 
  
 end 
 end 
 

What's next

To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser .

Create a Mobile Website
View Site in Mobile | Classic
Share by: