Cancel a custom job
Stay organized with collections
Save and categorize content based on your preferences.
Cancels a custom job using the cancel_custom_job method.
Code sample
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.
[[["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"]],[],[],[],null,["# Cancel a custom job\n\nCancels a custom job using the cancel_custom_job method.\n\nCode sample\n-----------\n\n### Node.js\n\n\nBefore trying this sample, follow the Node.js setup instructions in the\n[Vertex AI quickstart using\nclient libraries](/vertex-ai/docs/start/client-libraries).\n\n\nFor more information, see the\n[Vertex AI Node.js API\nreference documentation](/nodejs/docs/reference/aiplatform/latest).\n\n\nTo authenticate to Vertex AI, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n /**\n * TODO(developer): Uncomment these variables before running the sample.\\\n */\n\n // const customJobId = 'YOUR_CUSTOM_JOB_ID';\n // const project = 'YOUR_PROJECT_ID';\n // const location = 'YOUR_PROJECT_LOCATION';\n\n // Imports the Google Cloud Job Service Client library\n const {JobServiceClient} = require('https://cloud.google.com/nodejs/docs/reference/aiplatform/latest/overview.html');\n\n // Specifies the location of the api endpoint\n const clientOptions = {\n apiEndpoint: 'us-central1-aiplatform.googleapis.com',\n };\n\n // Instantiates a client\n const jobServiceClient = new https://cloud.google.com/nodejs/docs/reference/aiplatform/latest/overview.html(clientOptions);\n\n async function cancelCustomJob() {\n // Configure the name resource\n const name = jobServiceClient.customJobPath(project, location, customJobId);\n const request = {\n name,\n };\n\n // Cancel custom job request\n const [response] = await jobServiceClient.cancelCustomJob(request);\n\n console.log('Cancel custom job response:\\n', response);\n }\n cancelCustomJob();\n\n### Python\n\n\nBefore trying this sample, follow the Python setup instructions in the\n[Vertex AI quickstart using\nclient libraries](/vertex-ai/docs/start/client-libraries).\n\n\nFor more information, see the\n[Vertex AI Python API\nreference documentation](/python/docs/reference/aiplatform/latest).\n\n\nTo authenticate to Vertex AI, set up Application Default Credentials.\nFor more information, see\n\n[Set up authentication for a local development environment](/docs/authentication/set-up-adc-local-dev-environment).\n\n from google.cloud import aiplatform\n\n\n def cancel_custom_job_sample(\n project: str,\n custom_job_id: str,\n location: str = \"us-central1\",\n api_endpoint: str = \"us-central1-aiplatform.googleapis.com\",\n ):\n # The AI Platform services require regional API endpoints.\n client_options = {\"api_endpoint\": api_endpoint}\n # Initialize client that will be used to create and send requests.\n # This client only needs to be created once, and can be reused for multiple requests.\n client = aiplatform.gapic.https://cloud.google.com/python/docs/reference/aiplatform/latest/google.cloud.aiplatform_v1.services.job_service.JobServiceClient.html(client_options=client_options)\n name = client.https://cloud.google.com/python/docs/reference/aiplatform/latest/google.cloud.aiplatform_v1.services.job_service.JobServiceClient.html#google_cloud_aiplatform_v1_services_job_service_JobServiceClient_custom_job_path(\n project=project, location=location, custom_job=custom_job_id\n )\n response = client.https://cloud.google.com/python/docs/reference/aiplatform/latest/google.cloud.aiplatform_v1.services.job_service.JobServiceClient.html#google_cloud_aiplatform_v1_services_job_service_JobServiceClient_cancel_custom_job(name=name)\n print(\"response:\", response)\n\nWhat's next\n-----------\n\n\nTo search and filter code samples for other Google Cloud products, see the\n[Google Cloud sample browser](/docs/samples?product=aiplatform)."]]