- 0.55.0 (latest)
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.1
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::PipelineJob.
An instance of a machine learning PipelineJob.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. Pipeline creation time.
#display_name
def display_name() -> ::String
- (::String) — The display name of the Pipeline. The name can be up to 128 characters long and can be consist of any UTF-8 characters.
#display_name=
def display_name=(value) -> ::String
- value (::String) — The display name of the Pipeline. The name can be up to 128 characters long and can be consist of any UTF-8 characters.
- (::String) — The display name of the Pipeline. The name can be up to 128 characters long and can be consist of any UTF-8 characters.
#encryption_spec
def encryption_spec() -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec
- (::Google::Cloud::AIPlatform::V1::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.
#encryption_spec=
def encryption_spec=(value) -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec
- value (::Google::Cloud::AIPlatform::V1::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.
- (::Google::Cloud::AIPlatform::V1::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.
#end_time
def end_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. Pipeline end time.
#error
def error() -> ::Google::Rpc::Status
- (::Google::Rpc::Status) — Output only. The error that occurred during pipeline execution. Only populated when the pipeline's state is FAILED or CANCELLED.
#job_detail
def job_detail() -> ::Google::Cloud::AIPlatform::V1::PipelineJobDetail
- (::Google::Cloud::AIPlatform::V1::PipelineJobDetail) — Output only. The details of pipeline run. Not available in the list view.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
-
(::Google::Protobuf::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.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
-
value (::Google::Protobuf::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.
-
(::Google::Protobuf::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.
#name
def name() -> ::String
- (::String) — Output only. The resource name of the PipelineJob.
#network
def network() -> ::String
-
(::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 formprojects/{project}/global/networks/{network}
. Where {project} is a project number, as in12345
, 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 GCP resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.
#network=
def network=(value) -> ::String
-
value (::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 formprojects/{project}/global/networks/{network}
. Where {project} is a project number, as in12345
, 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 GCP resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any 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 formprojects/{project}/global/networks/{network}
. Where {project} is a project number, as in12345
, 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 GCP 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
def pipeline_spec() -> ::Google::Protobuf::Struct
- (::Google::Protobuf::Struct) — The spec of the pipeline.
#pipeline_spec=
def pipeline_spec=(value) -> ::Google::Protobuf::Struct
- value (::Google::Protobuf::Struct) — The spec of the pipeline.
- (::Google::Protobuf::Struct) — The spec of the pipeline.
#runtime_config
def runtime_config() -> ::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig
- (::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig) — Runtime config of the pipeline.
#runtime_config=
def runtime_config=(value) -> ::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig
- value (::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig) — Runtime config of the pipeline.
- (::Google::Cloud::AIPlatform::V1::PipelineJob::RuntimeConfig) — Runtime config of the pipeline.
#service_account
def service_account() -> ::String
-
(::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.
#service_account=
def service_account=(value) -> ::String
-
value (::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.
-
(::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.
#start_time
def start_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. Pipeline start time.
#state
def state() -> ::Google::Cloud::AIPlatform::V1::PipelineState
- (::Google::Cloud::AIPlatform::V1::PipelineState) — Output only. The detailed state of the job.
#template_metadata
def template_metadata() -> ::Google::Cloud::AIPlatform::V1::PipelineTemplateMetadata
- (::Google::Cloud::AIPlatform::V1::PipelineTemplateMetadata) — Output only. Pipeline template metadata. Will fill up fields if PipelineJob.template_uri is from supported template registry.
#template_uri
def template_uri() -> ::String
- (::String) — A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded.
#template_uri=
def template_uri=(value) -> ::String
- value (::String) — A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded.
- (::String) — A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — Output only. Timestamp when this PipelineJob was most recently updated.