Storage Batch Operations V1 API - Class Google::Cloud::StorageBatchOperations::V1::BucketOperation (v0.6.0)

Reference documentation and code samples for the Storage Batch Operations V1 API class Google::Cloud::StorageBatchOperations::V1::BucketOperation.

BucketOperation represents a bucket-level breakdown of a Job.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#bucket_name

def bucket_name() -> ::String
Returns
  • (::String) — The bucket name of the objects to be transformed in the BucketOperation.

#bucket_name=

def bucket_name=(value) -> ::String
Parameter
  • value (::String) — The bucket name of the objects to be transformed in the BucketOperation.
Returns
  • (::String) — The bucket name of the objects to be transformed in the BucketOperation.

#complete_time

def complete_time() -> ::Google::Protobuf::Timestamp
Returns

#counters

def counters() -> ::Google::Cloud::StorageBatchOperations::V1::Counters
Returns

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#delete_object

def delete_object() -> ::Google::Cloud::StorageBatchOperations::V1::DeleteObject
Returns
  • (::Google::Cloud::StorageBatchOperations::V1::DeleteObject) — Delete objects.

    Note: The following fields are mutually exclusive: delete_object, put_object_hold, put_metadata, rewrite_object, update_object_custom_context. 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
Parameter
  • value (::Google::Cloud::StorageBatchOperations::V1::DeleteObject) — Delete objects.

    Note: The following fields are mutually exclusive: delete_object, put_object_hold, put_metadata, rewrite_object, update_object_custom_context. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::StorageBatchOperations::V1::DeleteObject) — Delete objects.

    Note: The following fields are mutually exclusive: delete_object, put_object_hold, put_metadata, rewrite_object, update_object_custom_context. If a field in that set is populated, all other fields in the set will automatically be cleared.

#error_summaries

def error_summaries() -> ::Array<::Google::Cloud::StorageBatchOperations::V1::ErrorSummary>
Returns

#manifest

def manifest() -> ::Google::Cloud::StorageBatchOperations::V1::Manifest
Returns
  • (::Google::Cloud::StorageBatchOperations::V1::Manifest) — Specifies objects in a manifest file.

    Note: The following fields are mutually exclusive: manifest, prefix_list. If a field in that set is populated, all other fields in the set will automatically be cleared.

#manifest=

def manifest=(value) -> ::Google::Cloud::StorageBatchOperations::V1::Manifest
Parameter
  • value (::Google::Cloud::StorageBatchOperations::V1::Manifest) — Specifies objects in a manifest file.

    Note: The following fields are mutually exclusive: manifest, prefix_list. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::StorageBatchOperations::V1::Manifest) — Specifies objects in a manifest file.

    Note: The following fields are mutually exclusive: manifest, prefix_list. If a field in that set is populated, all other fields in the set will automatically be cleared.

#name

def name() -> ::String
Returns
  • (::String) — Identifier. The resource name of the BucketOperation. This is defined by the service. Format: projects/{project}/locations/global/jobs/{job_id}/bucketOperations/{bucket_operation}.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Identifier. The resource name of the BucketOperation. This is defined by the service. Format: projects/{project}/locations/global/jobs/{job_id}/bucketOperations/{bucket_operation}.
Returns
  • (::String) — Identifier. The resource name of the BucketOperation. This is defined by the service. Format: projects/{project}/locations/global/jobs/{job_id}/bucketOperations/{bucket_operation}.

#prefix_list

def prefix_list() -> ::Google::Cloud::StorageBatchOperations::V1::PrefixList
Returns

#prefix_list=

def prefix_list=(value) -> ::Google::Cloud::StorageBatchOperations::V1::PrefixList
Parameter
  • value (::Google::Cloud::StorageBatchOperations::V1::PrefixList) — Specifies objects matching a prefix set.

    Note: The following fields are mutually exclusive: prefix_list, manifest. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

#put_metadata

def put_metadata() -> ::Google::Cloud::StorageBatchOperations::V1::PutMetadata
Returns
  • (::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, update_object_custom_context. 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
Parameter
  • 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, update_object_custom_context. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::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, update_object_custom_context. 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
Returns
  • (::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, update_object_custom_context. 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
Parameter
  • 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, update_object_custom_context. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::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, update_object_custom_context. 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
Returns
  • (::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, update_object_custom_context. 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
Parameter
  • 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, update_object_custom_context. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::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, update_object_custom_context. If a field in that set is populated, all other fields in the set will automatically be cleared.

#start_time

def start_time() -> ::Google::Protobuf::Timestamp
Returns

#state

def state() -> ::Google::Cloud::StorageBatchOperations::V1::BucketOperation::State
Returns

#update_object_custom_context

def update_object_custom_context() -> ::Google::Cloud::StorageBatchOperations::V1::UpdateObjectCustomContext
Returns

#update_object_custom_context=

def update_object_custom_context=(value) -> ::Google::Cloud::StorageBatchOperations::V1::UpdateObjectCustomContext
Parameter
  • value (::Google::Cloud::StorageBatchOperations::V1::UpdateObjectCustomContext) — Update object custom context.

    Note: The following fields are mutually exclusive: update_object_custom_context, 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.

Returns