google-native.dataform.v1beta1.getWorkflowConfig

Google Cloud Native v0.32.0, Nov 29 23

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

Schema (JSON)

pulumi/pulumi-google-native

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

Schema (JSON)

pulumi/pulumi-google-native

Using getWorkflowConfig

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 getWorkflowConfig(args: GetWorkflowConfigArgs, opts?: InvokeOptions): Promise<GetWorkflowConfigResult>
function getWorkflowConfigOutput(args: GetWorkflowConfigOutputArgs, opts?: InvokeOptions): Output<GetWorkflowConfigResult>

def get_workflow_config(location: Optional[str] = None,
                        project: Optional[str] = None,
                        repository_id: Optional[str] = None,
                        workflow_config_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetWorkflowConfigResult
def get_workflow_config_output(location: Optional[pulumi.Input[str]] = None,
                        project: Optional[pulumi.Input[str]] = None,
                        repository_id: Optional[pulumi.Input[str]] = None,
                        workflow_config_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetWorkflowConfigResult]

func LookupWorkflowConfig(ctx *Context, args *LookupWorkflowConfigArgs, opts ...InvokeOption) (*LookupWorkflowConfigResult, error)
func LookupWorkflowConfigOutput(ctx *Context, args *LookupWorkflowConfigOutputArgs, opts ...InvokeOption) LookupWorkflowConfigResultOutput

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

public static class GetWorkflowConfig 
{
    public static Task<GetWorkflowConfigResult> InvokeAsync(GetWorkflowConfigArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkflowConfigResult> Invoke(GetWorkflowConfigInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetWorkflowConfigResult> getWorkflowConfig(GetWorkflowConfigArgs args, InvokeOptions options)
public static Output<GetWorkflowConfigResult> getWorkflowConfig(GetWorkflowConfigArgs args, InvokeOptions options)

fn::invoke:
  function: google-native:dataform/v1beta1:getWorkflowConfig
  arguments:
    # arguments dictionary

The following arguments are supported:

Location string
RepositoryId string
WorkflowConfigId string
Project string

Location string
RepositoryId string
WorkflowConfigId string
Project string

location String
repositoryId String
workflowConfigId String
project String

location string
repositoryId string
workflowConfigId string
project string

location str
repository_id str
workflow_config_id str
project str

location String
repositoryId String
workflowConfigId String
project String

getWorkflowConfig Result

The following output properties are available:

CronSchedule string: Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
InvocationConfig Pulumi.GoogleNative.Dataform.V1Beta1.Outputs.InvocationConfigResponse: Optional. If left unset, a default InvocationConfig will be used.
Name string: The workflow config's name.
RecentScheduledExecutionRecords List<Pulumi.GoogleNative.Dataform.V1Beta1.Outputs.ScheduledExecutionRecordResponse>: Records of the 10 most recent scheduled execution attempts, ordered in in descending order of execution_time. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
ReleaseConfig string: The name of the release config whose release_compilation_result should be executed. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.
TimeZone string: Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.

CronSchedule string: Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
InvocationConfig InvocationConfigResponse: Optional. If left unset, a default InvocationConfig will be used.
Name string: The workflow config's name.
RecentScheduledExecutionRecords []ScheduledExecutionRecordResponse: Records of the 10 most recent scheduled execution attempts, ordered in in descending order of execution_time. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
ReleaseConfig string: The name of the release config whose release_compilation_result should be executed. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.
TimeZone string: Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.

cronSchedule String: Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
invocationConfig InvocationConfigResponse: Optional. If left unset, a default InvocationConfig will be used.
name String: The workflow config's name.
recentScheduledExecutionRecords List<ScheduledExecutionRecordResponse>: Records of the 10 most recent scheduled execution attempts, ordered in in descending order of execution_time. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
releaseConfig String: The name of the release config whose release_compilation_result should be executed. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.
timeZone String: Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.

cronSchedule string: Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
invocationConfig InvocationConfigResponse: Optional. If left unset, a default InvocationConfig will be used.
name string: The workflow config's name.
recentScheduledExecutionRecords ScheduledExecutionRecordResponse[]: Records of the 10 most recent scheduled execution attempts, ordered in in descending order of execution_time. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
releaseConfig string: The name of the release config whose release_compilation_result should be executed. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.
timeZone string: Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.

cron_schedule str: Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
invocation_config InvocationConfigResponse: Optional. If left unset, a default InvocationConfig will be used.
name str: The workflow config's name.
recent_scheduled_execution_records Sequence[ScheduledExecutionRecordResponse]: Records of the 10 most recent scheduled execution attempts, ordered in in descending order of execution_time. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
release_config str: The name of the release config whose release_compilation_result should be executed. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.
time_zone str: Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.

cronSchedule String: Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
invocationConfig Property Map: Optional. If left unset, a default InvocationConfig will be used.
name String: The workflow config's name.
recentScheduledExecutionRecords List<Property Map>: Records of the 10 most recent scheduled execution attempts, ordered in in descending order of execution_time. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule.
releaseConfig String: The name of the release config whose release_compilation_result should be executed. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.
timeZone String: Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.

Supporting Types

InvocationConfigResponse

FullyRefreshIncrementalTablesEnabled bool: Optional. When set to true, any incremental tables will be fully refreshed.
IncludedTags List<string>: Optional. The set of tags to include.
IncludedTargets List<Pulumi.GoogleNative.Dataform.V1Beta1.Inputs.TargetResponse>: Optional. The set of action identifiers to include.
ServiceAccount string: Optional. The service account to run workflow invocations under.
TransitiveDependenciesIncluded bool: Optional. When set to true, transitive dependencies of included actions will be executed.
TransitiveDependentsIncluded bool: Optional. When set to true, transitive dependents of included actions will be executed.

FullyRefreshIncrementalTablesEnabled bool: Optional. When set to true, any incremental tables will be fully refreshed.
IncludedTags []string: Optional. The set of tags to include.
IncludedTargets []TargetResponse: Optional. The set of action identifiers to include.
ServiceAccount string: Optional. The service account to run workflow invocations under.
TransitiveDependenciesIncluded bool: Optional. When set to true, transitive dependencies of included actions will be executed.
TransitiveDependentsIncluded bool: Optional. When set to true, transitive dependents of included actions will be executed.

fullyRefreshIncrementalTablesEnabled Boolean: Optional. When set to true, any incremental tables will be fully refreshed.
includedTags List<String>: Optional. The set of tags to include.
includedTargets List<TargetResponse>: Optional. The set of action identifiers to include.
serviceAccount String: Optional. The service account to run workflow invocations under.
transitiveDependenciesIncluded Boolean: Optional. When set to true, transitive dependencies of included actions will be executed.
transitiveDependentsIncluded Boolean: Optional. When set to true, transitive dependents of included actions will be executed.

fullyRefreshIncrementalTablesEnabled boolean: Optional. When set to true, any incremental tables will be fully refreshed.
includedTags string[]: Optional. The set of tags to include.
includedTargets TargetResponse[]: Optional. The set of action identifiers to include.
serviceAccount string: Optional. The service account to run workflow invocations under.
transitiveDependenciesIncluded boolean: Optional. When set to true, transitive dependencies of included actions will be executed.
transitiveDependentsIncluded boolean: Optional. When set to true, transitive dependents of included actions will be executed.

fully_refresh_incremental_tables_enabled bool: Optional. When set to true, any incremental tables will be fully refreshed.
included_tags Sequence[str]: Optional. The set of tags to include.
included_targets Sequence[TargetResponse]: Optional. The set of action identifiers to include.
service_account str: Optional. The service account to run workflow invocations under.
transitive_dependencies_included bool: Optional. When set to true, transitive dependencies of included actions will be executed.
transitive_dependents_included bool: Optional. When set to true, transitive dependents of included actions will be executed.

fullyRefreshIncrementalTablesEnabled Boolean: Optional. When set to true, any incremental tables will be fully refreshed.
includedTags List<String>: Optional. The set of tags to include.
includedTargets List<Property Map>: Optional. The set of action identifiers to include.
serviceAccount String: Optional. The service account to run workflow invocations under.
transitiveDependenciesIncluded Boolean: Optional. When set to true, transitive dependencies of included actions will be executed.
transitiveDependentsIncluded Boolean: Optional. When set to true, transitive dependents of included actions will be executed.

ScheduledExecutionRecordResponse

ErrorStatus Pulumi.GoogleNative.Dataform.V1Beta1.Inputs.StatusResponse: The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
ExecutionTime string: The timestamp of this execution attempt.
WorkflowInvocation string: The name of the created workflow invocation, if one was successfully created. Must be in the format projects/*/locations/*/repositories/*/workflowInvocations/*.

ErrorStatus StatusResponse: The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
ExecutionTime string: The timestamp of this execution attempt.
WorkflowInvocation string: The name of the created workflow invocation, if one was successfully created. Must be in the format projects/*/locations/*/repositories/*/workflowInvocations/*.

errorStatus StatusResponse: The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
executionTime String: The timestamp of this execution attempt.
workflowInvocation String: The name of the created workflow invocation, if one was successfully created. Must be in the format projects/*/locations/*/repositories/*/workflowInvocations/*.

errorStatus StatusResponse: The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
executionTime string: The timestamp of this execution attempt.
workflowInvocation string: The name of the created workflow invocation, if one was successfully created. Must be in the format projects/*/locations/*/repositories/*/workflowInvocations/*.

error_status StatusResponse: The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
execution_time str: The timestamp of this execution attempt.
workflow_invocation str: The name of the created workflow invocation, if one was successfully created. Must be in the format projects/*/locations/*/repositories/*/workflowInvocations/*.

errorStatus Property Map: The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.
executionTime String: The timestamp of this execution attempt.
workflowInvocation String: The name of the created workflow invocation, if one was successfully created. Must be in the format projects/*/locations/*/repositories/*/workflowInvocations/*.

StatusResponse

Code int: The status code, which should be an enum value of google.rpc.Code.
Details List<ImmutableDictionary<string, string>>: A list of messages that carry the error details. There is a common set of message types for APIs to use.
Message string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Code int: The status code, which should be an enum value of google.rpc.Code.
Details []map[string]string: A list of messages that carry the error details. There is a common set of message types for APIs to use.
Message string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code Integer: The status code, which should be an enum value of google.rpc.Code.
details List<Map<String,String>>: A list of messages that carry the error details. There is a common set of message types for APIs to use.
message String: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code number: The status code, which should be an enum value of google.rpc.Code.
details {[key: string]: string}[]: A list of messages that carry the error details. There is a common set of message types for APIs to use.
message string: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code int: The status code, which should be an enum value of google.rpc.Code.
details Sequence[Mapping[str, str]]: A list of messages that carry the error details. There is a common set of message types for APIs to use.
message str: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code Number: The status code, which should be an enum value of google.rpc.Code.
details List<Map<String>>: A list of messages that carry the error details. There is a common set of message types for APIs to use.
message String: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

TargetResponse

Database string: The action's database (Google Cloud project ID) .
Name string: The action's name, within database and schema.
Schema string: The action's schema (BigQuery dataset ID), within database.

Database string: The action's database (Google Cloud project ID) .
Name string: The action's name, within database and schema.
Schema string: The action's schema (BigQuery dataset ID), within database.

database String: The action's database (Google Cloud project ID) .
name String: The action's name, within database and schema.
schema String: The action's schema (BigQuery dataset ID), within database.

database string: The action's database (Google Cloud project ID) .
name string: The action's name, within database and schema.
schema string: The action's schema (BigQuery dataset ID), within database.

database str: The action's database (Google Cloud project ID) .
name str: The action's name, within database and schema.
schema str: The action's schema (BigQuery dataset ID), within database.

database String: The action's database (Google Cloud project ID) .
name String: The action's name, within database and schema.
schema String: The action's schema (BigQuery dataset ID), within database.