1. Registry
  2. Packages
  3. Google Cloud Native
  4. API Docs
  5. datalineage
  6. datalineage/v1
  7. Run

This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

Viewing docs for Google Cloud Native v0.32.0
published on Wednesday, Nov 29, 2023 by Pulumi
google-native logo Google Cloud Native

This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

Viewing docs for Google Cloud Native v0.32.0
published on Wednesday, Nov 29, 2023 by Pulumi

    Creates a new run.

    Create Run Resource

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

    Constructor syntax

    new Run(name: string, args: RunArgs, opts?: CustomResourceOptions);
    @overload
    def Run(resource_name: str,
            args: RunArgs,
            opts: Optional[ResourceOptions] = None)
    
    @overload
    def Run(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            process_id: Optional[str] = None,
            start_time: Optional[str] = None,
            state: Optional[RunState] = None,
            attributes: Optional[Mapping[str, str]] = None,
            display_name: Optional[str] = None,
            end_time: Optional[str] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            request_id: Optional[str] = None)
    func NewRun(ctx *Context, name string, args RunArgs, opts ...ResourceOption) (*Run, error)
    public Run(string name, RunArgs args, CustomResourceOptions? opts = null)
    public Run(String name, RunArgs args)
    public Run(String name, RunArgs args, CustomResourceOptions options)
    
    type: google-native:datalineage/v1:Run
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "google-native_datalineage_v1_run" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args RunArgs
    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 RunArgs
    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 RunArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RunArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RunArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var examplerunResourceResourceFromDatalineagev1 = new GoogleNative.DataLineage.V1.Run("examplerunResourceResourceFromDatalineagev1", new()
    {
        ProcessId = "string",
        StartTime = "string",
        State = GoogleNative.DataLineage.V1.RunState.Unknown,
        Attributes = 
        {
            { "string", "string" },
        },
        DisplayName = "string",
        EndTime = "string",
        Location = "string",
        Name = "string",
        Project = "string",
        RequestId = "string",
    });
    
    example, err := datalineage.NewRun(ctx, "examplerunResourceResourceFromDatalineagev1", &datalineage.RunArgs{
    	ProcessId: pulumi.String("string"),
    	StartTime: pulumi.String("string"),
    	State:     datalineage.RunStateUnknown,
    	Attributes: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	DisplayName: pulumi.String("string"),
    	EndTime:     pulumi.String("string"),
    	Location:    pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	Project:     pulumi.String("string"),
    	RequestId:   pulumi.String("string"),
    })
    
    resource "google-native_datalineage_v1_run" "examplerunResourceResourceFromDatalineagev1" {
      lifecycle {
        create_before_destroy = true
      }
      process_id = "string"
      start_time = "string"
      state      = "UNKNOWN"
      attributes = {
        "string" = "string"
      }
      display_name = "string"
      end_time     = "string"
      location     = "string"
      name         = "string"
      project      = "string"
      request_id   = "string"
    }
    
    var examplerunResourceResourceFromDatalineagev1 = new com.pulumi.googlenative.datalineage_v1.Run("examplerunResourceResourceFromDatalineagev1", com.pulumi.googlenative.datalineage_v1.RunArgs.builder()
        .processId("string")
        .startTime("string")
        .state(com.pulumi.googlenative.datalineage_v1.enums.RunState.Unknown)
        .attributes(Map.of("string", "string"))
        .displayName("string")
        .endTime("string")
        .location("string")
        .name("string")
        .project("string")
        .requestId("string")
        .build());
    
    examplerun_resource_resource_from_datalineagev1 = google_native.datalineage.v1.Run("examplerunResourceResourceFromDatalineagev1",
        process_id="string",
        start_time="string",
        state=google_native.datalineage.v1.RunState.UNKNOWN,
        attributes={
            "string": "string",
        },
        display_name="string",
        end_time="string",
        location="string",
        name="string",
        project="string",
        request_id="string")
    
    const examplerunResourceResourceFromDatalineagev1 = new google_native.datalineage.v1.Run("examplerunResourceResourceFromDatalineagev1", {
        processId: "string",
        startTime: "string",
        state: google_native.datalineage.v1.RunState.Unknown,
        attributes: {
            string: "string",
        },
        displayName: "string",
        endTime: "string",
        location: "string",
        name: "string",
        project: "string",
        requestId: "string",
    });
    
    type: google-native:datalineage/v1:Run
    properties:
        attributes:
            string: string
        displayName: string
        endTime: string
        location: string
        name: string
        processId: string
        project: string
        requestId: string
        startTime: string
        state: UNKNOWN
    

    Run Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Run resource accepts the following input properties:

    ProcessId string
    StartTime string
    The timestamp of the start of the run.
    State Pulumi.GoogleNative.DataLineage.V1.RunState
    The state of the run.
    Attributes Dictionary<string, string>
    Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run). Up to 100 attributes are allowed.
    DisplayName string
    Optional. A human-readable name you can set to display in a user interface. Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like _-:&.
    EndTime string
    Optional. The timestamp of the end of the run.
    Location string
    Name string
    Immutable. The resource name of the run. Format: projects/{project}/locations/{location}/processes/{process}/runs/{run}. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: a-zA-Z0-9_-:.
    Project string
    RequestId string
    A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is idempotent only if a request_id is provided.
    ProcessId string
    StartTime string
    The timestamp of the start of the run.
    State RunStateEnum
    The state of the run.
    Attributes map[string]string
    Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run). Up to 100 attributes are allowed.
    DisplayName string
    Optional. A human-readable name you can set to display in a user interface. Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like _-:&.
    EndTime string
    Optional. The timestamp of the end of the run.
    Location string
    Name string
    Immutable. The resource name of the run. Format: projects/{project}/locations/{location}/processes/{process}/runs/{run}. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: a-zA-Z0-9_-:.
    Project string
    RequestId string
    A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is idempotent only if a request_id is provided.
    process_id string
    start_time string
    The timestamp of the start of the run.
    state "UNKNOWN" | "STARTED" | "COMPLETED" | "FAILED" | "ABORTED"
    The state of the run.
    attributes map(string)
    Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run). Up to 100 attributes are allowed.
    display_name string
    Optional. A human-readable name you can set to display in a user interface. Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like _-:&.
    end_time string
    Optional. The timestamp of the end of the run.
    location string
    name string
    Immutable. The resource name of the run. Format: projects/{project}/locations/{location}/processes/{process}/runs/{run}. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: a-zA-Z0-9_-:.
    project string
    request_id string
    A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is idempotent only if a request_id is provided.
    processId String
    startTime String
    The timestamp of the start of the run.
    state RunState
    The state of the run.
    attributes Map<String,String>
    Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run). Up to 100 attributes are allowed.
    displayName String
    Optional. A human-readable name you can set to display in a user interface. Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like _-:&.
    endTime String
    Optional. The timestamp of the end of the run.
    location String
    name String
    Immutable. The resource name of the run. Format: projects/{project}/locations/{location}/processes/{process}/runs/{run}. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: a-zA-Z0-9_-:.
    project String
    requestId String
    A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is idempotent only if a request_id is provided.
    processId string
    startTime string
    The timestamp of the start of the run.
    state RunState
    The state of the run.
    attributes {[key: string]: string}
    Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run). Up to 100 attributes are allowed.
    displayName string
    Optional. A human-readable name you can set to display in a user interface. Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like _-:&.
    endTime string
    Optional. The timestamp of the end of the run.
    location string
    name string
    Immutable. The resource name of the run. Format: projects/{project}/locations/{location}/processes/{process}/runs/{run}. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: a-zA-Z0-9_-:.
    project string
    requestId string
    A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is idempotent only if a request_id is provided.
    process_id str
    start_time str
    The timestamp of the start of the run.
    state RunState
    The state of the run.
    attributes Mapping[str, str]
    Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run). Up to 100 attributes are allowed.
    display_name str
    Optional. A human-readable name you can set to display in a user interface. Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like _-:&.
    end_time str
    Optional. The timestamp of the end of the run.
    location str
    name str
    Immutable. The resource name of the run. Format: projects/{project}/locations/{location}/processes/{process}/runs/{run}. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: a-zA-Z0-9_-:.
    project str
    request_id str
    A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is idempotent only if a request_id is provided.
    processId String
    startTime String
    The timestamp of the start of the run.
    state "UNKNOWN" | "STARTED" | "COMPLETED" | "FAILED" | "ABORTED"
    The state of the run.
    attributes Map<String>
    Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run). Up to 100 attributes are allowed.
    displayName String
    Optional. A human-readable name you can set to display in a user interface. Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like _-:&.
    endTime String
    Optional. The timestamp of the end of the run.
    location String
    name String
    Immutable. The resource name of the run. Format: projects/{project}/locations/{location}/processes/{process}/runs/{run}. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: a-zA-Z0-9_-:.
    project String
    requestId String
    A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is idempotent only if a request_id is provided.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Run Resource

    Get an existing Run resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, opts?: CustomResourceOptions): Run
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> Run
    func GetRun(ctx *Context, name string, id IDInput, state *RunState, opts ...ResourceOption) (*Run, error)
    public static Run Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static Run get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingRun:    type: google-native:datalineage/v1:Run    get:      id: ${id}
    import {
      to = google-native_datalineage_v1_run.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state RunState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Supporting Types

    RunState, RunStateArgs

    Required. The state of the run.
    NameValueDescription
    UnknownUNKNOWNThe state is unknown. The true state may be any of the below or a different state that is not supported here explicitly.
    StartedSTARTEDThe run is still executing.
    CompletedCOMPLETEDThe run completed.
    FailedFAILEDThe run failed.
    AbortedABORTEDThe run aborted.
    NameValueDescription
    RunStateUnknownUNKNOWNThe state is unknown. The true state may be any of the below or a different state that is not supported here explicitly.
    RunStateStartedSTARTEDThe run is still executing.
    RunStateCompletedCOMPLETEDThe run completed.
    RunStateFailedFAILEDThe run failed.
    RunStateAbortedABORTEDThe run aborted.
    ValueDescription
    UNKNOWNThe state is unknown. The true state may be any of the below or a different state that is not supported here explicitly.
    STARTEDThe run is still executing.
    COMPLETEDThe run completed.
    FAILEDThe run failed.
    ABORTEDThe run aborted.
    NameValueDescription
    UnknownUNKNOWNThe state is unknown. The true state may be any of the below or a different state that is not supported here explicitly.
    StartedSTARTEDThe run is still executing.
    CompletedCOMPLETEDThe run completed.
    FailedFAILEDThe run failed.
    AbortedABORTEDThe run aborted.
    NameValueDescription
    UnknownUNKNOWNThe state is unknown. The true state may be any of the below or a different state that is not supported here explicitly.
    StartedSTARTEDThe run is still executing.
    CompletedCOMPLETEDThe run completed.
    FailedFAILEDThe run failed.
    AbortedABORTEDThe run aborted.
    NameValueDescription
    UNKNOWNUNKNOWNThe state is unknown. The true state may be any of the below or a different state that is not supported here explicitly.
    STARTEDSTARTEDThe run is still executing.
    COMPLETEDCOMPLETEDThe run completed.
    FAILEDFAILEDThe run failed.
    ABORTEDABORTEDThe run aborted.
    ValueDescription
    UNKNOWNThe state is unknown. The true state may be any of the below or a different state that is not supported here explicitly.
    STARTEDThe run is still executing.
    COMPLETEDThe run completed.
    FAILEDThe run failed.
    ABORTEDThe run aborted.

    Package Details

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

    This package is deprecated. Active development has stopped. We recommend using the Google Cloud package instead.

    Viewing docs for Google Cloud Native v0.32.0
    published on Wednesday, Nov 29, 2023 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial