Interface DocumentOrBuilder (2.55.0)

Version 2.55.0

• 2.56.0 (latest)
• 2.55.0
• 2.54.0
• 2.53.0
• 2.52.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.1
• 2.3.4
• 2.2.0
• 2.1.10

public interface DocumentOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBoilerplateHandling()

public abstract Document.BoilerplateHandling getBoilerplateHandling()

Indicates how detected boilerplate(e.g. advertisements, copyright declarations, banners) should be handled for this document. If not specified, boilerplate will be treated the same as content.

.google.cloud.language.v1beta2.Document.BoilerplateHandling boilerplate_handling = 6;

Returns
Type	Description
Document.BoilerplateHandling	The boilerplateHandling.

getBoilerplateHandlingValue()

public abstract int getBoilerplateHandlingValue()

Indicates how detected boilerplate(e.g. advertisements, copyright declarations, banners) should be handled for this document. If not specified, boilerplate will be treated the same as content.

.google.cloud.language.v1beta2.Document.BoilerplateHandling boilerplate_handling = 6;

Returns
Type	Description
int	The enum numeric value on the wire for boilerplateHandling.

getContent()

public abstract String getContent()

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

string content = 2;

Returns
Type	Description
String	The content.

getContentBytes()

public abstract ByteString getContentBytes()

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

string content = 2;

Returns
Type	Description
ByteString	The bytes for content.

getGcsContentUri()

public abstract String 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.

string gcs_content_uri = 3;

Returns
Type	Description
String	The gcsContentUri.

getGcsContentUriBytes()

public abstract ByteString getGcsContentUriBytes()

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.

string gcs_content_uri = 3;

Returns
Type	Description
ByteString	The bytes for gcsContentUri.

getLanguage()

public abstract String getLanguage()

The language of the document (if not specified, the language is automatically detected). Both ISO and BCP-47 language codes are accepted.<br> 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.

string language = 4;

Returns
Type	Description
String	The language.

getLanguageBytes()

public abstract ByteString getLanguageBytes()

The language of the document (if not specified, the language is automatically detected). Both ISO and BCP-47 language codes are accepted.<br> 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.

string language = 4;

Returns
Type	Description
ByteString	The bytes for language.

getReferenceWebUri()

public abstract String getReferenceWebUri()

The web URI where the document comes from. This URI is not used for fetching the content, but as a hint for analyzing the document.

string reference_web_uri = 5;

Returns
Type	Description
String	The referenceWebUri.

getReferenceWebUriBytes()

public abstract ByteString getReferenceWebUriBytes()

The web URI where the document comes from. This URI is not used for fetching the content, but as a hint for analyzing the document.

string reference_web_uri = 5;

Returns
Type	Description
ByteString	The bytes for referenceWebUri.

getSourceCase()

public abstract Document.SourceCase getSourceCase()

Returns
Type	Description
Document.SourceCase

getType()

public abstract Document.Type getType()

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

.google.cloud.language.v1beta2.Document.Type type = 1;

Returns
Type	Description
Document.Type	The type.

getTypeValue()

public abstract int getTypeValue()

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

.google.cloud.language.v1beta2.Document.Type type = 1;

Returns
Type	Description
int	The enum numeric value on the wire for type.

hasContent()

public abstract boolean hasContent()

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

string content = 2;

Returns
Type	Description
boolean	Whether the content field is set.

hasGcsContentUri()

public abstract boolean hasGcsContentUri()

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.

string gcs_content_uri = 3;

Returns
Type	Description
boolean	Whether the gcsContentUri field is set.