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 for illustrative purposes only.
// It may require modifications to work in your environment.
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.v1beta.CreateWorkflowRequest
CreateWorkflowRequest.Builder
Request for the CreateWorkflow method.
Protobuf type google.cloud.workflows.v1beta.CreateWorkflowRequest
DeleteWorkflowRequest
Request for the DeleteWorkflow method.
Protobuf type google.cloud.workflows.v1beta.DeleteWorkflowRequest
DeleteWorkflowRequest.Builder
Request for the DeleteWorkflow method.
Protobuf type google.cloud.workflows.v1beta.DeleteWorkflowRequest
GetWorkflowRequest
Request for the GetWorkflow method.
Protobuf type google.cloud.workflows.v1beta.GetWorkflowRequest
GetWorkflowRequest.Builder
Request for the GetWorkflow method.
Protobuf type google.cloud.workflows.v1beta.GetWorkflowRequest
ListWorkflowsRequest
Request for the ListWorkflows method.
Protobuf type google.cloud.workflows.v1beta.ListWorkflowsRequest
ListWorkflowsRequest.Builder
Request for the ListWorkflows method.
Protobuf type google.cloud.workflows.v1beta.ListWorkflowsRequest
ListWorkflowsResponse
Response for the ListWorkflows method.
Protobuf type google.cloud.workflows.v1beta.ListWorkflowsResponse
ListWorkflowsResponse.Builder
Response for the ListWorkflows method.
Protobuf type google.cloud.workflows.v1beta.ListWorkflowsResponse
LocationName
LocationName.Builder
Builder for projects/{project}/locations/{location}.
OperationMetadata
Represents the metadata of the long-running operation.
Protobuf type google.cloud.workflows.v1beta.OperationMetadata
OperationMetadata.Builder
Represents the metadata of the long-running operation.
Protobuf type google.cloud.workflows.v1beta.OperationMetadata
UpdateWorkflowRequest
Request for the UpdateWorkflow method.
Protobuf type google.cloud.workflows.v1beta.UpdateWorkflowRequest
UpdateWorkflowRequest.Builder
Request for the UpdateWorkflow method.
Protobuf type google.cloud.workflows.v1beta.UpdateWorkflowRequest
Workflow
Workflow program to be executed by Workflows.
Protobuf type google.cloud.workflows.v1beta.Workflow
Workflow.Builder
Workflow program to be executed by Workflows.
Protobuf type google.cloud.workflows.v1beta.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 for illustrative purposes only.
// It may require modifications to work in your environment.
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:
- 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.
- 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.
- 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 for illustrative purposes only.
// It may require modifications to work in your environment.
WorkflowsSettings workflowsSettings =
WorkflowsSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
WorkflowsClient workflowsClient = WorkflowsClient.create(workflowsSettings);
To customize the endpoint:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
WorkflowsSettings workflowsSettings =
WorkflowsSettings.newBuilder().setEndpoint(myEndpoint).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
Workflows is used to deploy and execute workflow programs. Workflows makes sure the program executes reliably, despite hardware and networking interruptions.
WorkflowsGrpc.WorkflowsFutureStub
Workflows is used to deploy and execute workflow programs. Workflows makes sure the program executes reliably, despite hardware and networking interruptions.
WorkflowsGrpc.WorkflowsImplBase
Workflows is used to deploy and execute workflow programs. Workflows makes sure the program executes reliably, despite hardware and networking interruptions.
WorkflowsGrpc.WorkflowsStub
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 for illustrative purposes only.
// It may require modifications to work in your environment.
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
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.v1beta.Workflow.State