Reference documentation and code samples for the Google Cloud Storage Batch Operations V1 Client class CancelJobRequest.
Message for Job to Cancel
Generated from protobuf message google.cloud.storagebatchoperations.v1.CancelJobRequest
Namespace
Google \ Cloud \ StorageBatchOperations \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The name of the job to cancel. Format: projects/{project_id}/locations/global/jobs/{job_id}.
↳ request_id
string
Optional. An optional request ID to identify requests. Specify a unique request ID in case you need to retry your request. Requests with same request_id will be ignored for at least 60 minutes since the first request. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Optional. An optional request ID to identify requests. Specify a unique
request ID in case you need to retry your request. Requests with same
request_id will be ignored for at least 60 minutes since the first
request. The request ID must be a valid UUID with the exception that zero
UUID is not supported (00000000-0000-0000-0000-000000000000).
Returns
Type
Description
string
setRequestId
Optional. An optional request ID to identify requests. Specify a unique
request ID in case you need to retry your request. Requests with same
request_id will be ignored for at least 60 minutes since the first
request. The request ID must be a valid UUID with the exception that zero
UUID is not supported (00000000-0000-0000-0000-000000000000).
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
name
string
Required. The name of the job to cancel.
Format: projects/{project_id}/locations/global/jobs/{job_id}. Please see
StorageBatchOperationsClient::jobName() for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Google Cloud Storage Batch Operations V1 Client - Class CancelJobRequest (0.1.2)\n\nVersion latestkeyboard_arrow_down\n\n- [0.1.2 (latest)](/php/docs/reference/cloud-storagebatchoperations/latest/V1.CancelJobRequest)\n- [0.1.1](/php/docs/reference/cloud-storagebatchoperations/0.1.1/V1.CancelJobRequest) \nReference documentation and code samples for the Google Cloud Storage Batch Operations V1 Client class CancelJobRequest.\n\nMessage for Job to Cancel\n\nGenerated from protobuf message `google.cloud.storagebatchoperations.v1.CancelJobRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ StorageBatchOperations \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. The `name` of the job to cancel.\n\nFormat: projects/{project_id}/locations/global/jobs/{job_id}.\n\n### setName\n\nRequired. The `name` of the job to cancel.\n\nFormat: projects/{project_id}/locations/global/jobs/{job_id}.\n\n### getRequestId\n\nOptional. An optional request ID to identify requests. Specify a unique\nrequest ID in case you need to retry your request. Requests with same\n`request_id` will be ignored for at least 60 minutes since the first\nrequest. The request ID must be a valid UUID with the exception that zero\nUUID is not supported (00000000-0000-0000-0000-000000000000).\n\n### setRequestId\n\nOptional. An optional request ID to identify requests. Specify a unique\nrequest ID in case you need to retry your request. Requests with same\n`request_id` will be ignored for at least 60 minutes since the first\nrequest. The request ID must be a valid UUID with the exception that zero\nUUID is not supported (00000000-0000-0000-0000-000000000000).\n\n### static::build"]]
