Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-132661,4471.5 MB
projects

Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run.

post/v1/{+parent}/trainingPipelines

Path parameters

parentstring required

Required. The resource name of the Location to create the TrainingPipeline in. Format: projects/{project}/locations/{location}

Request body

labelsobject

The labels with user-defined metadata to organize TrainingPipelines. 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.

updateTimestring google-datetime

Output only. Time when the TrainingPipeline was most recently updated.

state'PIPELINE_STATE_UNSPECIFIED' | 'PIPELINE_STATE_QUEUED' | 'PIPELINE_STATE_PENDING' | 'PIPELINE_STATE_RUNNING' | 'PIPELINE_STATE_SUCCEEDED' | 'PIPELINE_STATE_FAILED' | 'PIPELINE_STATE_CANCELLING' | 'PIPELINE_STATE_CANCELLED' | 'PIPELINE_STATE_PAUSED'

Output only. The detailed state of the pipeline.

{"stackTrail":"components:schemas:GoogleCloudAiplatformV1TrainingPipeline:properties:trainingTaskMetadata","oasType":"schema","type":"unknown","description":"Output only. The metadata information as specified in the training_task_definition's `metadata`. This metadata is an auxiliary runtime and final information about the training task. While the pipeline is running this information is populated only at a best effort basis. Only present if the pipeline's training_task_definition contains `metadata` object."}
createTimestring google-datetime

Output only. Time when the TrainingPipeline was created.

endTimestring google-datetime

Output only. Time when the TrainingPipeline entered any of the following states: PIPELINE_STATE_SUCCEEDED, PIPELINE_STATE_FAILED, PIPELINE_STATE_CANCELLED.

{"stackTrail":"components:schemas:GoogleCloudAiplatformV1TrainingPipeline:properties:trainingTaskInputs","oasType":"schema","type":"unknown","description":"Required. The training task's parameter(s), as specified in the training_task_definition's `inputs`."}
modelIdstring

Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name. This value may be up to 63 characters, and valid characters are [a-z0-9_-]. The first character cannot be a number or hyphen.

startTimestring google-datetime

Output only. Time when the TrainingPipeline for the first time entered the PIPELINE_STATE_RUNNING state.

displayNamestring

Required. The user-defined name of this TrainingPipeline.

parentModelstring

Optional. When specify this field, the model_to_upload will not be uploaded as a new model, instead, it will become a new version of this parent_model.

namestring

Output only. Resource name of the TrainingPipeline.

trainingTaskDefinitionstring

Required. A Google Cloud Storage path to the YAML file that defines the training task which is responsible for producing the model artifact, and may also include additional auxiliary work. The definition files that can be used here are found in gs://google-cloud-aiplatform/schema/trainingjob/definition/. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

Response

Successful response