Cloud Natural Language V1 Client - Class Document (0.34.1)

Reference documentation and code samples for the Cloud Natural Language V1 Client class Document.

Represents the input to API methods.

Generated from protobuf message google.cloud.language.v1.Document

Namespace

Google \ Cloud \ Language \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ type int

Required. If the type is not set or is TYPE_UNSPECIFIED, returns an INVALID_ARGUMENT error.
↳ content string

The content of the input in string format. Cloud audit logging exempt since it is based on user data.
↳ gcs_content_uri string

The Google Cloud Storage URI where the file content is located. This URI must be of the form: gs://bucket_name/object_name. For more details, see https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object versioning is not supported.
↳ language string

The language of the document (if not specified, the language is automatically detected). Both ISO and BCP-47 language codes are accepted.
Language Support lists currently supported languages for each API method. If the language (either specified by the caller or automatically detected) is not supported by the called API method, an INVALID_ARGUMENT error is returned.

getType

Required. If the type is not set or is TYPE_UNSPECIFIED, returns an INVALID_ARGUMENT error.

Returns
Type Description
int

setType

Required. If the type is not set or is TYPE_UNSPECIFIED, returns an INVALID_ARGUMENT error.

Parameter
Name Description
var int
Returns
Type Description
$this

getContent

The content of the input in string format.

Cloud audit logging exempt since it is based on user data.

Returns
Type Description
string

hasContent

setContent

The content of the input in string format.

Cloud audit logging exempt since it is based on user data.

Parameter
Name Description
var string
Returns
Type Description
$this

getGcsContentUri

The Google Cloud Storage URI where the file content is located.

This URI must be of the form: gs://bucket_name/object_name. For more details, see https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object versioning is not supported.

Returns
Type Description
string

hasGcsContentUri

setGcsContentUri

The Google Cloud Storage URI where the file content is located.

This URI must be of the form: gs://bucket_name/object_name. For more details, see https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object versioning is not supported.

Parameter
Name Description
var string
Returns
Type Description
$this

getLanguage

The language of the document (if not specified, the language is automatically detected). Both ISO and BCP-47 language codes are accepted.
Language Support lists currently supported languages for each API method. If the language (either specified by the caller or automatically detected) is not supported by the called API method, an INVALID_ARGUMENT error is returned.

Returns
Type Description
string

setLanguage

The language of the document (if not specified, the language is automatically detected). Both ISO and BCP-47 language codes are accepted.
Language Support lists currently supported languages for each API method. If the language (either specified by the caller or automatically detected) is not supported by the called API method, an INVALID_ARGUMENT error is returned.

Parameter
Name Description
var string
Returns
Type Description
$this

getSource

Returns
Type Description
string