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 message google.cloud.storagebatchoperations.v1.Job
Namespace
Google \ Cloud \ StorageBatchOperations \ V1Methods
__construct
Constructor.
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.
↳ bucket_list
↳ put_object_hold
↳ delete_object
↳ put_metadata
PutMetadata
Updates object metadata. Allows updating fixed-key and custom metadata and fixed-key metadata i.e. Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, Custom-Time.
↳ rewrite_object
↳ logging_config
↳ create_time
↳ schedule_time
↳ complete_time
↳ counters
↳ error_summaries
↳ state
int
Output only. State of the job.
↳ dry_run
bool
Optional. If true, the job will run in dry run mode, returning the total object count and, if the object configuration is a prefix list, the bytes found from source. No transformations will be performed.
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".
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".
var
string
$this
getDescription
Optional. A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
string
setDescription
Optional. A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
var
string
$this
getBucketList
Specifies a list of buckets and their objects to be transformed.
hasBucketList
setBucketList
Specifies a list of buckets and their objects to be transformed.
$this
getPutObjectHold
Changes object hold status.
hasPutObjectHold
setPutObjectHold
Changes object hold status.
$this
getDeleteObject
Delete objects.
hasDeleteObject
setDeleteObject
Delete objects.
$this
getPutMetadata
Updates object metadata. Allows updating fixed-key and custom metadata and fixed-key metadata i.e. Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, Custom-Time.
hasPutMetadata
setPutMetadata
Updates object metadata. Allows updating fixed-key and custom metadata and fixed-key metadata i.e. Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, Custom-Time.
$this
getRewriteObject
Rewrite the object and updates metadata like KMS key.
hasRewriteObject
setRewriteObject
Rewrite the object and updates metadata like KMS key.
$this
getLoggingConfig
Optional. Logging configuration.
hasLoggingConfig
clearLoggingConfig
setLoggingConfig
Optional. Logging configuration.
$this
getCreateTime
Output only. The time that the job was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time that the job was created.
$this
getScheduleTime
Output only. The time that the job was scheduled.
hasScheduleTime
clearScheduleTime
setScheduleTime
Output only. The time that the job was scheduled.
$this
getCompleteTime
Output only. The time that the job was completed.
hasCompleteTime
clearCompleteTime
setCompleteTime
Output only. The time that the job was completed.
$this
getCounters
Output only. Information about the progress of the job.
hasCounters
clearCounters
setCounters
Output only. Information about the progress of the job.
$this
getErrorSummaries
Output only. Summarizes errors encountered with sample error log entries.
setErrorSummaries
Output only. Summarizes errors encountered with sample error log entries.
$this
getState
Output only. State of the job.
setState
Output only. State of the job.
$this
getDryRun
Optional. If true, the job will run in dry run mode, returning the total object count and, if the object configuration is a prefix list, the bytes found from source. No transformations will be performed.
bool
setDryRun
Optional. If true, the job will run in dry run mode, returning the total object count and, if the object configuration is a prefix list, the bytes found from source. No transformations will be performed.
var
bool
$this
getSource
string
getTransformation
string
