Google Cloud Datastore Admin V1 Client - Class ExportEntitiesMetadata (0.5.8)

Reference documentation and code samples for the Google Cloud Datastore Admin V1 Client class ExportEntitiesMetadata.

Metadata for ExportEntities operations.

Generated from protobuf message google.datastore.admin.v1.ExportEntitiesMetadata

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ common Google\Cloud\Datastore\Admin\V1\CommonMetadata

Metadata common to all Datastore Admin operations.

↳ progress_entities Google\Cloud\Datastore\Admin\V1\Progress

An estimate of the number of entities processed.

↳ progress_bytes Google\Cloud\Datastore\Admin\V1\Progress

An estimate of the number of bytes processed.

↳ entity_filter Google\Cloud\Datastore\Admin\V1\EntityFilter

Description of which entities are being exported.

↳ output_url_prefix string

Location for the export metadata and data files. This will be the same value as the google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix field. The final output location is provided in google.datastore.admin.v1.ExportEntitiesResponse.output_url.

getCommon

Metadata common to all Datastore Admin operations.

Returns
TypeDescription
Google\Cloud\Datastore\Admin\V1\CommonMetadata|null

hasCommon

clearCommon

setCommon

Metadata common to all Datastore Admin operations.

Parameter
NameDescription
var Google\Cloud\Datastore\Admin\V1\CommonMetadata
Returns
TypeDescription
$this

getProgressEntities

An estimate of the number of entities processed.

Returns
TypeDescription
Google\Cloud\Datastore\Admin\V1\Progress|null

hasProgressEntities

clearProgressEntities

setProgressEntities

An estimate of the number of entities processed.

Parameter
NameDescription
var Google\Cloud\Datastore\Admin\V1\Progress
Returns
TypeDescription
$this

getProgressBytes

An estimate of the number of bytes processed.

Returns
TypeDescription
Google\Cloud\Datastore\Admin\V1\Progress|null

hasProgressBytes

clearProgressBytes

setProgressBytes

An estimate of the number of bytes processed.

Parameter
NameDescription
var Google\Cloud\Datastore\Admin\V1\Progress
Returns
TypeDescription
$this

getEntityFilter

Description of which entities are being exported.

Returns
TypeDescription
Google\Cloud\Datastore\Admin\V1\EntityFilter|null

hasEntityFilter

clearEntityFilter

setEntityFilter

Description of which entities are being exported.

Parameter
NameDescription
var Google\Cloud\Datastore\Admin\V1\EntityFilter
Returns
TypeDescription
$this

getOutputUrlPrefix

Location for the export metadata and data files. This will be the same value as the google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix field. The final output location is provided in google.datastore.admin.v1.ExportEntitiesResponse.output_url.

Returns
TypeDescription
string

setOutputUrlPrefix

Location for the export metadata and data files. This will be the same value as the google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix field. The final output location is provided in google.datastore.admin.v1.ExportEntitiesResponse.output_url.

Parameter
NameDescription
var string
Returns
TypeDescription
$this