Reference documentation and code samples for the Google Cloud Storage Batch Operations V1 Client class Job.
The Storage Batch Operations Job description.
Generated from protobuf messagegoogle.cloud.storagebatchoperations.v1.Job
Namespace
Google \ Cloud \ StorageBatchOperations \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Identifier. The resource name of the Job. job_id is unique within the project, that is either set by the customer or defined by the service. Format: projects/{project}/locations/global/jobs/{job_id} . For example: "projects/123456/locations/global/jobs/job01".
↳ description
string
Optional. A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
Output only. Summarizes errors encountered with sample error log entries.
↳ state
int
Output only. State of the job.
getName
Identifier. The resource name of the Job. job_id is unique
within the project, that is either set by the customer or
defined by the service. Format:
projects/{project}/locations/global/jobs/{job_id} .
For example: "projects/123456/locations/global/jobs/job01".
Returns
Type
Description
string
setName
Identifier. The resource name of the Job. job_id is unique
within the project, that is either set by the customer or
defined by the service. Format:
projects/{project}/locations/global/jobs/{job_id} .
For example: "projects/123456/locations/global/jobs/job01".
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDescription
Optional. A description provided by the user for the job. Its max length is
1024 bytes when Unicode-encoded.
Returns
Type
Description
string
setDescription
Optional. A description provided by the user for the job. Its max length is
1024 bytes when Unicode-encoded.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getBucketList
Specifies a list of buckets and their objects to be transformed.
[[["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-09-04 UTC."],[],[],null,["# Google Cloud Storage Batch Operations V1 Client - Class Job (0.1.2)\n\nVersion latestkeyboard_arrow_down\n\n- [0.1.2 (latest)](/php/docs/reference/cloud-storagebatchoperations/latest/V1.Job)\n- [0.1.1](/php/docs/reference/cloud-storagebatchoperations/0.1.1/V1.Job) \nReference documentation and code samples for the Google Cloud Storage Batch Operations V1 Client class Job.\n\nThe Storage Batch Operations Job description.\n\nGenerated from protobuf message `google.cloud.storagebatchoperations.v1.Job`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ StorageBatchOperations \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nIdentifier. The resource name of the Job. job_id is unique\nwithin the project, that is either set by the customer or\ndefined by the service. Format:\nprojects/{project}/locations/global/jobs/{job_id} .\n\nFor example: \"projects/123456/locations/global/jobs/job01\".\n\n### setName\n\nIdentifier. The resource name of the Job. job_id is unique\nwithin the project, that is either set by the customer or\ndefined by the service. Format:\nprojects/{project}/locations/global/jobs/{job_id} .\n\nFor example: \"projects/123456/locations/global/jobs/job01\".\n\n### getDescription\n\nOptional. A description provided by the user for the job. Its max length is\n1024 bytes when Unicode-encoded.\n\n### setDescription\n\nOptional. A description provided by the user for the job. Its max length is\n1024 bytes when Unicode-encoded.\n\n### getBucketList\n\nSpecifies a list of buckets and their objects to be transformed.\n\n### hasBucketList\n\n### setBucketList\n\nSpecifies a list of buckets and their objects to be transformed.\n\n### getPutObjectHold\n\nChanges object hold status.\n\n### hasPutObjectHold\n\n### setPutObjectHold\n\nChanges object hold status.\n\n### getDeleteObject\n\nDelete objects.\n\n### hasDeleteObject\n\n### setDeleteObject\n\nDelete objects.\n\n### getPutMetadata\n\nUpdates object metadata. Allows updating fixed-key and custom metadata\nand fixed-key metadata i.e. Cache-Control, Content-Disposition,\nContent-Encoding, Content-Language, Content-Type, Custom-Time.\n\n### hasPutMetadata\n\n### setPutMetadata\n\nUpdates object metadata. Allows updating fixed-key and custom metadata\nand fixed-key metadata i.e. Cache-Control, Content-Disposition,\nContent-Encoding, Content-Language, Content-Type, Custom-Time.\n\n### getRewriteObject\n\nRewrite the object and updates metadata like KMS key.\n\n### hasRewriteObject\n\n### setRewriteObject\n\nRewrite the object and updates metadata like KMS key.\n\n### getLoggingConfig\n\nOptional. Logging configuration.\n\n### hasLoggingConfig\n\n### clearLoggingConfig\n\n### setLoggingConfig\n\nOptional. Logging configuration.\n\n### getCreateTime\n\nOutput only. The time that the job was created.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nOutput only. The time that the job was created.\n\n### getScheduleTime\n\nOutput only. The time that the job was scheduled.\n\n### hasScheduleTime\n\n### clearScheduleTime\n\n### setScheduleTime\n\nOutput only. The time that the job was scheduled.\n\n### getCompleteTime\n\nOutput only. The time that the job was completed.\n\n### hasCompleteTime\n\n### clearCompleteTime\n\n### setCompleteTime\n\nOutput only. The time that the job was completed.\n\n### getCounters\n\nOutput only. Information about the progress of the job.\n\n### hasCounters\n\n### clearCounters\n\n### setCounters\n\nOutput only. Information about the progress of the job.\n\n### getErrorSummaries\n\nOutput only. Summarizes errors encountered with sample error log entries.\n\n### setErrorSummaries\n\nOutput only. Summarizes errors encountered with sample error log entries.\n\n### getState\n\nOutput only. State of the job.\n\n### setState\n\nOutput only. State of the job.\n\n### getSource\n\n### getTransformation"]]
