GOgoogle
projects

GET /v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}

Gets a TrainingPipeline.

Request

  • Base URL
    https://aiplatform.googleapis.com
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/cloud-platform
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform

Path parameters

projectsIdstring required
locationsIdstring required
trainingPipelinesIdstring required

Response

Successful response

createTimestring google-datetime

Output only. Time when the TrainingPipeline was created.

displayNamestring

Required. The user-defined name of this TrainingPipeline.

endTimestring google-datetime

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

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.

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.

namestring

Output only. Resource name of the 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.

startTimestring google-datetime

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

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.

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.

trainingTaskInputsunknown
trainingTaskMetadataunknown
updateTimestring google-datetime

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

Changes

No recorded changes to this operation across all 8 revisions of this API.