Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. workflows
  5. workflows/v1
  6. getWorkflow

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.workflows/v1.getWorkflow

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Gets details of a single workflow.

Using getWorkflow

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getWorkflow(args: GetWorkflowArgs, opts?: InvokeOptions): Promise<GetWorkflowResult>
function getWorkflowOutput(args: GetWorkflowOutputArgs, opts?: InvokeOptions): Output<GetWorkflowResult>
Copy
def get_workflow(location: Optional[str] = None,
                 project: Optional[str] = None,
                 revision_id: Optional[str] = None,
                 workflow_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetWorkflowResult
def get_workflow_output(location: Optional[pulumi.Input[str]] = None,
                 project: Optional[pulumi.Input[str]] = None,
                 revision_id: Optional[pulumi.Input[str]] = None,
                 workflow_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetWorkflowResult]
Copy
func LookupWorkflow(ctx *Context, args *LookupWorkflowArgs, opts ...InvokeOption) (*LookupWorkflowResult, error)
func LookupWorkflowOutput(ctx *Context, args *LookupWorkflowOutputArgs, opts ...InvokeOption) LookupWorkflowResultOutput
Copy

> Note: This function is named LookupWorkflow in the Go SDK.

public static class GetWorkflow 
{
    public static Task<GetWorkflowResult> InvokeAsync(GetWorkflowArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkflowResult> Invoke(GetWorkflowInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWorkflowResult> getWorkflow(GetWorkflowArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Copy
fn::invoke:
  function: google-native:workflows/v1:getWorkflow
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Location This property is required. string
WorkflowId This property is required. string
Project string
RevisionId string
Location This property is required. string
WorkflowId This property is required. string
Project string
RevisionId string
location This property is required. String
workflowId This property is required. String
project String
revisionId String
location This property is required. string
workflowId This property is required. string
project string
revisionId string
location This property is required. str
workflow_id This property is required. str
project str
revision_id str
location This property is required. String
workflowId This property is required. String
project String
revisionId String

getWorkflow Result

The following output properties are available:

CallLogLevel string
Optional. Describes the level of platform logging to apply to calls and call responses during executions of this workflow. If both the workflow and the execution specify a logging level, the execution level takes precedence.
CreateTime string
The timestamp for when the workflow was created. This is a workflow-wide field and is not tied to a specific revision.
CryptoKeyName string
Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using - as a wildcard for the {project} or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted.
Description string
Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision.
Labels Dictionary<string, string>
Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision.
Name string
The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}. This is a workflow-wide field and is not tied to a specific revision.
RevisionCreateTime string
The timestamp for the latest revision of the workflow's creation.
RevisionId string
The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - Service account - Workflow code to be executed The format is "000001-a4d", where the first six characters define the zero-padded revision ordinal number. They are followed by a hyphen and three hexadecimal random characters.
ServiceAccount string
The service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. Format: projects/{project}/serviceAccounts/{account} or {account} Using - as a wildcard for the {project} or not providing one at all will infer the project from the account. The {account} value can be the email address or the unique_id of the service account. If not provided, workflow will use the project's default service account. Modifying this field for an existing workflow results in a new workflow revision.
SourceContents string
Workflow code to be executed. The size limit is 128KB.
State string
State of the workflow deployment.
StateError Pulumi.GoogleNative.Workflows.V1.Outputs.StateErrorResponse
Error regarding the state of the workflow. For example, this field will have error details if the execution data is unavailable due to revoked KMS key permissions.
UpdateTime string
The timestamp for when the workflow was last updated. This is a workflow-wide field and is not tied to a specific revision.
UserEnvVars Dictionary<string, string>
Optional. User-defined environment variables associated with this workflow revision. This map has a maximum length of 20. Each string can take up to 40KiB. Keys cannot be empty strings and cannot start with “GOOGLE” or “WORKFLOWS".
CallLogLevel string
Optional. Describes the level of platform logging to apply to calls and call responses during executions of this workflow. If both the workflow and the execution specify a logging level, the execution level takes precedence.
CreateTime string
The timestamp for when the workflow was created. This is a workflow-wide field and is not tied to a specific revision.
CryptoKeyName string
Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using - as a wildcard for the {project} or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted.
Description string
Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision.
Labels map[string]string
Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision.
Name string
The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}. This is a workflow-wide field and is not tied to a specific revision.
RevisionCreateTime string
The timestamp for the latest revision of the workflow's creation.
RevisionId string
The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - Service account - Workflow code to be executed The format is "000001-a4d", where the first six characters define the zero-padded revision ordinal number. They are followed by a hyphen and three hexadecimal random characters.
ServiceAccount string
The service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. Format: projects/{project}/serviceAccounts/{account} or {account} Using - as a wildcard for the {project} or not providing one at all will infer the project from the account. The {account} value can be the email address or the unique_id of the service account. If not provided, workflow will use the project's default service account. Modifying this field for an existing workflow results in a new workflow revision.
SourceContents string
Workflow code to be executed. The size limit is 128KB.
State string
State of the workflow deployment.
StateError StateErrorResponse
Error regarding the state of the workflow. For example, this field will have error details if the execution data is unavailable due to revoked KMS key permissions.
UpdateTime string
The timestamp for when the workflow was last updated. This is a workflow-wide field and is not tied to a specific revision.
UserEnvVars map[string]string
Optional. User-defined environment variables associated with this workflow revision. This map has a maximum length of 20. Each string can take up to 40KiB. Keys cannot be empty strings and cannot start with “GOOGLE” or “WORKFLOWS".
callLogLevel String
Optional. Describes the level of platform logging to apply to calls and call responses during executions of this workflow. If both the workflow and the execution specify a logging level, the execution level takes precedence.
createTime String
The timestamp for when the workflow was created. This is a workflow-wide field and is not tied to a specific revision.
cryptoKeyName String
Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using - as a wildcard for the {project} or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted.
description String
Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision.
labels Map<String,String>
Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision.
name String
The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}. This is a workflow-wide field and is not tied to a specific revision.
revisionCreateTime String
The timestamp for the latest revision of the workflow's creation.
revisionId String
The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - Service account - Workflow code to be executed The format is "000001-a4d", where the first six characters define the zero-padded revision ordinal number. They are followed by a hyphen and three hexadecimal random characters.
serviceAccount String
The service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. Format: projects/{project}/serviceAccounts/{account} or {account} Using - as a wildcard for the {project} or not providing one at all will infer the project from the account. The {account} value can be the email address or the unique_id of the service account. If not provided, workflow will use the project's default service account. Modifying this field for an existing workflow results in a new workflow revision.
sourceContents String
Workflow code to be executed. The size limit is 128KB.
state String
State of the workflow deployment.
stateError StateErrorResponse
Error regarding the state of the workflow. For example, this field will have error details if the execution data is unavailable due to revoked KMS key permissions.
updateTime String
The timestamp for when the workflow was last updated. This is a workflow-wide field and is not tied to a specific revision.
userEnvVars Map<String,String>
Optional. User-defined environment variables associated with this workflow revision. This map has a maximum length of 20. Each string can take up to 40KiB. Keys cannot be empty strings and cannot start with “GOOGLE” or “WORKFLOWS".
callLogLevel string
Optional. Describes the level of platform logging to apply to calls and call responses during executions of this workflow. If both the workflow and the execution specify a logging level, the execution level takes precedence.
createTime string
The timestamp for when the workflow was created. This is a workflow-wide field and is not tied to a specific revision.
cryptoKeyName string
Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using - as a wildcard for the {project} or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted.
description string
Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision.
labels {[key: string]: string}
Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision.
name string
The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}. This is a workflow-wide field and is not tied to a specific revision.
revisionCreateTime string
The timestamp for the latest revision of the workflow's creation.
revisionId string
The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - Service account - Workflow code to be executed The format is "000001-a4d", where the first six characters define the zero-padded revision ordinal number. They are followed by a hyphen and three hexadecimal random characters.
serviceAccount string
The service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. Format: projects/{project}/serviceAccounts/{account} or {account} Using - as a wildcard for the {project} or not providing one at all will infer the project from the account. The {account} value can be the email address or the unique_id of the service account. If not provided, workflow will use the project's default service account. Modifying this field for an existing workflow results in a new workflow revision.
sourceContents string
Workflow code to be executed. The size limit is 128KB.
state string
State of the workflow deployment.
stateError StateErrorResponse
Error regarding the state of the workflow. For example, this field will have error details if the execution data is unavailable due to revoked KMS key permissions.
updateTime string
The timestamp for when the workflow was last updated. This is a workflow-wide field and is not tied to a specific revision.
userEnvVars {[key: string]: string}
Optional. User-defined environment variables associated with this workflow revision. This map has a maximum length of 20. Each string can take up to 40KiB. Keys cannot be empty strings and cannot start with “GOOGLE” or “WORKFLOWS".
call_log_level str
Optional. Describes the level of platform logging to apply to calls and call responses during executions of this workflow. If both the workflow and the execution specify a logging level, the execution level takes precedence.
create_time str
The timestamp for when the workflow was created. This is a workflow-wide field and is not tied to a specific revision.
crypto_key_name str
Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using - as a wildcard for the {project} or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted.
description str
Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision.
labels Mapping[str, str]
Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision.
name str
The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}. This is a workflow-wide field and is not tied to a specific revision.
revision_create_time str
The timestamp for the latest revision of the workflow's creation.
revision_id str
The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - Service account - Workflow code to be executed The format is "000001-a4d", where the first six characters define the zero-padded revision ordinal number. They are followed by a hyphen and three hexadecimal random characters.
service_account str
The service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. Format: projects/{project}/serviceAccounts/{account} or {account} Using - as a wildcard for the {project} or not providing one at all will infer the project from the account. The {account} value can be the email address or the unique_id of the service account. If not provided, workflow will use the project's default service account. Modifying this field for an existing workflow results in a new workflow revision.
source_contents str
Workflow code to be executed. The size limit is 128KB.
state str
State of the workflow deployment.
state_error StateErrorResponse
Error regarding the state of the workflow. For example, this field will have error details if the execution data is unavailable due to revoked KMS key permissions.
update_time str
The timestamp for when the workflow was last updated. This is a workflow-wide field and is not tied to a specific revision.
user_env_vars Mapping[str, str]
Optional. User-defined environment variables associated with this workflow revision. This map has a maximum length of 20. Each string can take up to 40KiB. Keys cannot be empty strings and cannot start with “GOOGLE” or “WORKFLOWS".
callLogLevel String
Optional. Describes the level of platform logging to apply to calls and call responses during executions of this workflow. If both the workflow and the execution specify a logging level, the execution level takes precedence.
createTime String
The timestamp for when the workflow was created. This is a workflow-wide field and is not tied to a specific revision.
cryptoKeyName String
Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using - as a wildcard for the {project} or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted.
description String
Description of the workflow provided by the user. Must be at most 1000 Unicode characters long. This is a workflow-wide field and is not tied to a specific revision.
labels Map<String>
Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. This is a workflow-wide field and is not tied to a specific revision.
name String
The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}. This is a workflow-wide field and is not tied to a specific revision.
revisionCreateTime String
The timestamp for the latest revision of the workflow's creation.
revisionId String
The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - Service account - Workflow code to be executed The format is "000001-a4d", where the first six characters define the zero-padded revision ordinal number. They are followed by a hyphen and three hexadecimal random characters.
serviceAccount String
The service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. Format: projects/{project}/serviceAccounts/{account} or {account} Using - as a wildcard for the {project} or not providing one at all will infer the project from the account. The {account} value can be the email address or the unique_id of the service account. If not provided, workflow will use the project's default service account. Modifying this field for an existing workflow results in a new workflow revision.
sourceContents String
Workflow code to be executed. The size limit is 128KB.
state String
State of the workflow deployment.
stateError Property Map
Error regarding the state of the workflow. For example, this field will have error details if the execution data is unavailable due to revoked KMS key permissions.
updateTime String
The timestamp for when the workflow was last updated. This is a workflow-wide field and is not tied to a specific revision.
userEnvVars Map<String>
Optional. User-defined environment variables associated with this workflow revision. This map has a maximum length of 20. Each string can take up to 40KiB. Keys cannot be empty strings and cannot start with “GOOGLE” or “WORKFLOWS".

Supporting Types

StateErrorResponse

Details This property is required. string
Provides specifics about the error.
Type This property is required. string
The type of this state error.
Details This property is required. string
Provides specifics about the error.
Type This property is required. string
The type of this state error.
details This property is required. String
Provides specifics about the error.
type This property is required. String
The type of this state error.
details This property is required. string
Provides specifics about the error.
type This property is required. string
The type of this state error.
details This property is required. str
Provides specifics about the error.
type This property is required. str
The type of this state error.
details This property is required. String
Provides specifics about the error.
type This property is required. String
The type of this state error.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native