Package com.google.cloud.workflows.v1 (2.16.0)

A client to Workflows API

The interfaces provided are listed below, along with usage samples.

WorkflowsClient

Service Description: Workflows is used to deploy and execute workflow programs. Workflows makes sure the program executes reliably, despite hardware and networking interruptions.

Sample for WorkflowsClient:


 // 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()) {
   WorkflowName name = WorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]");
   Workflow response = workflowsClient.getWorkflow(name);
 }

Classes

CreateWorkflowRequest

Request for the CreateWorkflow method.

Protobuf type google.cloud.workflows.v1.CreateWorkflowRequest

CreateWorkflowRequest.Builder

Request for the CreateWorkflow method.

Protobuf type google.cloud.workflows.v1.CreateWorkflowRequest

DeleteWorkflowRequest

Request for the DeleteWorkflow method.

Protobuf type google.cloud.workflows.v1.DeleteWorkflowRequest

DeleteWorkflowRequest.Builder

Request for the DeleteWorkflow method.

Protobuf type google.cloud.workflows.v1.DeleteWorkflowRequest

GetWorkflowRequest

Request for the GetWorkflow method.

Protobuf type google.cloud.workflows.v1.GetWorkflowRequest

GetWorkflowRequest.Builder

Request for the GetWorkflow method.

Protobuf type google.cloud.workflows.v1.GetWorkflowRequest

ListWorkflowsRequest

Request for the ListWorkflows method.

Protobuf type google.cloud.workflows.v1.ListWorkflowsRequest

ListWorkflowsRequest.Builder

Request for the ListWorkflows method.

Protobuf type google.cloud.workflows.v1.ListWorkflowsRequest

ListWorkflowsResponse

Response for the ListWorkflows method.

Protobuf type google.cloud.workflows.v1.ListWorkflowsResponse

ListWorkflowsResponse.Builder

Response for the ListWorkflows method.

Protobuf type google.cloud.workflows.v1.ListWorkflowsResponse

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

OperationMetadata

Represents the metadata of the long-running operation.

Protobuf type google.cloud.workflows.v1.OperationMetadata

OperationMetadata.Builder

Represents the metadata of the long-running operation.

Protobuf type google.cloud.workflows.v1.OperationMetadata

UpdateWorkflowRequest

Request for the UpdateWorkflow method.

Protobuf type google.cloud.workflows.v1.UpdateWorkflowRequest

UpdateWorkflowRequest.Builder

Request for the UpdateWorkflow method.

Protobuf type google.cloud.workflows.v1.UpdateWorkflowRequest

Workflow

Workflow program to be executed by Workflows.

Protobuf type google.cloud.workflows.v1.Workflow

Workflow.Builder

Workflow program to be executed by Workflows.

Protobuf type google.cloud.workflows.v1.Workflow

WorkflowName

WorkflowName.Builder

Builder for projects/{project}/locations/{location}/workflows/{workflow}.

WorkflowsClient

Service Description: Workflows is used to deploy and execute workflow programs. Workflows makes sure the program executes reliably, despite hardware and networking interruptions.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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()) {
   WorkflowName name = WorkflowName.of("[PROJECT]", "[LOCATION]", "[WORKFLOW]");
   Workflow response = workflowsClient.getWorkflow(name);
 }

Note: close() needs to be called on the WorkflowsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of WorkflowsSettings to create(). For example:

To customize credentials:


 // 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
 WorkflowsSettings workflowsSettings =
     WorkflowsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 WorkflowsClient workflowsClient = WorkflowsClient.create(workflowsSettings);

To customize the endpoint:


 // 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
 WorkflowsSettings workflowsSettings =
     WorkflowsSettings.newBuilder().setEndpoint(myEndpoint).build();
 WorkflowsClient workflowsClient = WorkflowsClient.create(workflowsSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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
 WorkflowsSettings workflowsSettings = WorkflowsSettings.newHttpJsonBuilder().build();
 WorkflowsClient workflowsClient = WorkflowsClient.create(workflowsSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

WorkflowsClient.ListWorkflowsFixedSizeCollection

WorkflowsClient.ListWorkflowsPage

WorkflowsClient.ListWorkflowsPagedResponse

WorkflowsGrpc

Workflows is used to deploy and execute workflow programs. Workflows makes sure the program executes reliably, despite hardware and networking interruptions.

WorkflowsGrpc.WorkflowsBlockingStub

A stub to allow clients to do synchronous rpc calls to service Workflows.

Workflows is used to deploy and execute workflow programs. Workflows makes sure the program executes reliably, despite hardware and networking interruptions.

WorkflowsGrpc.WorkflowsFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Workflows.

Workflows is used to deploy and execute workflow programs. Workflows makes sure the program executes reliably, despite hardware and networking interruptions.

WorkflowsGrpc.WorkflowsImplBase

Base class for the server implementation of the service Workflows.

Workflows is used to deploy and execute workflow programs. Workflows makes sure the program executes reliably, despite hardware and networking interruptions.

WorkflowsGrpc.WorkflowsStub

A stub to allow clients to do asynchronous rpc calls to service Workflows.

Workflows is used to deploy and execute workflow programs. Workflows makes sure the program executes reliably, despite hardware and networking interruptions.

WorkflowsProto

WorkflowsSettings

Settings class to configure an instance of WorkflowsClient.

The default instance has everything set to sensible defaults:

  • The default service address (workflows.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getWorkflow to 30 seconds:


 // 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
 WorkflowsSettings.Builder workflowsSettingsBuilder = WorkflowsSettings.newBuilder();
 workflowsSettingsBuilder
     .getWorkflowSettings()
     .setRetrySettings(
         workflowsSettingsBuilder
             .getWorkflowSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 WorkflowsSettings workflowsSettings = workflowsSettingsBuilder.build();

WorkflowsSettings.Builder

Builder for WorkflowsSettings.

Interfaces

CreateWorkflowRequestOrBuilder

DeleteWorkflowRequestOrBuilder

GetWorkflowRequestOrBuilder

ListWorkflowsRequestOrBuilder

ListWorkflowsResponseOrBuilder

OperationMetadataOrBuilder

UpdateWorkflowRequestOrBuilder

WorkflowOrBuilder

WorkflowsGrpc.AsyncService

Workflows is used to deploy and execute workflow programs. Workflows makes sure the program executes reliably, despite hardware and networking interruptions.

Enums

Workflow.SourceCodeCase

Workflow.State

Describes the current state of workflow deployment. More states may be added in the future.

Protobuf enum google.cloud.workflows.v1.Workflow.State