GetPipelineJobResult class

Result data returned by getPipelineJob.

Constructors

GetPipelineJobResult({required String createTime, required String displayName, required GoogleCloudAiplatformV1EncryptionSpecResponse encryptionSpec, required String endTime, required GoogleRpcStatusResponse error, required GoogleCloudAiplatformV1PipelineJobDetailResponse jobDetail, required Map<String, String> labels, required String name, required String network, required Map<String, String> pipelineSpec, required List<String> reservedIpRanges, required GoogleCloudAiplatformV1PipelineJobRuntimeConfigResponse runtimeConfig, required String scheduleName, required String serviceAccount, required String startTime, required String state, required GoogleCloudAiplatformV1PipelineTemplateMetadataResponse templateMetadata, required String templateUri, required String updateTime})
Creates a new GetPipelineJobResult. createTime Pipeline creation time. displayName The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters. encryptionSpec 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 Pipeline end time. error The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED. jobDetail The details of pipeline run. Not available in the list view. labels 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 The resource name of the PipelineJob. network 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 The spec of the pipeline. reservedIpRanges 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 Runtime config of the pipeline. scheduleName The schedule resource name. Only returned if the Pipeline is created by Schedule API. serviceAccount 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 Pipeline start time. state The detailed state of the job. templateMetadata Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry. templateUri 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 Timestamp when this PipelineJob was most recently updated.
const
GetPipelineJobResult.fromMap(Map<String, dynamic> map)
factory

Properties

createTime → String
Pipeline creation time.
final
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.
final
encryptionSpec → GoogleCloudAiplatformV1EncryptionSpecResponse
Customer-managed encryption key spec for a pipelineJob. If set, this PipelineJob and all of its sub-resources will be secured by this key.
final
endTime → String
Pipeline end time.
final
error → GoogleRpcStatusResponse
The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
final
hashCode → int
The hash code for this object.
no setterinherited
jobDetail → GoogleCloudAiplatformV1PipelineJobDetailResponse
The details of pipeline run. Not available in the list view.
final
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.
final
name → String
The resource name of the PipelineJob.
final
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.
final
pipelineSpec → Map<String, String>
The spec of the pipeline.
final
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'.
final
runtimeConfig → GoogleCloudAiplatformV1PipelineJobRuntimeConfigResponse
Runtime config of the pipeline.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scheduleName → String
The schedule resource name. Only returned if the Pipeline is created by Schedule API.
final
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.
final
startTime → String
Pipeline start time.
final
state → String
The detailed state of the job.
final
templateMetadata → GoogleCloudAiplatformV1PipelineTemplateMetadataResponse
Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
final
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.
final
updateTime → String
Timestamp when this PipelineJob was most recently updated.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited