Cloud Vision V1 Client - Class OutputConfig (1.6.8)

Reference documentation and code samples for the Cloud Vision V1 Client class OutputConfig.

The desired output location and metadata.

Generated from protobuf message google.cloud.vision.v1.OutputConfig

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ gcs_destination Google\Cloud\Vision\V1\GcsDestination

The Google Cloud Storage location to write the output(s) to.

↳ batch_size int

The max number of response protos to put into each output JSON file on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If batch_size = 20, then 5 json files each containing 20 response protos will be written under the prefix gcs_destination.uri. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.

getGcsDestination

The Google Cloud Storage location to write the output(s) to.

Returns
TypeDescription
Google\Cloud\Vision\V1\GcsDestination|null

hasGcsDestination

clearGcsDestination

setGcsDestination

The Google Cloud Storage location to write the output(s) to.

Parameter
NameDescription
var Google\Cloud\Vision\V1\GcsDestination
Returns
TypeDescription
$this

getBatchSize

The max number of response protos to put into each output JSON file on Google Cloud Storage.

The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If batch_size = 20, then 5 json files each containing 20 response protos will be written under the prefix gcs_destination.uri. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.

Returns
TypeDescription
int

setBatchSize

The max number of response protos to put into each output JSON file on Google Cloud Storage.

The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 response protos will be generated. If batch_size = 20, then 5 json files each containing 20 response protos will be written under the prefix gcs_destination.uri. Currently, batch_size only applies to GcsDestination, with potential future support for other output configurations.

Parameter
NameDescription
var int
Returns
TypeDescription
$this