Method: googleapis.ml.v1.projects.jobs.patch

Updates a specific job resource. Currently the only supported fields to update are labels.

Arguments

Parameters

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.

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
`ConnectionError`	In case of a network problem (such as DNS failure or refused connection).
`HttpError`	If the response status is >= 400 (excluding 429 and 503).
`TimeoutError`	If a long-running operation takes longer to finish than the specified timeout limit.
`TypeError`	If an operation or function receives an argument of the wrong type.
`ValueError`	If 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"
    }
  }
]