Google Cloud Storage Transfer V1 Client - Class TransferCounters (1.0.6)

Reference documentation and code samples for the Google Cloud Storage Transfer V1 Client class TransferCounters.

A collection of counters that report the progress of a transfer operation.

Generated from protobuf message google.storagetransfer.v1.TransferCounters

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ objects_found_from_source`	`int\|string` Objects found in the data source that are scheduled to be transferred, excluding any that are filtered based on object conditions or skipped due to sync.
`↳ bytes_found_from_source`	`int\|string` Bytes found in the data source that are scheduled to be transferred, excluding any that are filtered based on object conditions or skipped due to sync.
`↳ objects_found_only_from_sink`	`int\|string` Objects found only in the data sink that are scheduled to be deleted.
`↳ bytes_found_only_from_sink`	`int\|string` Bytes found only in the data sink that are scheduled to be deleted.
`↳ objects_from_source_skipped_by_sync`	`int\|string` Objects in the data source that are not transferred because they already exist in the data sink.
`↳ bytes_from_source_skipped_by_sync`	`int\|string` Bytes in the data source that are not transferred because they already exist in the data sink.
`↳ objects_copied_to_sink`	`int\|string` Objects that are copied to the data sink.
`↳ bytes_copied_to_sink`	`int\|string` Bytes that are copied to the data sink.
`↳ objects_deleted_from_source`	`int\|string` Objects that are deleted from the data source.
`↳ bytes_deleted_from_source`	`int\|string` Bytes that are deleted from the data source.
`↳ objects_deleted_from_sink`	`int\|string` Objects that are deleted from the data sink.
`↳ bytes_deleted_from_sink`	`int\|string` Bytes that are deleted from the data sink.
`↳ objects_from_source_failed`	`int\|string` Objects in the data source that failed to be transferred or that failed to be deleted after being transferred.
`↳ bytes_from_source_failed`	`int\|string` Bytes in the data source that failed to be transferred or that failed to be deleted after being transferred.
`↳ objects_failed_to_delete_from_sink`	`int\|string` Objects that failed to be deleted from the data sink.
`↳ bytes_failed_to_delete_from_sink`	`int\|string` Bytes that failed to be deleted from the data sink.
`↳ directories_found_from_source`	`int\|string` For transfers involving PosixFilesystem only. Number of directories found while listing. For example, if the root directory of the transfer is `base/` and there are two other directories, `a/` and `b/` under this directory, the count after listing `base/`, `base/a/` and `base/b/` is 3.
`↳ directories_failed_to_list_from_source`	`int\|string` For transfers involving PosixFilesystem only. Number of listing failures for each directory found at the source. Potential failures when listing a directory include permission failure or block failure. If listing a directory fails, no files in the directory are transferred.
`↳ directories_successfully_listed_from_source`	`int\|string` For transfers involving PosixFilesystem only. Number of successful listings for each directory found at the source.
`↳ intermediate_objects_cleaned_up`	`int\|string` Number of successfully cleaned up intermediate objects.
`↳ intermediate_objects_failed_cleaned_up`	`int\|string` Number of intermediate objects failed cleaned up.

getObjectsFoundFromSource

Objects found in the data source that are scheduled to be transferred, excluding any that are filtered based on object conditions or skipped due to sync.

Returns
Type	Description
`int\|string`

setObjectsFoundFromSource

Objects found in the data source that are scheduled to be transferred, excluding any that are filtered based on object conditions or skipped due to sync.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getBytesFoundFromSource

Bytes found in the data source that are scheduled to be transferred, excluding any that are filtered based on object conditions or skipped due to sync.

Returns
Type	Description
`int\|string`

setBytesFoundFromSource

Bytes found in the data source that are scheduled to be transferred, excluding any that are filtered based on object conditions or skipped due to sync.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getObjectsFoundOnlyFromSink

Objects found only in the data sink that are scheduled to be deleted.

Returns
Type	Description
`int\|string`

setObjectsFoundOnlyFromSink

Objects found only in the data sink that are scheduled to be deleted.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getBytesFoundOnlyFromSink

Bytes found only in the data sink that are scheduled to be deleted.

Returns
Type	Description
`int\|string`

setBytesFoundOnlyFromSink

Bytes found only in the data sink that are scheduled to be deleted.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getObjectsFromSourceSkippedBySync

Objects in the data source that are not transferred because they already exist in the data sink.

Returns
Type	Description
`int\|string`

setObjectsFromSourceSkippedBySync

Objects in the data source that are not transferred because they already exist in the data sink.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getBytesFromSourceSkippedBySync

Bytes in the data source that are not transferred because they already exist in the data sink.

Returns
Type	Description
`int\|string`

setBytesFromSourceSkippedBySync

Bytes in the data source that are not transferred because they already exist in the data sink.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getObjectsCopiedToSink

Objects that are copied to the data sink.

Returns
Type	Description
`int\|string`

setObjectsCopiedToSink

Objects that are copied to the data sink.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getBytesCopiedToSink

Bytes that are copied to the data sink.

Returns
Type	Description
`int\|string`

setBytesCopiedToSink

Bytes that are copied to the data sink.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getObjectsDeletedFromSource

Objects that are deleted from the data source.

Returns
Type	Description
`int\|string`

setObjectsDeletedFromSource

Objects that are deleted from the data source.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getBytesDeletedFromSource

Bytes that are deleted from the data source.

Returns
Type	Description
`int\|string`

setBytesDeletedFromSource

Bytes that are deleted from the data source.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getObjectsDeletedFromSink

Objects that are deleted from the data sink.

Returns
Type	Description
`int\|string`

setObjectsDeletedFromSink

Objects that are deleted from the data sink.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getBytesDeletedFromSink

Bytes that are deleted from the data sink.

Returns
Type	Description
`int\|string`

setBytesDeletedFromSink

Bytes that are deleted from the data sink.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getObjectsFromSourceFailed

Objects in the data source that failed to be transferred or that failed to be deleted after being transferred.

Returns
Type	Description
`int\|string`

setObjectsFromSourceFailed

Objects in the data source that failed to be transferred or that failed to be deleted after being transferred.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getBytesFromSourceFailed

Bytes in the data source that failed to be transferred or that failed to be deleted after being transferred.

Returns
Type	Description
`int\|string`

setBytesFromSourceFailed

Bytes in the data source that failed to be transferred or that failed to be deleted after being transferred.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getObjectsFailedToDeleteFromSink

Objects that failed to be deleted from the data sink.

Returns
Type	Description
`int\|string`

setObjectsFailedToDeleteFromSink

Objects that failed to be deleted from the data sink.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getBytesFailedToDeleteFromSink

Bytes that failed to be deleted from the data sink.

Returns
Type	Description
`int\|string`

setBytesFailedToDeleteFromSink

Bytes that failed to be deleted from the data sink.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`