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.
| 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. |
↳ bucket_list |
BucketList
Specifies a list of buckets and their objects to be transformed. |
↳ put_object_hold |
PutObjectHold
Changes object hold status. |
↳ delete_object |
DeleteObject
Delete objects. |
↳ 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 |
RewriteObject
Rewrite the object and updates metadata like KMS key. |
↳ logging_config |
LoggingConfig
Optional. Logging configuration. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The time that the job was created. |
↳ schedule_time |
Google\Protobuf\Timestamp
Output only. The time that the job was scheduled. |
↳ complete_time |
Google\Protobuf\Timestamp
Output only. The time that the job was completed. |
↳ counters |
Counters
Output only. Information about the progress of the job. |
↳ error_summaries |
array<ErrorSummary>
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.
| Returns | |
|---|---|
| Type | Description |
BucketList|null |
|
hasBucketList
setBucketList
Specifies a list of buckets and their objects to be transformed.
| Parameter | |
|---|---|
| Name | Description |
var |
BucketList
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPutObjectHold
Changes object hold status.
| Returns | |
|---|---|
| Type | Description |
PutObjectHold|null |
|
hasPutObjectHold
setPutObjectHold
Changes object hold status.
| Parameter | |
|---|---|
| Name | Description |
var |
PutObjectHold
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeleteObject
Delete objects.
| Returns | |
|---|---|
| Type | Description |
DeleteObject|null |
|
hasDeleteObject
setDeleteObject
Delete objects.
| Parameter | |
|---|---|
| Name | Description |
var |
DeleteObject
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
PutMetadata|null |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
PutMetadata
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRewriteObject
Rewrite the object and updates metadata like KMS key.
| Returns | |
|---|---|
| Type | Description |
RewriteObject|null |
|
hasRewriteObject
setRewriteObject
Rewrite the object and updates metadata like KMS key.
| Parameter | |
|---|---|
| Name | Description |
var |
RewriteObject
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLoggingConfig
Optional. Logging configuration.
| Returns | |
|---|---|
| Type | Description |
LoggingConfig|null |
|
hasLoggingConfig
clearLoggingConfig
setLoggingConfig
Optional. Logging configuration.
| Parameter | |
|---|---|
| Name | Description |
var |
LoggingConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The time that the job was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The time that the job was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getScheduleTime
Output only. The time that the job was scheduled.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasScheduleTime
clearScheduleTime
setScheduleTime
Output only. The time that the job was scheduled.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCompleteTime
Output only. The time that the job was completed.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCompleteTime
clearCompleteTime
setCompleteTime
Output only. The time that the job was completed.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCounters
Output only. Information about the progress of the job.
| Returns | |
|---|---|
| Type | Description |
Counters|null |
|
hasCounters
clearCounters
setCounters
Output only. Information about the progress of the job.
| Parameter | |
|---|---|
| Name | Description |
var |
Counters
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getErrorSummaries
Output only. Summarizes errors encountered with sample error log entries.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setErrorSummaries
Output only. Summarizes errors encountered with sample error log entries.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ErrorSummary>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Output only. State of the job.
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Output only. State of the job.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSource
| Returns | |
|---|---|
| Type | Description |
string |
|
getTransformation
| Returns | |
|---|---|
| Type | Description |
string |
|