com.google.cloud.language.v1beta2

Interface DocumentOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

Document, Document.Builder

public interface DocumentOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Document.BoilerplateHandling	getBoilerplateHandling() Indicates how detected boilerplate(e.g.
int	getBoilerplateHandlingValue() Indicates how detected boilerplate(e.g.
String	getContent() The content of the input in string format.
ByteString	getContentBytes() The content of the input in string format.
String	getGcsContentUri() The Google Cloud Storage URI where the file content is located.
ByteString	getGcsContentUriBytes() The Google Cloud Storage URI where the file content is located.
String	getLanguage() The language of the document (if not specified, the language is automatically detected).
ByteString	getLanguageBytes() The language of the document (if not specified, the language is automatically detected).
String	getReferenceWebUri() The web URI where the document comes from.
ByteString	getReferenceWebUriBytes() The web URI where the document comes from.
Document.SourceCase	getSourceCase()
Document.Type	getType() Required.
int	getTypeValue() Required.
boolean	hasContent() The content of the input in string format.
boolean	hasGcsContentUri() The Google Cloud Storage URI where the file content is located.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getTypeValue

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:

The enum numeric value on the wire for type.

getType

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:

The type.

hasContent

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:

Whether the content field is set.

getContent

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:

The content.

getContentBytes

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:

The bytes for content.

hasGcsContentUri

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:

Whether the gcsContentUri field is set.

getGcsContentUri

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:

The gcsContentUri.

getGcsContentUriBytes

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:

The bytes for gcsContentUri.

getLanguage

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](https://cloud.google.com/natural-language/docs/languages) 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:

The language.

getLanguageBytes

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](https://cloud.google.com/natural-language/docs/languages) 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:

The bytes for language.

getReferenceWebUri

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:

The referenceWebUri.

getReferenceWebUriBytes

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:

The bytes for referenceWebUri.

getBoilerplateHandlingValue

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:

The enum numeric value on the wire for boilerplateHandling.

getBoilerplateHandling

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:

The boilerplateHandling.

getSourceCase

Document.SourceCase getSourceCase()