Google_Service_Document_GoogleCloudDocumentaiV1beta2ProcessDocumentRequest
extends Google_Model
in package
This class defines attributes, valid values, and usage which is generated from a given json schema.
http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5
Table of Contents
- NULL_VALUE = "{}gapi-php-null"
- If you need to specify a NULL JSON value, use Google_Model::NULL_VALUE instead - it will be replaced when converting to JSON with a real null.
- $documentType : mixed
- $parent : mixed
- $automlParamsDataType : mixed
- $automlParamsType : mixed
- $entityExtractionParamsDataType : mixed
- $entityExtractionParamsType : mixed
- $formExtractionParamsDataType : mixed
- $formExtractionParamsType : mixed
- $inputConfigDataType : mixed
- $inputConfigType : mixed
- $internal_gapi_mappings : mixed
- $modelData : mixed
- $ocrParamsDataType : mixed
- $ocrParamsType : mixed
- $outputConfigDataType : mixed
- $outputConfigType : mixed
- $processed : mixed
- $tableExtractionParamsDataType : mixed
- $tableExtractionParamsType : mixed
- __construct() : mixed
- Polymorphic - accepts a variable number of arguments dependent on the type of the model subclass.
- __get() : mixed
- Getter that handles passthrough access to the data array, and lazy object creation.
- __isset() : mixed
- __unset() : mixed
- assertIsArray() : mixed
- Verify if $obj is an array.
- getAutomlParams() : Google_Service_Document_GoogleCloudDocumentaiV1beta2AutoMlParams
- getDocumentType() : mixed
- getEntityExtractionParams() : Google_Service_Document_GoogleCloudDocumentaiV1beta2EntityExtractionParams
- getFormExtractionParams() : Google_Service_Document_GoogleCloudDocumentaiV1beta2FormExtractionParams
- getInputConfig() : Google_Service_Document_GoogleCloudDocumentaiV1beta2InputConfig
- getOcrParams() : Google_Service_Document_GoogleCloudDocumentaiV1beta2OcrParams
- getOutputConfig() : Google_Service_Document_GoogleCloudDocumentaiV1beta2OutputConfig
- getParent() : mixed
- getTableExtractionParams() : Google_Service_Document_GoogleCloudDocumentaiV1beta2TableExtractionParams
- offsetExists() : mixed
- offsetGet() : mixed
- offsetSet() : mixed
- offsetUnset() : mixed
- setAutomlParams() : mixed
- setDocumentType() : mixed
- setEntityExtractionParams() : mixed
- setFormExtractionParams() : mixed
- setInputConfig() : mixed
- setOcrParams() : mixed
- setOutputConfig() : mixed
- setParent() : mixed
- setTableExtractionParams() : mixed
- toSimpleObject() : mixed
- Create a simplified object suitable for straightforward conversion to JSON. This is relatively expensive due to the usage of reflection, but shouldn't be called a whole lot, and is the most straightforward way to filter.
- dataType() : mixed
- gapiInit() : mixed
- Blank initialiser to be used in subclasses to do post-construction initialisation - this avoids the need for subclasses to have to implement the variadics handling in their constructors.
- isAssociativeArray() : bool
- Returns true only if the array is associative.
- keyType() : mixed
- mapTypes() : void
- Initialize this object's properties from an array.
- camelCase() : string
- Convert a string to camelCase
- getMappedName() : mixed
- If there is an internal name mapping, use that.
- getSimpleValue() : mixed
- Handle different types of values, primarily other objects and map and array data types.
- nullPlaceholderCheck() : mixed
- Check whether the value is the null placeholder and return true null.
Constants
NULL_VALUE
If you need to specify a NULL JSON value, use Google_Model::NULL_VALUE instead - it will be replaced when converting to JSON with a real null.
public
mixed
NULL_VALUE
= "{}gapi-php-null"
Properties
$documentType
public
mixed
$documentType
$parent
public
mixed
$parent
$automlParamsDataType
protected
mixed
$automlParamsDataType
= ''
$automlParamsType
protected
mixed
$automlParamsType
= 'Google_Service_Document_GoogleCloudDocumentaiV1beta2AutoMlParams'
$entityExtractionParamsDataType
protected
mixed
$entityExtractionParamsDataType
= ''
$entityExtractionParamsType
protected
mixed
$entityExtractionParamsType
= 'Google_Service_Document_GoogleCloudDocumentaiV1beta2EntityExtractionParams'
$formExtractionParamsDataType
protected
mixed
$formExtractionParamsDataType
= ''
$formExtractionParamsType
protected
mixed
$formExtractionParamsType
= 'Google_Service_Document_GoogleCloudDocumentaiV1beta2FormExtractionParams'
$inputConfigDataType
protected
mixed
$inputConfigDataType
= ''
$inputConfigType
protected
mixed
$inputConfigType
= 'Google_Service_Document_GoogleCloudDocumentaiV1beta2InputConfig'
$internal_gapi_mappings
protected
mixed
$internal_gapi_mappings
= array()
$modelData
protected
mixed
$modelData
= array()
$ocrParamsDataType
protected
mixed
$ocrParamsDataType
= ''
$ocrParamsType
protected
mixed
$ocrParamsType
= 'Google_Service_Document_GoogleCloudDocumentaiV1beta2OcrParams'
$outputConfigDataType
protected
mixed
$outputConfigDataType
= ''
$outputConfigType
protected
mixed
$outputConfigType
= 'Google_Service_Document_GoogleCloudDocumentaiV1beta2OutputConfig'
$processed
protected
mixed
$processed
= array()
$tableExtractionParamsDataType
protected
mixed
$tableExtractionParamsDataType
= ''
$tableExtractionParamsType
protected
mixed
$tableExtractionParamsType
= 'Google_Service_Document_GoogleCloudDocumentaiV1beta2TableExtractionParams'
Methods
__construct()
Polymorphic - accepts a variable number of arguments dependent on the type of the model subclass.
public
final __construct() : mixed
Return values
mixed —__get()
Getter that handles passthrough access to the data array, and lazy object creation.
public
__get(string $key) : mixed
Parameters
- $key : string
-
Property name.
Return values
mixed —The value if any, or null.
__isset()
public
__isset(mixed $key) : mixed
Parameters
- $key : mixed
Return values
mixed —__unset()
public
__unset(mixed $key) : mixed
Parameters
- $key : mixed
Return values
mixed —assertIsArray()
Verify if $obj is an array.
public
assertIsArray(array<string|int, mixed> $obj, string $method) : mixed
Parameters
- $obj : array<string|int, mixed>
-
Items that should be validated.
- $method : string
-
Method expecting an array as an argument.
Tags
Return values
mixed —getAutomlParams()
public
getAutomlParams() : Google_Service_Document_GoogleCloudDocumentaiV1beta2AutoMlParams
Return values
Google_Service_Document_GoogleCloudDocumentaiV1beta2AutoMlParams —getDocumentType()
public
getDocumentType() : mixed
Return values
mixed —getEntityExtractionParams()
public
getEntityExtractionParams() : Google_Service_Document_GoogleCloudDocumentaiV1beta2EntityExtractionParams
Return values
Google_Service_Document_GoogleCloudDocumentaiV1beta2EntityExtractionParams —getFormExtractionParams()
public
getFormExtractionParams() : Google_Service_Document_GoogleCloudDocumentaiV1beta2FormExtractionParams
Return values
Google_Service_Document_GoogleCloudDocumentaiV1beta2FormExtractionParams —getInputConfig()
public
getInputConfig() : Google_Service_Document_GoogleCloudDocumentaiV1beta2InputConfig
Return values
Google_Service_Document_GoogleCloudDocumentaiV1beta2InputConfig —getOcrParams()
public
getOcrParams() : Google_Service_Document_GoogleCloudDocumentaiV1beta2OcrParams
Return values
Google_Service_Document_GoogleCloudDocumentaiV1beta2OcrParams —getOutputConfig()
public
getOutputConfig() : Google_Service_Document_GoogleCloudDocumentaiV1beta2OutputConfig
Return values
Google_Service_Document_GoogleCloudDocumentaiV1beta2OutputConfig —getParent()
public
getParent() : mixed
Return values
mixed —getTableExtractionParams()
public
getTableExtractionParams() : Google_Service_Document_GoogleCloudDocumentaiV1beta2TableExtractionParams
Return values
Google_Service_Document_GoogleCloudDocumentaiV1beta2TableExtractionParams —offsetExists()
public
offsetExists(mixed $offset) : mixed
Parameters
- $offset : mixed
Return values
mixed —offsetGet()
public
offsetGet(mixed $offset) : mixed
Parameters
- $offset : mixed
Return values
mixed —offsetSet()
public
offsetSet(mixed $offset, mixed $value) : mixed
Parameters
- $offset : mixed
- $value : mixed
Return values
mixed —offsetUnset()
public
offsetUnset(mixed $offset) : mixed
Parameters
- $offset : mixed
Return values
mixed —setAutomlParams()
public
setAutomlParams(Google_Service_Document_GoogleCloudDocumentaiV1beta2AutoMlParams $automlParams) : mixed
Parameters
- $automlParams : Google_Service_Document_GoogleCloudDocumentaiV1beta2AutoMlParams
Return values
mixed —setDocumentType()
public
setDocumentType(mixed $documentType) : mixed
Parameters
- $documentType : mixed
Return values
mixed —setEntityExtractionParams()
public
setEntityExtractionParams(Google_Service_Document_GoogleCloudDocumentaiV1beta2EntityExtractionParams $entityExtractionParams) : mixed
Parameters
- $entityExtractionParams : Google_Service_Document_GoogleCloudDocumentaiV1beta2EntityExtractionParams
Return values
mixed —setFormExtractionParams()
public
setFormExtractionParams(Google_Service_Document_GoogleCloudDocumentaiV1beta2FormExtractionParams $formExtractionParams) : mixed
Parameters
- $formExtractionParams : Google_Service_Document_GoogleCloudDocumentaiV1beta2FormExtractionParams
Return values
mixed —setInputConfig()
public
setInputConfig(Google_Service_Document_GoogleCloudDocumentaiV1beta2InputConfig $inputConfig) : mixed
Parameters
Return values
mixed —setOcrParams()
public
setOcrParams(Google_Service_Document_GoogleCloudDocumentaiV1beta2OcrParams $ocrParams) : mixed
Parameters
Return values
mixed —setOutputConfig()
public
setOutputConfig(Google_Service_Document_GoogleCloudDocumentaiV1beta2OutputConfig $outputConfig) : mixed
Parameters
- $outputConfig : Google_Service_Document_GoogleCloudDocumentaiV1beta2OutputConfig
Return values
mixed —setParent()
public
setParent(mixed $parent) : mixed
Parameters
- $parent : mixed
Return values
mixed —setTableExtractionParams()
public
setTableExtractionParams(Google_Service_Document_GoogleCloudDocumentaiV1beta2TableExtractionParams $tableExtractionParams) : mixed
Parameters
- $tableExtractionParams : Google_Service_Document_GoogleCloudDocumentaiV1beta2TableExtractionParams
Return values
mixed —toSimpleObject()
Create a simplified object suitable for straightforward conversion to JSON. This is relatively expensive due to the usage of reflection, but shouldn't be called a whole lot, and is the most straightforward way to filter.
public
toSimpleObject() : mixed
Return values
mixed —dataType()
protected
dataType(mixed $key) : mixed
Parameters
- $key : mixed
Return values
mixed —gapiInit()
Blank initialiser to be used in subclasses to do post-construction initialisation - this avoids the need for subclasses to have to implement the variadics handling in their constructors.
protected
gapiInit() : mixed
Return values
mixed —isAssociativeArray()
Returns true only if the array is associative.
protected
isAssociativeArray(array<string|int, mixed> $array) : bool
Parameters
- $array : array<string|int, mixed>
Return values
bool —True if the array is associative.
keyType()
protected
keyType(mixed $key) : mixed
Parameters
- $key : mixed
Return values
mixed —mapTypes()
Initialize this object's properties from an array.
protected
mapTypes(array<string|int, mixed> $array) : void
Parameters
- $array : array<string|int, mixed>
-
Used to seed this object's properties.
Return values
void —camelCase()
Convert a string to camelCase
private
camelCase(string $value) : string
Parameters
- $value : string
Return values
string —getMappedName()
If there is an internal name mapping, use that.
private
getMappedName(mixed $key) : mixed
Parameters
- $key : mixed
Return values
mixed —getSimpleValue()
Handle different types of values, primarily other objects and map and array data types.
private
getSimpleValue(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —nullPlaceholderCheck()
Check whether the value is the null placeholder and return true null.
private
nullPlaceholderCheck(mixed $value) : mixed
Parameters
- $value : mixed