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

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.getPipelineJob

Explore with Pulumi AI

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

Gets a PipelineJob.

Using getPipelineJob

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 getPipelineJob(args: GetPipelineJobArgs, opts?: InvokeOptions): Promise<GetPipelineJobResult>
function getPipelineJobOutput(args: GetPipelineJobOutputArgs, opts?: InvokeOptions): Output<GetPipelineJobResult>
Copy
def get_pipeline_job(location: Optional[str] = None,
                     pipeline_job_id: Optional[str] = None,
                     project: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetPipelineJobResult
def get_pipeline_job_output(location: Optional[pulumi.Input[str]] = None,
                     pipeline_job_id: Optional[pulumi.Input[str]] = None,
                     project: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetPipelineJobResult]
Copy
func LookupPipelineJob(ctx *Context, args *LookupPipelineJobArgs, opts ...InvokeOption) (*LookupPipelineJobResult, error)
func LookupPipelineJobOutput(ctx *Context, args *LookupPipelineJobOutputArgs, opts ...InvokeOption) LookupPipelineJobResultOutput
Copy

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

public static class GetPipelineJob 
{
    public static Task<GetPipelineJobResult> InvokeAsync(GetPipelineJobArgs args, InvokeOptions? opts = null)
    public static Output<GetPipelineJobResult> Invoke(GetPipelineJobInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPipelineJobResult> getPipelineJob(GetPipelineJobArgs args, InvokeOptions options)
public static Output<GetPipelineJobResult> getPipelineJob(GetPipelineJobArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:aiplatform/v1beta1:getPipelineJob
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Location This property is required. string
PipelineJobId This property is required. string
Project string
Location This property is required. string
PipelineJobId This property is required. string
Project string
location This property is required. String
pipelineJobId This property is required. String
project String
location This property is required. string
pipelineJobId This property is required. string
project string
location This property is required. str
pipeline_job_id This property is required. str
project str
location This property is required. String
pipelineJobId This property is required. String
project String

getPipelineJob Result

The following output properties are available:

CreateTime string
Pipeline creation time.
DisplayName string
The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
EncryptionSpec Pulumi.GoogleNative.Aiplatform.V1Beta1.Outputs.GoogleCloudAiplatformV1beta1EncryptionSpecResponse
Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
EndTime string
Pipeline end time.
Error Pulumi.GoogleNative.Aiplatform.V1Beta1.Outputs.GoogleRpcStatusResponse
The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
JobDetail Pulumi.GoogleNative.Aiplatform.V1Beta1.Outputs.GoogleCloudAiplatformV1beta1PipelineJobDetailResponse
The details of pipeline run. Not available in the list view.
Labels Dictionary<string, string>
The labels with user-defined metadata to organize PipelineJob. 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. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - vertex-ai-pipelines-run-billing-id, user set value will get overrided.
Name string
The resource name of the PipelineJob.
Network string
The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example, projects/12345/global/networks/myVPC. Format is of the form projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.
PipelineSpec Dictionary<string, string>
The spec of the pipeline.
ReservedIpRanges List<string>
A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
RuntimeConfig Pulumi.GoogleNative.Aiplatform.V1Beta1.Outputs.GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigResponse
Runtime config of the pipeline.
ScheduleName string
The schedule resource name. Only returned if the Pipeline is created by Schedule API.
ServiceAccount string
The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account.
StartTime string
Pipeline start time.
State string
The detailed state of the job.
TemplateMetadata Pulumi.GoogleNative.Aiplatform.V1Beta1.Outputs.GoogleCloudAiplatformV1beta1PipelineTemplateMetadataResponse
Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
TemplateUri string
A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.
UpdateTime string
Timestamp when this PipelineJob was most recently updated.
CreateTime string
Pipeline creation time.
DisplayName string
The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
EncryptionSpec GoogleCloudAiplatformV1beta1EncryptionSpecResponse
Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
EndTime string
Pipeline end time.
Error GoogleRpcStatusResponse
The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
JobDetail GoogleCloudAiplatformV1beta1PipelineJobDetailResponse
The details of pipeline run. Not available in the list view.
Labels map[string]string
The labels with user-defined metadata to organize PipelineJob. 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. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - vertex-ai-pipelines-run-billing-id, user set value will get overrided.
Name string
The resource name of the PipelineJob.
Network string
The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example, projects/12345/global/networks/myVPC. Format is of the form projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.
PipelineSpec map[string]string
The spec of the pipeline.
ReservedIpRanges []string
A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
RuntimeConfig GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigResponse
Runtime config of the pipeline.
ScheduleName string
The schedule resource name. Only returned if the Pipeline is created by Schedule API.
ServiceAccount string
The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account.
StartTime string
Pipeline start time.
State string
The detailed state of the job.
TemplateMetadata GoogleCloudAiplatformV1beta1PipelineTemplateMetadataResponse
Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
TemplateUri string
A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.
UpdateTime string
Timestamp when this PipelineJob was most recently updated.
createTime String
Pipeline creation time.
displayName String
The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
encryptionSpec GoogleCloudAiplatformV1beta1EncryptionSpecResponse
Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
endTime String
Pipeline end time.
error GoogleRpcStatusResponse
The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
jobDetail GoogleCloudAiplatformV1beta1PipelineJobDetailResponse
The details of pipeline run. Not available in the list view.
labels Map<String,String>
The labels with user-defined metadata to organize PipelineJob. 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. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - vertex-ai-pipelines-run-billing-id, user set value will get overrided.
name String
The resource name of the PipelineJob.
network String
The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example, projects/12345/global/networks/myVPC. Format is of the form projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.
pipelineSpec Map<String,String>
The spec of the pipeline.
reservedIpRanges List<String>
A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
runtimeConfig GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigResponse
Runtime config of the pipeline.
scheduleName String
The schedule resource name. Only returned if the Pipeline is created by Schedule API.
serviceAccount String
The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account.
startTime String
Pipeline start time.
state String
The detailed state of the job.
templateMetadata GoogleCloudAiplatformV1beta1PipelineTemplateMetadataResponse
Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
templateUri String
A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.
updateTime String
Timestamp when this PipelineJob was most recently updated.
createTime string
Pipeline creation time.
displayName string
The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
encryptionSpec GoogleCloudAiplatformV1beta1EncryptionSpecResponse
Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
endTime string
Pipeline end time.
error GoogleRpcStatusResponse
The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
jobDetail GoogleCloudAiplatformV1beta1PipelineJobDetailResponse
The details of pipeline run. Not available in the list view.
labels {[key: string]: string}
The labels with user-defined metadata to organize PipelineJob. 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. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - vertex-ai-pipelines-run-billing-id, user set value will get overrided.
name string
The resource name of the PipelineJob.
network string
The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example, projects/12345/global/networks/myVPC. Format is of the form projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.
pipelineSpec {[key: string]: string}
The spec of the pipeline.
reservedIpRanges string[]
A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
runtimeConfig GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigResponse
Runtime config of the pipeline.
scheduleName string
The schedule resource name. Only returned if the Pipeline is created by Schedule API.
serviceAccount string
The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account.
startTime string
Pipeline start time.
state string
The detailed state of the job.
templateMetadata GoogleCloudAiplatformV1beta1PipelineTemplateMetadataResponse
Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
templateUri string
A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.
updateTime string
Timestamp when this PipelineJob was most recently updated.
create_time str
Pipeline creation time.
display_name str
The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
encryption_spec GoogleCloudAiplatformV1beta1EncryptionSpecResponse
Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
end_time str
Pipeline end time.
error GoogleRpcStatusResponse
The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
job_detail GoogleCloudAiplatformV1beta1PipelineJobDetailResponse
The details of pipeline run. Not available in the list view.
labels Mapping[str, str]
The labels with user-defined metadata to organize PipelineJob. 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. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - vertex-ai-pipelines-run-billing-id, user set value will get overrided.
name str
The resource name of the PipelineJob.
network str
The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example, projects/12345/global/networks/myVPC. Format is of the form projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.
pipeline_spec Mapping[str, str]
The spec of the pipeline.
reserved_ip_ranges Sequence[str]
A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
runtime_config GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigResponse
Runtime config of the pipeline.
schedule_name str
The schedule resource name. Only returned if the Pipeline is created by Schedule API.
service_account str
The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account.
start_time str
Pipeline start time.
state str
The detailed state of the job.
template_metadata GoogleCloudAiplatformV1beta1PipelineTemplateMetadataResponse
Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
template_uri str
A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.
update_time str
Timestamp when this PipelineJob was most recently updated.
createTime String
Pipeline creation time.
displayName String
The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters.
encryptionSpec Property Map
Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
endTime String
Pipeline end time.
error Property Map
The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
jobDetail Property Map
The details of pipeline run. Not available in the list view.
labels Map<String>
The labels with user-defined metadata to organize PipelineJob. 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. See https://goo.gl/xmQnxf for more information and examples of labels. Note there is some reserved label key for Vertex AI Pipelines. - vertex-ai-pipelines-run-billing-id, user set value will get overrided.
name String
The resource name of the PipelineJob.
network String
The full name of the Compute Engine network to which the Pipeline Job's workload should be peered. For example, projects/12345/global/networks/myVPC. Format is of the form projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.
pipelineSpec Map<String>
The spec of the pipeline.
reservedIpRanges List<String>
A list of names for the reserved ip ranges under the VPC network that can be used for this Pipeline Job's workload. If set, we will deploy the Pipeline Job's workload within the provided ip ranges. Otherwise, the job will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
runtimeConfig Property Map
Runtime config of the pipeline.
scheduleName String
The schedule resource name. Only returned if the Pipeline is created by Schedule API.
serviceAccount String
The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the iam.serviceAccounts.actAs permission on this service account.
startTime String
Pipeline start time.
state String
The detailed state of the job.
templateMetadata Property Map
Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
templateUri String
A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.
updateTime String
Timestamp when this PipelineJob was most recently updated.

Supporting Types

GoogleCloudAiplatformV1beta1ContextResponse

CreateTime This property is required. string
Timestamp when this Context was created.
Description This property is required. string
Description of the Context
DisplayName This property is required. string
User provided display name of the Context. May be up to 128 Unicode characters.
Etag This property is required. string
An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Labels This property is required. Dictionary<string, string>
The labels with user-defined metadata to organize your Contexts. 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 Context (System labels are excluded).
Metadata This property is required. Dictionary<string, string>
Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
Name This property is required. string
Immutable. The resource name of the Context.
ParentContexts This property is required. List<string>
A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
SchemaTitle This property is required. 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 This property is required. string
The version of the schema in schema_name 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.
UpdateTime This property is required. string
Timestamp when this Context was last updated.
CreateTime This property is required. string
Timestamp when this Context was created.
Description This property is required. string
Description of the Context
DisplayName This property is required. string
User provided display name of the Context. May be up to 128 Unicode characters.
Etag This property is required. string
An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Labels This property is required. map[string]string
The labels with user-defined metadata to organize your Contexts. 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 Context (System labels are excluded).
Metadata This property is required. map[string]string
Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
Name This property is required. string
Immutable. The resource name of the Context.
ParentContexts This property is required. []string
A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
SchemaTitle This property is required. 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 This property is required. string
The version of the schema in schema_name 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.
UpdateTime This property is required. string
Timestamp when this Context was last updated.
createTime This property is required. String
Timestamp when this Context was created.
description This property is required. String
Description of the Context
displayName This property is required. String
User provided display name of the Context. May be up to 128 Unicode characters.
etag This property is required. String
An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels This property is required. Map<String,String>
The labels with user-defined metadata to organize your Contexts. 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 Context (System labels are excluded).
metadata This property is required. Map<String,String>
Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
name This property is required. String
Immutable. The resource name of the Context.
parentContexts This property is required. List<String>
A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
schemaTitle This property is required. 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 This property is required. String
The version of the schema in schema_name 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.
updateTime This property is required. String
Timestamp when this Context was last updated.
createTime This property is required. string
Timestamp when this Context was created.
description This property is required. string
Description of the Context
displayName This property is required. string
User provided display name of the Context. May be up to 128 Unicode characters.
etag This property is required. string
An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels This property is required. {[key: string]: string}
The labels with user-defined metadata to organize your Contexts. 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 Context (System labels are excluded).
metadata This property is required. {[key: string]: string}
Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
name This property is required. string
Immutable. The resource name of the Context.
parentContexts This property is required. string[]
A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
schemaTitle This property is required. 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 This property is required. string
The version of the schema in schema_name 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.
updateTime This property is required. string
Timestamp when this Context was last updated.
create_time This property is required. str
Timestamp when this Context was created.
description This property is required. str
Description of the Context
display_name This property is required. str
User provided display name of the Context. May be up to 128 Unicode characters.
etag This property is required. str
An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels This property is required. Mapping[str, str]
The labels with user-defined metadata to organize your Contexts. 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 Context (System labels are excluded).
metadata This property is required. Mapping[str, str]
Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
name This property is required. str
Immutable. The resource name of the Context.
parent_contexts This property is required. Sequence[str]
A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
schema_title This property is required. 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 This property is required. str
The version of the schema in schema_name 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.
update_time This property is required. str
Timestamp when this Context was last updated.
createTime This property is required. String
Timestamp when this Context was created.
description This property is required. String
Description of the Context
displayName This property is required. String
User provided display name of the Context. May be up to 128 Unicode characters.
etag This property is required. String
An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels This property is required. Map<String>
The labels with user-defined metadata to organize your Contexts. 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 Context (System labels are excluded).
metadata This property is required. Map<String>
Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB.
name This property is required. String
Immutable. The resource name of the Context.
parentContexts This property is required. List<String>
A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts.
schemaTitle This property is required. 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 This property is required. String
The version of the schema in schema_name 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.
updateTime This property is required. String
Timestamp when this Context was last updated.

GoogleCloudAiplatformV1beta1EncryptionSpecResponse

KmsKeyName This property is required. string
The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
KmsKeyName This property is required. string
The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
kmsKeyName This property is required. String
The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
kmsKeyName This property is required. string
The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
kms_key_name This property is required. str
The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.
kmsKeyName This property is required. String
The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. The key needs to be in the same region as where the compute resource is created.

GoogleCloudAiplatformV1beta1ExecutionResponse

CreateTime This property is required. string
Timestamp when this Execution was created.
Description This property is required. string
Description of the Execution
DisplayName This property is required. string
User provided display name of the Execution. May be up to 128 Unicode characters.
Etag This property is required. string
An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Labels This property is required. 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).
Metadata This property is required. 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.
Name This property is required. string
The resource name of the Execution.
SchemaTitle This property is required. 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 This property is required. 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 This property is required. string
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.
UpdateTime This property is required. string
Timestamp when this Execution was last updated.
CreateTime This property is required. string
Timestamp when this Execution was created.
Description This property is required. string
Description of the Execution
DisplayName This property is required. string
User provided display name of the Execution. May be up to 128 Unicode characters.
Etag This property is required. string
An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Labels This property is required. 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).
Metadata This property is required. 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.
Name This property is required. string
The resource name of the Execution.
SchemaTitle This property is required. 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 This property is required. 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 This property is required. string
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.
UpdateTime This property is required. string
Timestamp when this Execution was last updated.
createTime This property is required. String
Timestamp when this Execution was created.
description This property is required. String
Description of the Execution
displayName This property is required. String
User provided display name of the Execution. May be up to 128 Unicode characters.
etag This property is required. String
An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels This property is required. 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).
metadata This property is required. 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.
name This property is required. String
The resource name of the Execution.
schemaTitle This property is required. 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 This property is required. 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 This property is required. String
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.
updateTime This property is required. String
Timestamp when this Execution was last updated.
createTime This property is required. string
Timestamp when this Execution was created.
description This property is required. string
Description of the Execution
displayName This property is required. string
User provided display name of the Execution. May be up to 128 Unicode characters.
etag This property is required. string
An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels This property is required. {[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).
metadata This property is required. {[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.
name This property is required. string
The resource name of the Execution.
schemaTitle This property is required. 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 This property is required. 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 This property is required. string
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.
updateTime This property is required. string
Timestamp when this Execution was last updated.
create_time This property is required. str
Timestamp when this Execution was created.
description This property is required. str
Description of the Execution
display_name This property is required. str
User provided display name of the Execution. May be up to 128 Unicode characters.
etag This property is required. str
An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels This property is required. 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).
metadata This property is required. 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.
name This property is required. str
The resource name of the Execution.
schema_title This property is required. 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 This property is required. 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 This property is required. str
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.
update_time This property is required. str
Timestamp when this Execution was last updated.
createTime This property is required. String
Timestamp when this Execution was created.
description This property is required. String
Description of the Execution
displayName This property is required. String
User provided display name of the Execution. May be up to 128 Unicode characters.
etag This property is required. String
An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels This property is required. 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).
metadata This property is required. 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.
name This property is required. String
The resource name of the Execution.
schemaTitle This property is required. 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 This property is required. 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 This property is required. String
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.
updateTime This property is required. String
Timestamp when this Execution was last updated.

GoogleCloudAiplatformV1beta1PipelineJobDetailResponse

PipelineContext This property is required. GoogleCloudAiplatformV1beta1ContextResponse
The context of the pipeline.
PipelineRunContext This property is required. GoogleCloudAiplatformV1beta1ContextResponse
The context of the current pipeline run.
TaskDetails This property is required. []GoogleCloudAiplatformV1beta1PipelineTaskDetailResponse
The runtime details of the tasks under the pipeline.
pipelineContext This property is required. GoogleCloudAiplatformV1beta1ContextResponse
The context of the pipeline.
pipelineRunContext This property is required. GoogleCloudAiplatformV1beta1ContextResponse
The context of the current pipeline run.
taskDetails This property is required. List<GoogleCloudAiplatformV1beta1PipelineTaskDetailResponse>
The runtime details of the tasks under the pipeline.
pipelineContext This property is required. GoogleCloudAiplatformV1beta1ContextResponse
The context of the pipeline.
pipelineRunContext This property is required. GoogleCloudAiplatformV1beta1ContextResponse
The context of the current pipeline run.
taskDetails This property is required. GoogleCloudAiplatformV1beta1PipelineTaskDetailResponse[]
The runtime details of the tasks under the pipeline.
pipeline_context This property is required. GoogleCloudAiplatformV1beta1ContextResponse
The context of the pipeline.
pipeline_run_context This property is required. GoogleCloudAiplatformV1beta1ContextResponse
The context of the current pipeline run.
task_details This property is required. Sequence[GoogleCloudAiplatformV1beta1PipelineTaskDetailResponse]
The runtime details of the tasks under the pipeline.
pipelineContext This property is required. Property Map
The context of the pipeline.
pipelineRunContext This property is required. Property Map
The context of the current pipeline run.
taskDetails This property is required. List<Property Map>
The runtime details of the tasks under the pipeline.

GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfigResponse

FailurePolicy This property is required. string
Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion.
GcsOutputDirectory This property is required. string
A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-path pattern {job_id}/{task_id}/{output_key} under the specified output directory. The service account specified in this pipeline must have the storage.objects.get and storage.objects.create permissions for this bucket.
InputArtifacts This property is required. Dictionary<string, string>
The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact.
ParameterValues This property is required. Dictionary<string, string>
The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using PipelineJob.pipeline_spec.schema_version 2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
Parameters This property is required. Dictionary<string, string>
Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using PipelineJob.pipeline_spec.schema_version 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.

Deprecated: Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using PipelineJob.pipeline_spec.schema_version 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.

FailurePolicy This property is required. string
Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion.
GcsOutputDirectory This property is required. string
A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-path pattern {job_id}/{task_id}/{output_key} under the specified output directory. The service account specified in this pipeline must have the storage.objects.get and storage.objects.create permissions for this bucket.
InputArtifacts This property is required. map[string]string
The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact.
ParameterValues This property is required. map[string]string
The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using PipelineJob.pipeline_spec.schema_version 2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
Parameters This property is required. map[string]string
Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using PipelineJob.pipeline_spec.schema_version 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.

Deprecated: Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using PipelineJob.pipeline_spec.schema_version 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.

failurePolicy This property is required. String
Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion.
gcsOutputDirectory This property is required. String
A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-path pattern {job_id}/{task_id}/{output_key} under the specified output directory. The service account specified in this pipeline must have the storage.objects.get and storage.objects.create permissions for this bucket.
inputArtifacts This property is required. Map<String,String>
The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact.
parameterValues This property is required. Map<String,String>
The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using PipelineJob.pipeline_spec.schema_version 2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
parameters This property is required. Map<String,String>
Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using PipelineJob.pipeline_spec.schema_version 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.

Deprecated: Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using PipelineJob.pipeline_spec.schema_version 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.

failurePolicy This property is required. string
Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion.
gcsOutputDirectory This property is required. string
A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-path pattern {job_id}/{task_id}/{output_key} under the specified output directory. The service account specified in this pipeline must have the storage.objects.get and storage.objects.create permissions for this bucket.
inputArtifacts This property is required. {[key: string]: string}
The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact.
parameterValues This property is required. {[key: string]: string}
The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using PipelineJob.pipeline_spec.schema_version 2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
parameters This property is required. {[key: string]: string}
Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using PipelineJob.pipeline_spec.schema_version 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.

Deprecated: Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using PipelineJob.pipeline_spec.schema_version 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.

failure_policy This property is required. str
Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion.
gcs_output_directory This property is required. str
A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-path pattern {job_id}/{task_id}/{output_key} under the specified output directory. The service account specified in this pipeline must have the storage.objects.get and storage.objects.create permissions for this bucket.
input_artifacts This property is required. Mapping[str, str]
The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact.
parameter_values This property is required. Mapping[str, str]
The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using PipelineJob.pipeline_spec.schema_version 2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
parameters This property is required. Mapping[str, str]
Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using PipelineJob.pipeline_spec.schema_version 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.

Deprecated: Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using PipelineJob.pipeline_spec.schema_version 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.

failurePolicy This property is required. String
Represents the failure policy of a pipeline. Currently, the default of a pipeline is that the pipeline will continue to run until no more tasks can be executed, also known as PIPELINE_FAILURE_POLICY_FAIL_SLOW. However, if a pipeline is set to PIPELINE_FAILURE_POLICY_FAIL_FAST, it will stop scheduling any new tasks when a task has failed. Any scheduled tasks will continue to completion.
gcsOutputDirectory This property is required. String
A path in a Cloud Storage bucket, which will be treated as the root output directory of the pipeline. It is used by the system to generate the paths of output artifacts. The artifact paths are generated with a sub-path pattern {job_id}/{task_id}/{output_key} under the specified output directory. The service account specified in this pipeline must have the storage.objects.get and storage.objects.create permissions for this bucket.
inputArtifacts This property is required. Map<String>
The runtime artifacts of the PipelineJob. The key will be the input artifact name and the value would be one of the InputArtifact.
parameterValues This property is required. Map<String>
The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using PipelineJob.pipeline_spec.schema_version 2.1.0, such as pipelines built using Kubeflow Pipelines SDK 1.9 or higher and the v2 DSL.
parameters This property is required. Map<String>
Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using PipelineJob.pipeline_spec.schema_version 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.

Deprecated: Deprecated. Use RuntimeConfig.parameter_values instead. The runtime parameters of the PipelineJob. The parameters will be passed into PipelineJob.pipeline_spec to replace the placeholders at runtime. This field is used by pipelines built using PipelineJob.pipeline_spec.schema_version 2.0.0 or lower, such as pipelines built using Kubeflow Pipelines SDK 1.8 or lower.

GoogleCloudAiplatformV1beta1PipelineTaskDetailPipelineTaskStatusResponse

Error This property is required. Pulumi.GoogleNative.Aiplatform.V1Beta1.Inputs.GoogleRpcStatusResponse
The error that occurred during the state. May be set when the state is any of the non-final state (PENDING/RUNNING/CANCELLING) or FAILED state. If the state is FAILED, the error here is final and not going to be retried. If the state is a non-final state, the error indicates a system-error being retried.
State This property is required. string
The state of the task.
UpdateTime This property is required. string
Update time of this status.
Error This property is required. GoogleRpcStatusResponse
The error that occurred during the state. May be set when the state is any of the non-final state (PENDING/RUNNING/CANCELLING) or FAILED state. If the state is FAILED, the error here is final and not going to be retried. If the state is a non-final state, the error indicates a system-error being retried.
State This property is required. string
The state of the task.
UpdateTime This property is required. string
Update time of this status.
error This property is required. GoogleRpcStatusResponse
The error that occurred during the state. May be set when the state is any of the non-final state (PENDING/RUNNING/CANCELLING) or FAILED state. If the state is FAILED, the error here is final and not going to be retried. If the state is a non-final state, the error indicates a system-error being retried.
state This property is required. String
The state of the task.
updateTime This property is required. String
Update time of this status.
error This property is required. GoogleRpcStatusResponse
The error that occurred during the state. May be set when the state is any of the non-final state (PENDING/RUNNING/CANCELLING) or FAILED state. If the state is FAILED, the error here is final and not going to be retried. If the state is a non-final state, the error indicates a system-error being retried.
state This property is required. string
The state of the task.
updateTime This property is required. string
Update time of this status.
error This property is required. GoogleRpcStatusResponse
The error that occurred during the state. May be set when the state is any of the non-final state (PENDING/RUNNING/CANCELLING) or FAILED state. If the state is FAILED, the error here is final and not going to be retried. If the state is a non-final state, the error indicates a system-error being retried.
state This property is required. str
The state of the task.
update_time This property is required. str
Update time of this status.
error This property is required. Property Map
The error that occurred during the state. May be set when the state is any of the non-final state (PENDING/RUNNING/CANCELLING) or FAILED state. If the state is FAILED, the error here is final and not going to be retried. If the state is a non-final state, the error indicates a system-error being retried.
state This property is required. String
The state of the task.
updateTime This property is required. String
Update time of this status.

GoogleCloudAiplatformV1beta1PipelineTaskDetailResponse

CreateTime This property is required. string
Task create time.
EndTime This property is required. string
Task end time.
Error This property is required. Pulumi.GoogleNative.Aiplatform.V1Beta1.Inputs.GoogleRpcStatusResponse
The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED.
Execution This property is required. Pulumi.GoogleNative.Aiplatform.V1Beta1.Inputs.GoogleCloudAiplatformV1beta1ExecutionResponse
The execution metadata of the task.
ExecutorDetail This property is required. Pulumi.GoogleNative.Aiplatform.V1Beta1.Inputs.GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetailResponse
The detailed execution info.
Inputs This property is required. Dictionary<string, string>
The runtime input artifacts of the task.
Outputs This property is required. Dictionary<string, string>
The runtime output artifacts of the task.
ParentTaskId This property is required. string
The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
PipelineTaskStatus This property is required. List<Pulumi.GoogleNative.Aiplatform.V1Beta1.Inputs.GoogleCloudAiplatformV1beta1PipelineTaskDetailPipelineTaskStatusResponse>
A list of task status. This field keeps a record of task status evolving over time.
StartTime This property is required. string
Task start time.
State This property is required. string
State of the task.
TaskId This property is required. string
The system generated ID of the task.
TaskName This property is required. string
The user specified name of the task that is defined in pipeline_spec.
CreateTime This property is required. string
Task create time.
EndTime This property is required. string
Task end time.
Error This property is required. GoogleRpcStatusResponse
The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED.
Execution This property is required. GoogleCloudAiplatformV1beta1ExecutionResponse
The execution metadata of the task.
ExecutorDetail This property is required. GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetailResponse
The detailed execution info.
Inputs This property is required. map[string]string
The runtime input artifacts of the task.
Outputs This property is required. map[string]string
The runtime output artifacts of the task.
ParentTaskId This property is required. string
The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
PipelineTaskStatus This property is required. []GoogleCloudAiplatformV1beta1PipelineTaskDetailPipelineTaskStatusResponse
A list of task status. This field keeps a record of task status evolving over time.
StartTime This property is required. string
Task start time.
State This property is required. string
State of the task.
TaskId This property is required. string
The system generated ID of the task.
TaskName This property is required. string
The user specified name of the task that is defined in pipeline_spec.
createTime This property is required. String
Task create time.
endTime This property is required. String
Task end time.
error This property is required. GoogleRpcStatusResponse
The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED.
execution This property is required. GoogleCloudAiplatformV1beta1ExecutionResponse
The execution metadata of the task.
executorDetail This property is required. GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetailResponse
The detailed execution info.
inputs This property is required. Map<String,String>
The runtime input artifacts of the task.
outputs This property is required. Map<String,String>
The runtime output artifacts of the task.
parentTaskId This property is required. String
The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
pipelineTaskStatus This property is required. List<GoogleCloudAiplatformV1beta1PipelineTaskDetailPipelineTaskStatusResponse>
A list of task status. This field keeps a record of task status evolving over time.
startTime This property is required. String
Task start time.
state This property is required. String
State of the task.
taskId This property is required. String
The system generated ID of the task.
taskName This property is required. String
The user specified name of the task that is defined in pipeline_spec.
createTime This property is required. string
Task create time.
endTime This property is required. string
Task end time.
error This property is required. GoogleRpcStatusResponse
The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED.
execution This property is required. GoogleCloudAiplatformV1beta1ExecutionResponse
The execution metadata of the task.
executorDetail This property is required. GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetailResponse
The detailed execution info.
inputs This property is required. {[key: string]: string}
The runtime input artifacts of the task.
outputs This property is required. {[key: string]: string}
The runtime output artifacts of the task.
parentTaskId This property is required. string
The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
pipelineTaskStatus This property is required. GoogleCloudAiplatformV1beta1PipelineTaskDetailPipelineTaskStatusResponse[]
A list of task status. This field keeps a record of task status evolving over time.
startTime This property is required. string
Task start time.
state This property is required. string
State of the task.
taskId This property is required. string
The system generated ID of the task.
taskName This property is required. string
The user specified name of the task that is defined in pipeline_spec.
create_time This property is required. str
Task create time.
end_time This property is required. str
Task end time.
error This property is required. GoogleRpcStatusResponse
The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED.
execution This property is required. GoogleCloudAiplatformV1beta1ExecutionResponse
The execution metadata of the task.
executor_detail This property is required. GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetailResponse
The detailed execution info.
inputs This property is required. Mapping[str, str]
The runtime input artifacts of the task.
outputs This property is required. Mapping[str, str]
The runtime output artifacts of the task.
parent_task_id This property is required. str
The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
pipeline_task_status This property is required. Sequence[GoogleCloudAiplatformV1beta1PipelineTaskDetailPipelineTaskStatusResponse]
A list of task status. This field keeps a record of task status evolving over time.
start_time This property is required. str
Task start time.
state This property is required. str
State of the task.
task_id This property is required. str
The system generated ID of the task.
task_name This property is required. str
The user specified name of the task that is defined in pipeline_spec.
createTime This property is required. String
Task create time.
endTime This property is required. String
Task end time.
error This property is required. Property Map
The error that occurred during task execution. Only populated when the task's state is FAILED or CANCELLED.
execution This property is required. Property Map
The execution metadata of the task.
executorDetail This property is required. Property Map
The detailed execution info.
inputs This property is required. Map<String>
The runtime input artifacts of the task.
outputs This property is required. Map<String>
The runtime output artifacts of the task.
parentTaskId This property is required. String
The id of the parent task if the task is within a component scope. Empty if the task is at the root level.
pipelineTaskStatus This property is required. List<Property Map>
A list of task status. This field keeps a record of task status evolving over time.
startTime This property is required. String
Task start time.
state This property is required. String
State of the task.
taskId This property is required. String
The system generated ID of the task.
taskName This property is required. String
The user specified name of the task that is defined in pipeline_spec.

GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetailContainerDetailResponse

FailedMainJobs This property is required. List<string>
The names of the previously failed CustomJob for the main container executions. The list includes the all attempts in chronological order.
FailedPreCachingCheckJobs This property is required. List<string>
The names of the previously failed CustomJob for the pre-caching-check container executions. This job will be available if the PipelineJob.pipeline_spec specifies the pre_caching_check hook in the lifecycle events. The list includes the all attempts in chronological order.
MainJob This property is required. string
The name of the CustomJob for the main container execution.
PreCachingCheckJob This property is required. string
The name of the CustomJob for the pre-caching-check container execution. This job will be available if the PipelineJob.pipeline_spec specifies the pre_caching_check hook in the lifecycle events.
FailedMainJobs This property is required. []string
The names of the previously failed CustomJob for the main container executions. The list includes the all attempts in chronological order.
FailedPreCachingCheckJobs This property is required. []string
The names of the previously failed CustomJob for the pre-caching-check container executions. This job will be available if the PipelineJob.pipeline_spec specifies the pre_caching_check hook in the lifecycle events. The list includes the all attempts in chronological order.
MainJob This property is required. string
The name of the CustomJob for the main container execution.
PreCachingCheckJob This property is required. string
The name of the CustomJob for the pre-caching-check container execution. This job will be available if the PipelineJob.pipeline_spec specifies the pre_caching_check hook in the lifecycle events.
failedMainJobs This property is required. List<String>
The names of the previously failed CustomJob for the main container executions. The list includes the all attempts in chronological order.
failedPreCachingCheckJobs This property is required. List<String>
The names of the previously failed CustomJob for the pre-caching-check container executions. This job will be available if the PipelineJob.pipeline_spec specifies the pre_caching_check hook in the lifecycle events. The list includes the all attempts in chronological order.
mainJob This property is required. String
The name of the CustomJob for the main container execution.
preCachingCheckJob This property is required. String
The name of the CustomJob for the pre-caching-check container execution. This job will be available if the PipelineJob.pipeline_spec specifies the pre_caching_check hook in the lifecycle events.
failedMainJobs This property is required. string[]
The names of the previously failed CustomJob for the main container executions. The list includes the all attempts in chronological order.
failedPreCachingCheckJobs This property is required. string[]
The names of the previously failed CustomJob for the pre-caching-check container executions. This job will be available if the PipelineJob.pipeline_spec specifies the pre_caching_check hook in the lifecycle events. The list includes the all attempts in chronological order.
mainJob This property is required. string
The name of the CustomJob for the main container execution.
preCachingCheckJob This property is required. string
The name of the CustomJob for the pre-caching-check container execution. This job will be available if the PipelineJob.pipeline_spec specifies the pre_caching_check hook in the lifecycle events.
failed_main_jobs This property is required. Sequence[str]
The names of the previously failed CustomJob for the main container executions. The list includes the all attempts in chronological order.
failed_pre_caching_check_jobs This property is required. Sequence[str]
The names of the previously failed CustomJob for the pre-caching-check container executions. This job will be available if the PipelineJob.pipeline_spec specifies the pre_caching_check hook in the lifecycle events. The list includes the all attempts in chronological order.
main_job This property is required. str
The name of the CustomJob for the main container execution.
pre_caching_check_job This property is required. str
The name of the CustomJob for the pre-caching-check container execution. This job will be available if the PipelineJob.pipeline_spec specifies the pre_caching_check hook in the lifecycle events.
failedMainJobs This property is required. List<String>
The names of the previously failed CustomJob for the main container executions. The list includes the all attempts in chronological order.
failedPreCachingCheckJobs This property is required. List<String>
The names of the previously failed CustomJob for the pre-caching-check container executions. This job will be available if the PipelineJob.pipeline_spec specifies the pre_caching_check hook in the lifecycle events. The list includes the all attempts in chronological order.
mainJob This property is required. String
The name of the CustomJob for the main container execution.
preCachingCheckJob This property is required. String
The name of the CustomJob for the pre-caching-check container execution. This job will be available if the PipelineJob.pipeline_spec specifies the pre_caching_check hook in the lifecycle events.

GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetailCustomJobDetailResponse

FailedJobs This property is required. List<string>
The names of the previously failed CustomJob. The list includes the all attempts in chronological order.
Job This property is required. string
The name of the CustomJob.
FailedJobs This property is required. []string
The names of the previously failed CustomJob. The list includes the all attempts in chronological order.
Job This property is required. string
The name of the CustomJob.
failedJobs This property is required. List<String>
The names of the previously failed CustomJob. The list includes the all attempts in chronological order.
job This property is required. String
The name of the CustomJob.
failedJobs This property is required. string[]
The names of the previously failed CustomJob. The list includes the all attempts in chronological order.
job This property is required. string
The name of the CustomJob.
failed_jobs This property is required. Sequence[str]
The names of the previously failed CustomJob. The list includes the all attempts in chronological order.
job This property is required. str
The name of the CustomJob.
failedJobs This property is required. List<String>
The names of the previously failed CustomJob. The list includes the all attempts in chronological order.
job This property is required. String
The name of the CustomJob.

GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetailResponse

ContainerDetail This property is required. GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetailContainerDetailResponse
The detailed info for a container executor.
CustomJobDetail This property is required. GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetailCustomJobDetailResponse
The detailed info for a custom job executor.
containerDetail This property is required. GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetailContainerDetailResponse
The detailed info for a container executor.
customJobDetail This property is required. GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetailCustomJobDetailResponse
The detailed info for a custom job executor.
containerDetail This property is required. GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetailContainerDetailResponse
The detailed info for a container executor.
customJobDetail This property is required. GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetailCustomJobDetailResponse
The detailed info for a custom job executor.
container_detail This property is required. GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetailContainerDetailResponse
The detailed info for a container executor.
custom_job_detail This property is required. GoogleCloudAiplatformV1beta1PipelineTaskExecutorDetailCustomJobDetailResponse
The detailed info for a custom job executor.
containerDetail This property is required. Property Map
The detailed info for a container executor.
customJobDetail This property is required. Property Map
The detailed info for a custom job executor.

GoogleCloudAiplatformV1beta1PipelineTemplateMetadataResponse

Version This property is required. string
The version_name in artifact registry. Will always be presented in output if the PipelineJob.template_uri is from supported template registry. Format is "sha256:abcdef123456...".
Version This property is required. string
The version_name in artifact registry. Will always be presented in output if the PipelineJob.template_uri is from supported template registry. Format is "sha256:abcdef123456...".
version This property is required. String
The version_name in artifact registry. Will always be presented in output if the PipelineJob.template_uri is from supported template registry. Format is "sha256:abcdef123456...".
version This property is required. string
The version_name in artifact registry. Will always be presented in output if the PipelineJob.template_uri is from supported template registry. Format is "sha256:abcdef123456...".
version This property is required. str
The version_name in artifact registry. Will always be presented in output if the PipelineJob.template_uri is from supported template registry. Format is "sha256:abcdef123456...".
version This property is required. String
The version_name in artifact registry. Will always be presented in output if the PipelineJob.template_uri is from supported template registry. Format is "sha256:abcdef123456...".

GoogleRpcStatusResponse

Code This property is required. int
The status code, which should be an enum value of google.rpc.Code.
Details This property is required. 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 This property is required. 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 This property is required. int
The status code, which should be an enum value of google.rpc.Code.
Details This property is required. []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 This property is required. 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 This property is required. Integer
The status code, which should be an enum value of google.rpc.Code.
details This property is required. 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 This property is required. 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 This property is required. number
The status code, which should be an enum value of google.rpc.Code.
details This property is required. {[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 This property is required. 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 This property is required. int
The status code, which should be an enum value of google.rpc.Code.
details This property is required. 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 This property is required. 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 This property is required. Number
The status code, which should be an enum value of google.rpc.Code.
details This property is required. 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 This property is required. 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.

Package Details

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

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