Console
    Start free

    Class Execution (1.16.1) 

      Execution 
 ( 
 execution_name 
 : 
 str 
 , 
 * 
 , 
 metadata_store_id 
 : 
 str 
 = 
 "default" 
 , 
 project 
 : 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 location 
 : 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 credentials 
 : 
 Optional 
 [ 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 ] 
 = 
 None 
 )

    Metadata Execution resource for Vertex AI

    Inheritance

    builtins.object > google.cloud.aiplatform.base.VertexAiResourceNoun > builtins.object > google.cloud.aiplatform.base.FutureManager > google.cloud.aiplatform.base.VertexAiResourceNounWithFutureManager > builtins.object > abc.ABC > google.cloud.aiplatform.metadata.resource._Resource > Execution

    Properties

    state

    State of this Execution.

    Methods

    Execution

      Execution 
 ( 
 execution_name 
 : 
 str 
 , 
 * 
 , 
 metadata_store_id 
 : 
 str 
 = 
 "default" 
 , 
 project 
 : 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 location 
 : 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 credentials 
 : 
 Optional 
 [ 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 ] 
 = 
 None 
 )

    Retrieves an existing Metadata Execution given a resource name or ID.

    Parameters
    Name Description
    execution_name str

    Required. A fully-qualified resource name or resource ID of the Execution. Example: "projects/123/locations/us-central1/metadataStores/default/executions/my-resource". or "my-resource" when project and location are initialized or passed.
    metadata_store_id str

    Optional. MetadataStore to retrieve Execution from. If not set, metadata_store_id is set to "default". If execution_name is a fully-qualified resource, its metadata_store_id overrides this one.
    project str

    Optional. Project to retrieve the artifact from. If not set, project set in aiplatform.init will be used.
    location str

    Optional. Location to retrieve the Execution from. If not set, location set in aiplatform.init will be used.
    credentials auth_credentials.Credentials

    Optional. Custom credentials to use to retrieve this Execution. Overrides credentials set in aiplatform.init.

    assign_input_artifacts

      assign_input_artifacts 
 ( 
 artifacts 
 : 
 List 
 [ 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 aiplatform 
 . 
 metadata 
 . 
 artifact 
 . 
 Artifact 
 , 
 google 
 . 
 cloud 
 . 
 aiplatform 
 . 
 models 
 . 
 Model 
 , 
 ] 
 ] 
 )

    Assigns Artifacts as inputs to this Executions.

    Parameter
    Name Description
    artifacts List[Union[artifact.Artifact, models.Model]]

    Required. Artifacts to assign as input.

    assign_output_artifacts

      assign_output_artifacts 
 ( 
 artifacts 
 : 
 List 
 [ 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 aiplatform 
 . 
 metadata 
 . 
 artifact 
 . 
 Artifact 
 , 
 google 
 . 
 cloud 
 . 
 aiplatform 
 . 
 models 
 . 
 Model 
 , 
 ] 
 ] 
 )

    Assigns Artifacts as outputs to this Executions.

    Parameter
    Name Description
    artifacts List[Union[artifact.Artifact, models.Model]]

    Required. Artifacts to assign as input.

    create

      create 
 ( 
 schema_title 
 : 
 str 
 , 
 * 
 , 
 state 
 : 
 google 
 . 
 cloud 
 . 
 aiplatform_v1 
 . 
 types 
 . 
 execution 
 . 
 Execution 
 . 
 State 
 = 
< State 
 . 
 RUNNING 
 : 
 2 
> , 
 resource_id 
 : 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 display_name 
 : 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 schema_version 
 : 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 metadata 
 : 
 Optional 
 [ 
 Dict 
 [ 
 str 
 , 
 Any 
 ]] 
 = 
 None 
 , 
 description 
 : 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 metadata_store_id 
 : 
 str 
 = 
 'default' 
 , 
 project 
 : 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 location 
 : 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 credentials 
 = 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 , 
 NoneType 
 ])

    Creates a new Metadata Execution.

    Parameters
    Name Description
    schema_title str

    Required. schema_title identifies the schema title used by the Execution.
    state gca_execution.Execution.State.RUNNING

    Optional. State of this Execution. Defaults to RUNNING.
    resource_id str

    Optional. The <resource_id> portion of the Execution name with the format. This is globally unique in a metadataStore: projects/123/locations/us-central1/metadataStores/<metadata_store_id>/executions/<resource_id>.
    display_name str

    Optional. The user-defined name of the Execution.
    schema_version str

    Optional. schema_version specifies the version used by the Execution. If not set, defaults to use the latest version.
    metadata Dict

    Optional. Contains the metadata information that will be stored in the Execution.
    description str

    Optional. Describes the purpose of the Execution to be created.
    metadata_store_id str

    Optional. The <metadata_store_id> portion of the resource name with the format: projects/123/locations/us-central1/metadataStores/<metadata_store_id>/artifacts/<resource_id> If not provided, the MetadataStore's ID will be set to "default".
    project str

    Optional. Project used to create this Execution. Overrides project set in aiplatform.init.
    location str

    Optional. Location used to create this Execution. Overrides location set in aiplatform.init.
    credentials auth_credentials.Credentials

    Optional. Custom credentials used to create this Execution. Overrides credentials set in aiplatform.init.
    Returns
    Type Description
    Execution Instantiated representation of the managed Metadata Execution.

    get_input_artifacts

      get_input_artifacts 
 ()

    Get the input Artifacts of this Execution.

    get_output_artifacts

      get_output_artifacts 
 ()

    Get the output Artifacts of this Execution.

    update

      update 
 ( 
 state 
 : 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 aiplatform_v1 
 . 
 types 
 . 
 execution 
 . 
 Execution 
 . 
 State 
 ] 
 = 
 None 
 , 
 description 
 : 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 metadata 
 : 
 Optional 
 [ 
 Dict 
 [ 
 str 
 , 
 Any 
 ]] 
 = 
 None 
 , 
 )

    Update this Execution.

    Parameters
    Name Description
    state gca_execution.Execution.State

    Optional. State of this Execution.
    description str

    Optional. Describes the purpose of the Execution to be created.
    metadata Dict[str, Any

    Optional. Contains the metadata information that will be stored in the Execution.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: