Google Cloud Storage Batch Operations V1 Client - Class Counters (0.7.0)

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

Describes details about the progress of the job.

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

Namespace

Google \ Cloud \ StorageBatchOperations \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ total_object_count
int|string

Output only. Number of objects listed.

↳ succeeded_object_count
int|string

Output only. Number of objects completed.

↳ failed_object_count
int|string

Output only. The number of objects that failed due to user errors or service errors.

↳ total_bytes_found
int|string

Output only. Number of bytes found from source. This field is only populated for jobs with a prefix list object configuration.

↳ object_custom_contexts_created
int|string

Output only. Number of object custom contexts created. This field is only populated for jobs with the UpdateObjectCustomContext transformation.

↳ object_custom_contexts_deleted
int|string

Output only. Number of object custom contexts deleted. This field is only populated for jobs with the UpdateObjectCustomContext transformation.

↳ object_custom_contexts_updated
int|string

Output only. Number of object custom contexts updated. This counter tracks custom contexts where the key already existed, but the payload was modified. This field is only populated for jobs with the UpdateObjectCustomContext transformation.

getTotalObjectCount

Output only. Number of objects listed.

Returns
Type
Description
int|string

setTotalObjectCount

Output only. Number of objects listed.

Parameter
Name
Description
var
int|string
Returns
Type
Description
$this

getSucceededObjectCount

Output only. Number of objects completed.

Returns
Type
Description
int|string

setSucceededObjectCount

Output only. Number of objects completed.

Parameter
Name
Description
var
int|string
Returns
Type
Description
$this

getFailedObjectCount

Output only. The number of objects that failed due to user errors or service errors.

Returns
Type
Description
int|string

setFailedObjectCount

Output only. The number of objects that failed due to user errors or service errors.

Parameter
Name
Description
var
int|string
Returns
Type
Description
$this

getTotalBytesFound

Output only. Number of bytes found from source. This field is only populated for jobs with a prefix list object configuration.

Returns
Type
Description
int|string

hasTotalBytesFound

clearTotalBytesFound

setTotalBytesFound

Output only. Number of bytes found from source. This field is only populated for jobs with a prefix list object configuration.

Parameter
Name
Description
var
int|string
Returns
Type
Description
$this

getObjectCustomContextsCreated

Output only. Number of object custom contexts created. This field is only populated for jobs with the UpdateObjectCustomContext transformation.

Returns
Type
Description
int|string

hasObjectCustomContextsCreated

clearObjectCustomContextsCreated

setObjectCustomContextsCreated

Output only. Number of object custom contexts created. This field is only populated for jobs with the UpdateObjectCustomContext transformation.

Parameter
Name
Description
var
int|string
Returns
Type
Description
$this

getObjectCustomContextsDeleted

Output only. Number of object custom contexts deleted. This field is only populated for jobs with the UpdateObjectCustomContext transformation.

Returns
Type
Description
int|string

hasObjectCustomContextsDeleted

clearObjectCustomContextsDeleted

setObjectCustomContextsDeleted

Output only. Number of object custom contexts deleted. This field is only populated for jobs with the UpdateObjectCustomContext transformation.

Parameter
Name
Description
var
int|string
Returns
Type
Description
$this

getObjectCustomContextsUpdated

Output only. Number of object custom contexts updated. This counter tracks custom contexts where the key already existed, but the payload was modified. This field is only populated for jobs with the UpdateObjectCustomContext transformation.

Returns
Type
Description
int|string

hasObjectCustomContextsUpdated

clearObjectCustomContextsUpdated

setObjectCustomContextsUpdated

Output only. Number of object custom contexts updated. This counter tracks custom contexts where the key already existed, but the payload was modified. This field is only populated for jobs with the UpdateObjectCustomContext transformation.

Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: