Reference documentation and code samples for the Storage Batch Operations V1 API class Google::Cloud::StorageBatchOperations::V1::Job.
The Storage Batch Operations Job description.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#bucket_list
def bucket_list() -> ::Google::Cloud::StorageBatchOperations::V1::BucketList- (::Google::Cloud::StorageBatchOperations::V1::BucketList) — Specifies a list of buckets and their objects to be transformed.
#bucket_list=
def bucket_list=(value) -> ::Google::Cloud::StorageBatchOperations::V1::BucketList- value (::Google::Cloud::StorageBatchOperations::V1::BucketList) — Specifies a list of buckets and their objects to be transformed.
- (::Google::Cloud::StorageBatchOperations::V1::BucketList) — Specifies a list of buckets and their objects to be transformed.
#complete_time
def complete_time() -> ::Google::Protobuf::Timestamp- (::Google::Protobuf::Timestamp) — Output only. The time that the job was completed.
#counters
def counters() -> ::Google::Cloud::StorageBatchOperations::V1::Counters- (::Google::Cloud::StorageBatchOperations::V1::Counters) — Output only. Information about the progress of the job.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp- (::Google::Protobuf::Timestamp) — Output only. The time that the job was created.
#delete_object
def delete_object() -> ::Google::Cloud::StorageBatchOperations::V1::DeleteObject-
(::Google::Cloud::StorageBatchOperations::V1::DeleteObject) — Delete objects.
Note: The following fields are mutually exclusive:
delete_object,put_object_hold,put_metadata,rewrite_object. If a field in that set is populated, all other fields in the set will automatically be cleared.
#delete_object=
def delete_object=(value) -> ::Google::Cloud::StorageBatchOperations::V1::DeleteObject-
value (::Google::Cloud::StorageBatchOperations::V1::DeleteObject) — Delete objects.
Note: The following fields are mutually exclusive:
delete_object,put_object_hold,put_metadata,rewrite_object. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::StorageBatchOperations::V1::DeleteObject) — Delete objects.
Note: The following fields are mutually exclusive:
delete_object,put_object_hold,put_metadata,rewrite_object. If a field in that set is populated, all other fields in the set will automatically be cleared.
#description
def description() -> ::String- (::String) — Optional. A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
#description=
def description=(value) -> ::String- value (::String) — Optional. A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
- (::String) — Optional. A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded.
#error_summaries
def error_summaries() -> ::Array<::Google::Cloud::StorageBatchOperations::V1::ErrorSummary>- (::Array<::Google::Cloud::StorageBatchOperations::V1::ErrorSummary>) — Output only. Summarizes errors encountered with sample error log entries.
#logging_config
def logging_config() -> ::Google::Cloud::StorageBatchOperations::V1::LoggingConfig- (::Google::Cloud::StorageBatchOperations::V1::LoggingConfig) — Optional. Logging configuration.
#logging_config=
def logging_config=(value) -> ::Google::Cloud::StorageBatchOperations::V1::LoggingConfig- value (::Google::Cloud::StorageBatchOperations::V1::LoggingConfig) — Optional. Logging configuration.
- (::Google::Cloud::StorageBatchOperations::V1::LoggingConfig) — Optional. Logging configuration.
#name
def name() -> ::String- (::String) — Identifier. The resource name of the Job. job_id is unique within the project and location, that is either set by the customer or defined by the service. Format: projects/{project}/locations/{location}/jobs/{job_id} . For example: "projects/123456/locations/us-central1/jobs/job01".
#name=
def name=(value) -> ::String- value (::String) — Identifier. The resource name of the Job. job_id is unique within the project and location, that is either set by the customer or defined by the service. Format: projects/{project}/locations/{location}/jobs/{job_id} . For example: "projects/123456/locations/us-central1/jobs/job01".
- (::String) — Identifier. The resource name of the Job. job_id is unique within the project and location, that is either set by the customer or defined by the service. Format: projects/{project}/locations/{location}/jobs/{job_id} . For example: "projects/123456/locations/us-central1/jobs/job01".
#put_metadata
def put_metadata() -> ::Google::Cloud::StorageBatchOperations::V1::PutMetadata-
(::Google::Cloud::StorageBatchOperations::V1::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.
Note: The following fields are mutually exclusive:
put_metadata,put_object_hold,delete_object,rewrite_object. If a field in that set is populated, all other fields in the set will automatically be cleared.
#put_metadata=
def put_metadata=(value) -> ::Google::Cloud::StorageBatchOperations::V1::PutMetadata-
value (::Google::Cloud::StorageBatchOperations::V1::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.
Note: The following fields are mutually exclusive:
put_metadata,put_object_hold,delete_object,rewrite_object. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::StorageBatchOperations::V1::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.
Note: The following fields are mutually exclusive:
put_metadata,put_object_hold,delete_object,rewrite_object. If a field in that set is populated, all other fields in the set will automatically be cleared.
#put_object_hold
def put_object_hold() -> ::Google::Cloud::StorageBatchOperations::V1::PutObjectHold-
(::Google::Cloud::StorageBatchOperations::V1::PutObjectHold) — Changes object hold status.
Note: The following fields are mutually exclusive:
put_object_hold,delete_object,put_metadata,rewrite_object. If a field in that set is populated, all other fields in the set will automatically be cleared.
#put_object_hold=
def put_object_hold=(value) -> ::Google::Cloud::StorageBatchOperations::V1::PutObjectHold-
value (::Google::Cloud::StorageBatchOperations::V1::PutObjectHold) — Changes object hold status.
Note: The following fields are mutually exclusive:
put_object_hold,delete_object,put_metadata,rewrite_object. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::StorageBatchOperations::V1::PutObjectHold) — Changes object hold status.
Note: The following fields are mutually exclusive:
put_object_hold,delete_object,put_metadata,rewrite_object. If a field in that set is populated, all other fields in the set will automatically be cleared.
#rewrite_object
def rewrite_object() -> ::Google::Cloud::StorageBatchOperations::V1::RewriteObject-
(::Google::Cloud::StorageBatchOperations::V1::RewriteObject) — Rewrite the object and updates metadata like KMS key.
Note: The following fields are mutually exclusive:
rewrite_object,put_object_hold,delete_object,put_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.
#rewrite_object=
def rewrite_object=(value) -> ::Google::Cloud::StorageBatchOperations::V1::RewriteObject-
value (::Google::Cloud::StorageBatchOperations::V1::RewriteObject) — Rewrite the object and updates metadata like KMS key.
Note: The following fields are mutually exclusive:
rewrite_object,put_object_hold,delete_object,put_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.
-
(::Google::Cloud::StorageBatchOperations::V1::RewriteObject) — Rewrite the object and updates metadata like KMS key.
Note: The following fields are mutually exclusive:
rewrite_object,put_object_hold,delete_object,put_metadata. If a field in that set is populated, all other fields in the set will automatically be cleared.
#schedule_time
def schedule_time() -> ::Google::Protobuf::Timestamp- (::Google::Protobuf::Timestamp) — Output only. The time that the job was scheduled.
#state
def state() -> ::Google::Cloud::StorageBatchOperations::V1::Job::State- (::Google::Cloud::StorageBatchOperations::V1::Job::State) — Output only. State of the job.