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

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

Describes options to update object custom contexts.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#clear_all

def clear_all() -> ::Boolean
Returns
  • (::Boolean) — If set, must be set to true and all existing object custom contexts will be deleted.

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

#clear_all=

def clear_all=(value) -> ::Boolean
Parameter
  • value (::Boolean) — If set, must be set to true and all existing object custom contexts will be deleted.

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

Returns
  • (::Boolean) — If set, must be set to true and all existing object custom contexts will be deleted.

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

#custom_context_updates

def custom_context_updates() -> ::Google::Cloud::StorageBatchOperations::V1::CustomContextUpdates
Returns
  • (::Google::Cloud::StorageBatchOperations::V1::CustomContextUpdates) — A collection of updates to apply to specific custom contexts. Use this to add, update or delete individual contexts by key.

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

#custom_context_updates=

def custom_context_updates=(value) -> ::Google::Cloud::StorageBatchOperations::V1::CustomContextUpdates
Parameter
  • value (::Google::Cloud::StorageBatchOperations::V1::CustomContextUpdates) — A collection of updates to apply to specific custom contexts. Use this to add, update or delete individual contexts by key.

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

Returns
  • (::Google::Cloud::StorageBatchOperations::V1::CustomContextUpdates) — A collection of updates to apply to specific custom contexts. Use this to add, update or delete individual contexts by key.

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