1. Packages
  2. Google Cloud Native
  3. API Docs
  4. aiplatform
  5. aiplatform/v1beta1
  6. Execution

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

google-native.aiplatform/v1beta1.Execution

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

    Creates an Execution associated with a MetadataStore. Auto-naming is currently not supported for this resource.

    Create Execution Resource

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

    Constructor syntax

    new Execution(name: string, args: ExecutionArgs, opts?: CustomResourceOptions);
    @overload
    def Execution(resource_name: str,
                  args: ExecutionArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def Execution(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  metadata_store_id: Optional[str] = None,
                  description: Optional[str] = None,
                  display_name: Optional[str] = None,
                  etag: Optional[str] = None,
                  execution_id: Optional[str] = None,
                  labels: Optional[Mapping[str, str]] = None,
                  location: Optional[str] = None,
                  metadata: Optional[Mapping[str, str]] = None,
                  project: Optional[str] = None,
                  schema_title: Optional[str] = None,
                  schema_version: Optional[str] = None,
                  state: Optional[ExecutionState] = None)
    func NewExecution(ctx *Context, name string, args ExecutionArgs, opts ...ResourceOption) (*Execution, error)
    public Execution(string name, ExecutionArgs args, CustomResourceOptions? opts = null)
    public Execution(String name, ExecutionArgs args)
    public Execution(String name, ExecutionArgs args, CustomResourceOptions options)
    
    type: google-native:aiplatform/v1beta1:Execution
    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 ExecutionArgs
    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 ExecutionArgs
    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 ExecutionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ExecutionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ExecutionArgs
    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 google_nativeExecutionResource = new GoogleNative.Aiplatform.V1Beta1.Execution("google-nativeExecutionResource", new()
    {
        MetadataStoreId = "string",
        Description = "string",
        DisplayName = "string",
        Etag = "string",
        ExecutionId = "string",
        Labels = 
        {
            { "string", "string" },
        },
        Location = "string",
        Metadata = 
        {
            { "string", "string" },
        },
        Project = "string",
        SchemaTitle = "string",
        SchemaVersion = "string",
        State = GoogleNative.Aiplatform.V1Beta1.ExecutionState.StateUnspecified,
    });
    
    example, err := aiplatformv1beta1.NewExecution(ctx, "google-nativeExecutionResource", &aiplatformv1beta1.ExecutionArgs{
    MetadataStoreId: pulumi.String("string"),
    Description: pulumi.String("string"),
    DisplayName: pulumi.String("string"),
    Etag: pulumi.String("string"),
    ExecutionId: pulumi.String("string"),
    Labels: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    Location: pulumi.String("string"),
    Metadata: pulumi.StringMap{
    "string": pulumi.String("string"),
    },
    Project: pulumi.String("string"),
    SchemaTitle: pulumi.String("string"),
    SchemaVersion: pulumi.String("string"),
    State: aiplatformv1beta1.ExecutionStateStateUnspecified,
    })
    
    var google_nativeExecutionResource = new Execution("google-nativeExecutionResource", ExecutionArgs.builder()        
        .metadataStoreId("string")
        .description("string")
        .displayName("string")
        .etag("string")
        .executionId("string")
        .labels(Map.of("string", "string"))
        .location("string")
        .metadata(Map.of("string", "string"))
        .project("string")
        .schemaTitle("string")
        .schemaVersion("string")
        .state("STATE_UNSPECIFIED")
        .build());
    
    google_native_execution_resource = google_native.aiplatform.v1beta1.Execution("google-nativeExecutionResource",
        metadata_store_id="string",
        description="string",
        display_name="string",
        etag="string",
        execution_id="string",
        labels={
            "string": "string",
        },
        location="string",
        metadata={
            "string": "string",
        },
        project="string",
        schema_title="string",
        schema_version="string",
        state=google_native.aiplatform.v1beta1.ExecutionState.STATE_UNSPECIFIED)
    
    const google_nativeExecutionResource = new google_native.aiplatform.v1beta1.Execution("google-nativeExecutionResource", {
        metadataStoreId: "string",
        description: "string",
        displayName: "string",
        etag: "string",
        executionId: "string",
        labels: {
            string: "string",
        },
        location: "string",
        metadata: {
            string: "string",
        },
        project: "string",
        schemaTitle: "string",
        schemaVersion: "string",
        state: google_native.aiplatform.v1beta1.ExecutionState.StateUnspecified,
    });
    
    type: google-native:aiplatform/v1beta1:Execution
    properties:
        description: string
        displayName: string
        etag: string
        executionId: string
        labels:
            string: string
        location: string
        metadata:
            string: string
        metadataStoreId: string
        project: string
        schemaTitle: string
        schemaVersion: string
        state: STATE_UNSPECIFIED
    

    Execution 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 Execution resource accepts the following input properties:

    MetadataStoreId string
    Description string
    Description of the Execution
    DisplayName string
    User provided display name of the Execution. May be up to 128 Unicode characters.
    Etag string
    An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    ExecutionId string
    The {execution} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution} If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are /a-z-/. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.)
    Labels Dictionary<string, string>
    The labels with user-defined metadata to organize your Executions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Execution (System labels are excluded).
    Location string
    Metadata Dictionary<string, string>
    Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
    Project string
    SchemaTitle string
    The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
    SchemaVersion string
    The version of the schema in schema_title to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
    State Pulumi.GoogleNative.Aiplatform.V1Beta1.ExecutionState
    The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions.
    MetadataStoreId string
    Description string
    Description of the Execution
    DisplayName string
    User provided display name of the Execution. May be up to 128 Unicode characters.
    Etag string
    An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    ExecutionId string
    The {execution} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution} If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are /a-z-/. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.)
    Labels map[string]string
    The labels with user-defined metadata to organize your Executions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Execution (System labels are excluded).
    Location string
    Metadata map[string]string
    Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
    Project string
    SchemaTitle string
    The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
    SchemaVersion string
    The version of the schema in schema_title to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
    State ExecutionStateEnum
    The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions.
    metadataStoreId String
    description String
    Description of the Execution
    displayName String
    User provided display name of the Execution. May be up to 128 Unicode characters.
    etag String
    An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    executionId String
    The {execution} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution} If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are /a-z-/. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.)
    labels Map<String,String>
    The labels with user-defined metadata to organize your Executions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Execution (System labels are excluded).
    location String
    metadata Map<String,String>
    Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
    project String
    schemaTitle String
    The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
    schemaVersion String
    The version of the schema in schema_title to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
    state ExecutionState
    The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions.
    metadataStoreId string
    description string
    Description of the Execution
    displayName string
    User provided display name of the Execution. May be up to 128 Unicode characters.
    etag string
    An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    executionId string
    The {execution} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution} If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are /a-z-/. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.)
    labels {[key: string]: string}
    The labels with user-defined metadata to organize your Executions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Execution (System labels are excluded).
    location string
    metadata {[key: string]: string}
    Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
    project string
    schemaTitle string
    The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
    schemaVersion string
    The version of the schema in schema_title to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
    state ExecutionState
    The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions.
    metadata_store_id str
    description str
    Description of the Execution
    display_name str
    User provided display name of the Execution. May be up to 128 Unicode characters.
    etag str
    An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    execution_id str
    The {execution} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution} If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are /a-z-/. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.)
    labels Mapping[str, str]
    The labels with user-defined metadata to organize your Executions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Execution (System labels are excluded).
    location str
    metadata Mapping[str, str]
    Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
    project str
    schema_title str
    The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
    schema_version str
    The version of the schema in schema_title to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
    state ExecutionState
    The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions.
    metadataStoreId String
    description String
    Description of the Execution
    displayName String
    User provided display name of the Execution. May be up to 128 Unicode characters.
    etag String
    An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
    executionId String
    The {execution} portion of the resource name with the format: projects/{project}/locations/{location}/metadataStores/{metadatastore}/executions/{execution} If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are /a-z-/. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.)
    labels Map<String>
    The labels with user-defined metadata to organize your Executions. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Execution (System labels are excluded).
    location String
    metadata Map<String>
    Properties of the Execution. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
    project String
    schemaTitle String
    The title of the schema describing the metadata. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
    schemaVersion String
    The version of the schema in schema_title to use. Schema title and version is expected to be registered in earlier Create Schema calls. And both are used together as unique identifiers to identify schemas within the local metadata store.
    state "STATE_UNSPECIFIED" | "NEW" | "RUNNING" | "COMPLETE" | "FAILED" | "CACHED" | "CANCELLED"
    The state of this Execution. This is a property of the Execution, and does not imply or capture any ongoing process. This property is managed by clients (such as Vertex AI Pipelines) and the system does not prescribe or check the validity of state transitions.

    Outputs

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

    CreateTime string
    Timestamp when this Execution was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the Execution.
    UpdateTime string
    Timestamp when this Execution was last updated.
    CreateTime string
    Timestamp when this Execution was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the Execution.
    UpdateTime string
    Timestamp when this Execution was last updated.
    createTime String
    Timestamp when this Execution was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the Execution.
    updateTime String
    Timestamp when this Execution was last updated.
    createTime string
    Timestamp when this Execution was created.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The resource name of the Execution.
    updateTime string
    Timestamp when this Execution was last updated.
    create_time str
    Timestamp when this Execution was created.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The resource name of the Execution.
    update_time str
    Timestamp when this Execution was last updated.
    createTime String
    Timestamp when this Execution was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the Execution.
    updateTime String
    Timestamp when this Execution was last updated.

    Supporting Types

    ExecutionState, ExecutionStateArgs

    StateUnspecified
    STATE_UNSPECIFIEDUnspecified Execution state
    New
    NEWThe Execution is new
    Running
    RUNNINGThe Execution is running
    Complete
    COMPLETEThe Execution has finished running
    Failed
    FAILEDThe Execution has failed
    Cached
    CACHEDThe Execution completed through Cache hit.
    Cancelled
    CANCELLEDThe Execution was cancelled.
    ExecutionStateStateUnspecified
    STATE_UNSPECIFIEDUnspecified Execution state
    ExecutionStateNew
    NEWThe Execution is new
    ExecutionStateRunning
    RUNNINGThe Execution is running
    ExecutionStateComplete
    COMPLETEThe Execution has finished running
    ExecutionStateFailed
    FAILEDThe Execution has failed
    ExecutionStateCached
    CACHEDThe Execution completed through Cache hit.
    ExecutionStateCancelled
    CANCELLEDThe Execution was cancelled.
    StateUnspecified
    STATE_UNSPECIFIEDUnspecified Execution state
    New
    NEWThe Execution is new
    Running
    RUNNINGThe Execution is running
    Complete
    COMPLETEThe Execution has finished running
    Failed
    FAILEDThe Execution has failed
    Cached
    CACHEDThe Execution completed through Cache hit.
    Cancelled
    CANCELLEDThe Execution was cancelled.
    StateUnspecified
    STATE_UNSPECIFIEDUnspecified Execution state
    New
    NEWThe Execution is new
    Running
    RUNNINGThe Execution is running
    Complete
    COMPLETEThe Execution has finished running
    Failed
    FAILEDThe Execution has failed
    Cached
    CACHEDThe Execution completed through Cache hit.
    Cancelled
    CANCELLEDThe Execution was cancelled.
    STATE_UNSPECIFIED
    STATE_UNSPECIFIEDUnspecified Execution state
    NEW
    NEWThe Execution is new
    RUNNING
    RUNNINGThe Execution is running
    COMPLETE
    COMPLETEThe Execution has finished running
    FAILED
    FAILEDThe Execution has failed
    CACHED
    CACHEDThe Execution completed through Cache hit.
    CANCELLED
    CANCELLEDThe Execution was cancelled.
    "STATE_UNSPECIFIED"
    STATE_UNSPECIFIEDUnspecified Execution state
    "NEW"
    NEWThe Execution is new
    "RUNNING"
    RUNNINGThe Execution is running
    "COMPLETE"
    COMPLETEThe Execution has finished running
    "FAILED"
    FAILEDThe Execution has failed
    "CACHED"
    CACHEDThe Execution completed through Cache hit.
    "CANCELLED"
    CANCELLEDThe Execution was cancelled.

    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