Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. dataform
  5. dataform/v1beta1
  6. WorkflowInvocation

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.dataform/v1beta1.WorkflowInvocation

Explore with Pulumi AI

google-native logo

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

    Creates a new WorkflowInvocation in a given Repository. Auto-naming is currently not supported for this resource.

    Create WorkflowInvocation Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new WorkflowInvocation(name: string, args: WorkflowInvocationArgs, opts?: CustomResourceOptions);
    @overload
def WorkflowInvocation(resource_name: str,
                       args: WorkflowInvocationArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def WorkflowInvocation(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       repository_id: Optional[str] = None,
                       compilation_result: Optional[str] = None,
                       invocation_config: Optional[InvocationConfigArgs] = None,
                       location: Optional[str] = None,
                       project: Optional[str] = None,
                       workflow_config: Optional[str] = None)
    func NewWorkflowInvocation(ctx *Context, name string, args WorkflowInvocationArgs, opts ...ResourceOption) (*WorkflowInvocation, error)
    public WorkflowInvocation(string name, WorkflowInvocationArgs args, CustomResourceOptions? opts = null)
    public WorkflowInvocation(String name, WorkflowInvocationArgs args)
public WorkflowInvocation(String name, WorkflowInvocationArgs args, CustomResourceOptions options)

    type: google-native:dataform/v1beta1:WorkflowInvocation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args WorkflowInvocationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WorkflowInvocationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WorkflowInvocationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkflowInvocationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkflowInvocationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var workflowInvocationResource = new GoogleNative.Dataform.V1Beta1.WorkflowInvocation("workflowInvocationResource", new()
{
    RepositoryId = "string",
    CompilationResult = "string",
    InvocationConfig = new GoogleNative.Dataform.V1Beta1.Inputs.InvocationConfigArgs
    {
        FullyRefreshIncrementalTablesEnabled = false,
        IncludedTags = new[]
        {
            "string",
        },
        IncludedTargets = new[]
        {
            new GoogleNative.Dataform.V1Beta1.Inputs.TargetArgs
            {
                Database = "string",
                Name = "string",
                Schema = "string",
            },
        },
        ServiceAccount = "string",
        TransitiveDependenciesIncluded = false,
        TransitiveDependentsIncluded = false,
    },
    Location = "string",
    Project = "string",
    WorkflowConfig = "string",
});

    example, err := dataform.NewWorkflowInvocation(ctx, "workflowInvocationResource", &dataform.WorkflowInvocationArgs{
RepositoryId: pulumi.String("string"),
CompilationResult: pulumi.String("string"),
InvocationConfig: &dataform.InvocationConfigArgs{
FullyRefreshIncrementalTablesEnabled: pulumi.Bool(false),
IncludedTags: pulumi.StringArray{
pulumi.String("string"),
},
IncludedTargets: dataform.TargetArray{
&dataform.TargetArgs{
Database: pulumi.String("string"),
Name: pulumi.String("string"),
Schema: pulumi.String("string"),
},
},
ServiceAccount: pulumi.String("string"),
TransitiveDependenciesIncluded: pulumi.Bool(false),
TransitiveDependentsIncluded: pulumi.Bool(false),
},
Location: pulumi.String("string"),
Project: pulumi.String("string"),
WorkflowConfig: pulumi.String("string"),
})

    var workflowInvocationResource = new WorkflowInvocation("workflowInvocationResource", WorkflowInvocationArgs.builder()        
    .repositoryId("string")
    .compilationResult("string")
    .invocationConfig(InvocationConfigArgs.builder()
        .fullyRefreshIncrementalTablesEnabled(false)
        .includedTags("string")
        .includedTargets(TargetArgs.builder()
            .database("string")
            .name("string")
            .schema("string")
            .build())
        .serviceAccount("string")
        .transitiveDependenciesIncluded(false)
        .transitiveDependentsIncluded(false)
        .build())
    .location("string")
    .project("string")
    .workflowConfig("string")
    .build());

    workflow_invocation_resource = google_native.dataform.v1beta1.WorkflowInvocation("workflowInvocationResource",
    repository_id="string",
    compilation_result="string",
    invocation_config=google_native.dataform.v1beta1.InvocationConfigArgs(
        fully_refresh_incremental_tables_enabled=False,
        included_tags=["string"],
        included_targets=[google_native.dataform.v1beta1.TargetArgs(
            database="string",
            name="string",
            schema="string",
        )],
        service_account="string",
        transitive_dependencies_included=False,
        transitive_dependents_included=False,
    ),
    location="string",
    project="string",
    workflow_config="string")

    const workflowInvocationResource = new google_native.dataform.v1beta1.WorkflowInvocation("workflowInvocationResource", {
    repositoryId: "string",
    compilationResult: "string",
    invocationConfig: {
        fullyRefreshIncrementalTablesEnabled: false,
        includedTags: ["string"],
        includedTargets: [{
            database: "string",
            name: "string",
            schema: "string",
        }],
        serviceAccount: "string",
        transitiveDependenciesIncluded: false,
        transitiveDependentsIncluded: false,
    },
    location: "string",
    project: "string",
    workflowConfig: "string",
});

    type: google-native:dataform/v1beta1:WorkflowInvocation
properties:
    compilationResult: string
    invocationConfig:
        fullyRefreshIncrementalTablesEnabled: false
        includedTags:
            - string
        includedTargets:
            - database: string
              name: string
              schema: string
        serviceAccount: string
        transitiveDependenciesIncluded: false
        transitiveDependentsIncluded: false
    location: string
    project: string
    repositoryId: string
    workflowConfig: string

    WorkflowInvocation Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The WorkflowInvocation resource accepts the following input properties:

    RepositoryId string
    CompilationResult string
    Immutable. The name of the compilation result to use for this invocation. Must be in the format projects/*/locations/*/repositories/*/compilationResults/*.
    InvocationConfig Pulumi.GoogleNative.Dataform.V1Beta1.Inputs.InvocationConfig
    Immutable. If left unset, a default InvocationConfig will be used.
    Location string
    Project string
    WorkflowConfig string
    Immutable. The name of the workflow config to invoke. Must be in the format projects/*/locations/*/repositories/*/workflowConfigs/*.
    RepositoryId string
    CompilationResult string
    Immutable. The name of the compilation result to use for this invocation. Must be in the format projects/*/locations/*/repositories/*/compilationResults/*.
    InvocationConfig InvocationConfigArgs
    Immutable. If left unset, a default InvocationConfig will be used.
    Location string
    Project string
    WorkflowConfig string
    Immutable. The name of the workflow config to invoke. Must be in the format projects/*/locations/*/repositories/*/workflowConfigs/*.
    repositoryId String
    compilationResult String
    Immutable. The name of the compilation result to use for this invocation. Must be in the format projects/*/locations/*/repositories/*/compilationResults/*.
    invocationConfig InvocationConfig
    Immutable. If left unset, a default InvocationConfig will be used.
    location String
    project String
    workflowConfig String
    Immutable. The name of the workflow config to invoke. Must be in the format projects/*/locations/*/repositories/*/workflowConfigs/*.
    repositoryId string
    compilationResult string
    Immutable. The name of the compilation result to use for this invocation. Must be in the format projects/*/locations/*/repositories/*/compilationResults/*.
    invocationConfig InvocationConfig
    Immutable. If left unset, a default InvocationConfig will be used.
    location string
    project string
    workflowConfig string
    Immutable. The name of the workflow config to invoke. Must be in the format projects/*/locations/*/repositories/*/workflowConfigs/*.
    repository_id str
    compilation_result str
    Immutable. The name of the compilation result to use for this invocation. Must be in the format projects/*/locations/*/repositories/*/compilationResults/*.
    invocation_config InvocationConfigArgs
    Immutable. If left unset, a default InvocationConfig will be used.
    location str
    project str
    workflow_config str
    Immutable. The name of the workflow config to invoke. Must be in the format projects/*/locations/*/repositories/*/workflowConfigs/*.
    repositoryId String
    compilationResult String
    Immutable. The name of the compilation result to use for this invocation. Must be in the format projects/*/locations/*/repositories/*/compilationResults/*.
    invocationConfig Property Map
    Immutable. If left unset, a default InvocationConfig will be used.
    location String
    project String
    workflowConfig String
    Immutable. The name of the workflow config to invoke. Must be in the format projects/*/locations/*/repositories/*/workflowConfigs/*.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WorkflowInvocation resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    InvocationTiming Pulumi.GoogleNative.Dataform.V1Beta1.Outputs.IntervalResponse
    This workflow invocation's timing details.
    Name string
    The workflow invocation's name.
    ResolvedCompilationResult string
    The resolved compilation result that was used to create this invocation. Will be in the format projects/*/locations/*/repositories/*/compilationResults/*.
    State string
    This workflow invocation's current state.
    Id string
    The provider-assigned unique ID for this managed resource.
    InvocationTiming IntervalResponse
    This workflow invocation's timing details.
    Name string
    The workflow invocation's name.
    ResolvedCompilationResult string
    The resolved compilation result that was used to create this invocation. Will be in the format projects/*/locations/*/repositories/*/compilationResults/*.
    State string
    This workflow invocation's current state.
    id String
    The provider-assigned unique ID for this managed resource.
    invocationTiming IntervalResponse
    This workflow invocation's timing details.
    name String
    The workflow invocation's name.
    resolvedCompilationResult String
    The resolved compilation result that was used to create this invocation. Will be in the format projects/*/locations/*/repositories/*/compilationResults/*.
    state String
    This workflow invocation's current state.
    id string
    The provider-assigned unique ID for this managed resource.
    invocationTiming IntervalResponse
    This workflow invocation's timing details.
    name string
    The workflow invocation's name.
    resolvedCompilationResult string
    The resolved compilation result that was used to create this invocation. Will be in the format projects/*/locations/*/repositories/*/compilationResults/*.
    state string
    This workflow invocation's current state.
    id str
    The provider-assigned unique ID for this managed resource.
    invocation_timing IntervalResponse
    This workflow invocation's timing details.
    name str
    The workflow invocation's name.
    resolved_compilation_result str
    The resolved compilation result that was used to create this invocation. Will be in the format projects/*/locations/*/repositories/*/compilationResults/*.
    state str
    This workflow invocation's current state.
    id String
    The provider-assigned unique ID for this managed resource.
    invocationTiming Property Map
    This workflow invocation's timing details.
    name String
    The workflow invocation's name.
    resolvedCompilationResult String
    The resolved compilation result that was used to create this invocation. Will be in the format projects/*/locations/*/repositories/*/compilationResults/*.
    state String
    This workflow invocation's current state.

    Supporting Types

    IntervalResponse, IntervalResponseArgs

    EndTime string
    Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
    StartTime string
    Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
    EndTime string
    Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
    StartTime string
    Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
    endTime String
    Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
    startTime String
    Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
    endTime string
    Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
    startTime string
    Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
    end_time str
    Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
    start_time str
    Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.
    endTime String
    Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.
    startTime String
    Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.

    InvocationConfig, InvocationConfigArgs

    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.Target>
    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 []Target
    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<Target>
    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 Target[]
    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[Target]
    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.

    InvocationConfigResponse, InvocationConfigResponseArgs

    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.

    Target, TargetArgs

    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.

    TargetResponse, TargetResponseArgs

    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.

    Package Details

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

    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