Google Cloud Storage Batch Operations V1 Client - Class UpdateObjectCustomContext (0.5.0)

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

Describes options to update object custom contexts.

Generated from protobuf message google.cloud.storagebatchoperations.v1.UpdateObjectCustomContext

Namespace

Google \ Cloud \ StorageBatchOperations \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ custom_context_updates CustomContextUpdates

A collection of updates to apply to specific custom contexts. Use this to add, update or delete individual contexts by key.

↳ clear_all bool

If set, must be set to true and all existing object custom contexts will be deleted.

getCustomContextUpdates

A collection of updates to apply to specific custom contexts.

Use this to add, update or delete individual contexts by key.

Returns
Type Description
CustomContextUpdates|null

hasCustomContextUpdates

setCustomContextUpdates

A collection of updates to apply to specific custom contexts.

Use this to add, update or delete individual contexts by key.

Parameter
Name Description
var CustomContextUpdates
Returns
Type Description
$this

getClearAll

If set, must be set to true and all existing object custom contexts will be deleted.

Returns
Type Description
bool

hasClearAll

setClearAll

If set, must be set to true and all existing object custom contexts will be deleted.

Parameter
Name Description
var bool
Returns
Type Description
$this

getAction

Returns
Type Description
string