Send feedback
Method: googleapis.ml.v1.projects.jobs.patch
Stay organized with collections
Save and categorize content based on your preferences.
Updates a specific job resource. Currently the only supported fields to
update are labels.
Arguments
Parameters
name
string
Required. The job name.
updateMask
string (FieldMask format)
Required. Specifies the path, relative to Job, of the field to update. To adopt etag mechanism, include etag field in the mask, and include the etag value in your job resource. For example, to change the labels of a job, the update_mask parameter would be specified as labels, etag, and the PATCH request body would specify the new value, as follows: { "labels": { "owner": "Google", "color": "Blue" } "etag": "33a64df551425fcc55e4d42a148795d9f25f89d4" } If etag matches the one on the server, the labels of the job will be replaced with the given ones, and the server end etag will be recalculated. Currently the only supported update masks are labels and etag.
body
object (GoogleCloudMlV1__Job )
Required.
Raised exceptions
Exceptions
ConnectionErrorIn case of a network problem (such as DNS failure or refused connection).
HttpErrorIf the response status is >= 400 (excluding 429 and 503).
TimeoutErrorIf a long-running operation takes longer to finish than the specified timeout limit.
TypeErrorIf an operation or function receives an argument of the wrong type.
ValueErrorIf an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.
Response
If successful, the response contains an instance of GoogleCloudMlV1__Job
Subworkflow snippet
Some fields might be optional or required.
To identify required fields, refer to the API documentation .
YAML
- patch :
call : googleapis.ml.v1.projects.jobs.patch
args :
name : ...
updateMask : ...
body :
etag : ...
jobId : ...
labels : ...
predictionInput :
batchSize : ...
dataFormat : ...
inputPaths : ...
maxWorkerCount : ...
modelName : ...
outputDataFormat : ...
outputPath : ...
region : ...
runtimeVersion : ...
signatureName : ...
uri : ...
versionName : ...
predictionOutput :
errorCount : ...
nodeHours : ...
outputPath : ...
predictionCount : ...
trainingInput :
args : ...
enableWebAccess : ...
encryptionConfig :
kmsKeyName : ...
evaluatorConfig :
acceleratorConfig :
count : ...
type : ...
containerArgs : ...
containerCommand : ...
diskConfig :
bootDiskSizeGb : ...
bootDiskType : ...
imageUri : ...
tpuTfVersion : ...
evaluatorCount : ...
evaluatorType : ...
hyperparameters :
algorithm : ...
enableTrialEarlyStopping : ...
goal : ...
hyperparameterMetricTag : ...
maxFailedTrials : ...
maxParallelTrials : ...
maxTrials : ...
params : ...
resumePreviousJobId : ...
jobDir : ...
masterConfig : ...
masterType : ...
network : ...
packageUris : ...
parameterServerConfig : ...
parameterServerCount : ...
parameterServerType : ...
pythonModule : ...
pythonVersion : ...
region : ...
runtimeVersion : ...
scaleTier : ...
scheduling :
maxRunningTime : ...
maxWaitTime : ...
priority : ...
serviceAccount : ...
useChiefInTfConfig : ...
workerConfig : ...
workerCount : ...
workerType : ...
trainingOutput :
builtInAlgorithmOutput :
framework : ...
modelPath : ...
pythonVersion : ...
runtimeVersion : ...
completedTrialCount : ...
consumedMLUnits : ...
hyperparameterMetricTag : ...
isBuiltInAlgorithmJob : ...
isHyperparameterTuningJob : ...
trials : ...
result : patchResult
JSON
[
{
"patch" : {
"call" : "googleapis.ml.v1.projects.jobs.patch" ,
"args" : {
"name" : "..." ,
"updateMask" : "..." ,
"body" : {
"etag" : "..." ,
"jobId" : "..." ,
"labels" : "..." ,
"predictionInput" : {
"batchSize" : "..." ,
"dataFormat" : "..." ,
"inputPaths" : "..." ,
"maxWorkerCount" : "..." ,
"modelName" : "..." ,
"outputDataFormat" : "..." ,
"outputPath" : "..." ,
"region" : "..." ,
"runtimeVersion" : "..." ,
"signatureName" : "..." ,
"uri" : "..." ,
"versionName" : "..."
},
"predictionOutput" : {
"errorCount" : "..." ,
"nodeHours" : "..." ,
"outputPath" : "..." ,
"predictionCount" : "..."
},
"trainingInput" : {
"args" : "..." ,
"enableWebAccess" : "..." ,
"encryptionConfig" : {
"kmsKeyName" : "..."
},
"evaluatorConfig" : {
"acceleratorConfig" : {
"count" : "..." ,
"type" : "..."
},
"containerArgs" : "..." ,
"containerCommand" : "..." ,
"diskConfig" : {
"bootDiskSizeGb" : "..." ,
"bootDiskType" : "..."
},
"imageUri" : "..." ,
"tpuTfVersion" : "..."
},
"evaluatorCount" : "..." ,
"evaluatorType" : "..." ,
"hyperparameters" : {
"algorithm" : "..." ,
"enableTrialEarlyStopping" : "..." ,
"goal" : "..." ,
"hyperparameterMetricTag" : "..." ,
"maxFailedTrials" : "..." ,
"maxParallelTrials" : "..." ,
"maxTrials" : "..." ,
"params" : "..." ,
"resumePreviousJobId" : "..."
},
"jobDir" : "..." ,
"masterConfig" : "..." ,
"masterType" : "..." ,
"network" : "..." ,
"packageUris" : "..." ,
"parameterServerConfig" : "..." ,
"parameterServerCount" : "..." ,
"parameterServerType" : "..." ,
"pythonModule" : "..." ,
"pythonVersion" : "..." ,
"region" : "..." ,
"runtimeVersion" : "..." ,
"scaleTier" : "..." ,
"scheduling" : {
"maxRunningTime" : "..." ,
"maxWaitTime" : "..." ,
"priority" : "..."
},
"serviceAccount" : "..." ,
"useChiefInTfConfig" : "..." ,
"workerConfig" : "..." ,
"workerCount" : "..." ,
"workerType" : "..."
},
"trainingOutput" : {
"builtInAlgorithmOutput" : {
"framework" : "..." ,
"modelPath" : "..." ,
"pythonVersion" : "..." ,
"runtimeVersion" : "..."
},
"completedTrialCount" : "..." ,
"consumedMLUnits" : "..." ,
"hyperparameterMetricTag" : "..." ,
"isBuiltInAlgorithmJob" : "..." ,
"isHyperparameterTuningJob" : "..." ,
"trials" : "..."
}
}
},
"result" : "patchResult"
}
}
]
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Method: googleapis.ml.v1.projects.jobs.patch\n\nUpdates a specific job resource. Currently the only supported fields to\nupdate are `labels`.\n\nArguments\n---------\n\nRaised exceptions\n-----------------\n\nResponse\n--------\n\nIf successful, the response contains an instance of [`GoogleCloudMlV1__Job`](https://cloud.google.com/workflows/docs/reference/googleapis/ml/v1/Overview#GoogleCloudMlV1__Job).\n\nSubworkflow snippet\n-------------------\n\nSome fields might be optional or required.\nTo identify required fields, refer to the [API documentation](https://cloud.google.com/ai-platform/training/docs/reference/rest/v1/projects.jobs/patch). \n\n### YAML\n\n```yaml\n- patch:\n call: googleapis.ml.v1.projects.jobs.patch\n args:\n name: ...\n updateMask: ...\n body:\n etag: ...\n jobId: ...\n labels: ...\n predictionInput:\n batchSize: ...\n dataFormat: ...\n inputPaths: ...\n maxWorkerCount: ...\n modelName: ...\n outputDataFormat: ...\n outputPath: ...\n region: ...\n runtimeVersion: ...\n signatureName: ...\n uri: ...\n versionName: ...\n predictionOutput:\n errorCount: ...\n nodeHours: ...\n outputPath: ...\n predictionCount: ...\n trainingInput:\n args: ...\n enableWebAccess: ...\n encryptionConfig:\n kmsKeyName: ...\n evaluatorConfig:\n acceleratorConfig:\n count: ...\n type: ...\n containerArgs: ...\n containerCommand: ...\n diskConfig:\n bootDiskSizeGb: ...\n bootDiskType: ...\n imageUri: ...\n tpuTfVersion: ...\n evaluatorCount: ...\n evaluatorType: ...\n hyperparameters:\n algorithm: ...\n enableTrialEarlyStopping: ...\n goal: ...\n hyperparameterMetricTag: ...\n maxFailedTrials: ...\n maxParallelTrials: ...\n maxTrials: ...\n params: ...\n resumePreviousJobId: ...\n jobDir: ...\n masterConfig: ...\n masterType: ...\n network: ...\n packageUris: ...\n parameterServerConfig: ...\n parameterServerCount: ...\n parameterServerType: ...\n pythonModule: ...\n pythonVersion: ...\n region: ...\n runtimeVersion: ...\n scaleTier: ...\n scheduling:\n maxRunningTime: ...\n maxWaitTime: ...\n priority: ...\n serviceAccount: ...\n useChiefInTfConfig: ...\n workerConfig: ...\n workerCount: ...\n workerType: ...\n trainingOutput:\n builtInAlgorithmOutput:\n framework: ...\n modelPath: ...\n pythonVersion: ...\n runtimeVersion: ...\n completedTrialCount: ...\n consumedMLUnits: ...\n hyperparameterMetricTag: ...\n isBuiltInAlgorithmJob: ...\n isHyperparameterTuningJob: ...\n trials: ...\n result: patchResult\n```\n\n### JSON\n\n```json\n[\n {\n \"patch\": {\n \"call\": \"googleapis.ml.v1.projects.jobs.patch\",\n \"args\": {\n \"name\": \"...\",\n \"updateMask\": \"...\",\n \"body\": {\n \"etag\": \"...\",\n \"jobId\": \"...\",\n \"labels\": \"...\",\n \"predictionInput\": {\n \"batchSize\": \"...\",\n \"dataFormat\": \"...\",\n \"inputPaths\": \"...\",\n \"maxWorkerCount\": \"...\",\n \"modelName\": \"...\",\n \"outputDataFormat\": \"...\",\n \"outputPath\": \"...\",\n \"region\": \"...\",\n \"runtimeVersion\": \"...\",\n \"signatureName\": \"...\",\n \"uri\": \"...\",\n \"versionName\": \"...\"\n },\n \"predictionOutput\": {\n \"errorCount\": \"...\",\n \"nodeHours\": \"...\",\n \"outputPath\": \"...\",\n \"predictionCount\": \"...\"\n },\n \"trainingInput\": {\n \"args\": \"...\",\n \"enableWebAccess\": \"...\",\n \"encryptionConfig\": {\n \"kmsKeyName\": \"...\"\n },\n \"evaluatorConfig\": {\n \"acceleratorConfig\": {\n \"count\": \"...\",\n \"type\": \"...\"\n },\n \"containerArgs\": \"...\",\n \"containerCommand\": \"...\",\n \"diskConfig\": {\n \"bootDiskSizeGb\": \"...\",\n \"bootDiskType\": \"...\"\n },\n \"imageUri\": \"...\",\n \"tpuTfVersion\": \"...\"\n },\n \"evaluatorCount\": \"...\",\n \"evaluatorType\": \"...\",\n \"hyperparameters\": {\n \"algorithm\": \"...\",\n \"enableTrialEarlyStopping\": \"...\",\n \"goal\": \"...\",\n \"hyperparameterMetricTag\": \"...\",\n \"maxFailedTrials\": \"...\",\n \"maxParallelTrials\": \"...\",\n \"maxTrials\": \"...\",\n \"params\": \"...\",\n \"resumePreviousJobId\": \"...\"\n },\n \"jobDir\": \"...\",\n \"masterConfig\": \"...\",\n \"masterType\": \"...\",\n \"network\": \"...\",\n \"packageUris\": \"...\",\n \"parameterServerConfig\": \"...\",\n \"parameterServerCount\": \"...\",\n \"parameterServerType\": \"...\",\n \"pythonModule\": \"...\",\n \"pythonVersion\": \"...\",\n \"region\": \"...\",\n \"runtimeVersion\": \"...\",\n \"scaleTier\": \"...\",\n \"scheduling\": {\n \"maxRunningTime\": \"...\",\n \"maxWaitTime\": \"...\",\n \"priority\": \"...\"\n },\n \"serviceAccount\": \"...\",\n \"useChiefInTfConfig\": \"...\",\n \"workerConfig\": \"...\",\n \"workerCount\": \"...\",\n \"workerType\": \"...\"\n },\n \"trainingOutput\": {\n \"builtInAlgorithmOutput\": {\n \"framework\": \"...\",\n \"modelPath\": \"...\",\n \"pythonVersion\": \"...\",\n \"runtimeVersion\": \"...\"\n },\n \"completedTrialCount\": \"...\",\n \"consumedMLUnits\": \"...\",\n \"hyperparameterMetricTag\": \"...\",\n \"isBuiltInAlgorithmJob\": \"...\",\n \"isHyperparameterTuningJob\": \"...\",\n \"trials\": \"...\"\n }\n }\n },\n \"result\": \"patchResult\"\n }\n }\n]\n```"]]
