- 2.48.0 (latest)
- 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 static final class Document.Builder extends GeneratedMessageV3.Builder<Document.Builder> implements DocumentOrBuilder
Represents the input to API methods.
Protobuf type google.cloud.language.v1beta2.Document
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Document.BuilderImplements
DocumentOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Document.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
Document.Builder |
build()
public Document build()
Type | Description |
Document |
buildPartial()
public Document buildPartial()
Type | Description |
Document |
clear()
public Document.Builder clear()
Type | Description |
Document.Builder |
clearBoilerplateHandling()
public Document.Builder clearBoilerplateHandling()
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;
Type | Description |
Document.Builder | This builder for chaining. |
clearContent()
public Document.Builder clearContent()
The content of the input in string format. Cloud audit logging exempt since it is based on user data.
string content = 2;
Type | Description |
Document.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Document.Builder clearField(Descriptors.FieldDescriptor field)
Name | Description |
field | FieldDescriptor |
Type | Description |
Document.Builder |
clearGcsContentUri()
public Document.Builder clearGcsContentUri()
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;
Type | Description |
Document.Builder | This builder for chaining. |
clearLanguage()
public Document.Builder clearLanguage()
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;
Type | Description |
Document.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Document.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Name | Description |
oneof | OneofDescriptor |
Type | Description |
Document.Builder |
clearReferenceWebUri()
public Document.Builder clearReferenceWebUri()
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;
Type | Description |
Document.Builder | This builder for chaining. |
clearSource()
public Document.Builder clearSource()
Type | Description |
Document.Builder |
clearType()
public Document.Builder clearType()
Required. If the type is not set or is TYPE_UNSPECIFIED
,
returns an INVALID_ARGUMENT
error.
.google.cloud.language.v1beta2.Document.Type type = 1;
Type | Description |
Document.Builder | This builder for chaining. |
clone()
public Document.Builder clone()
Type | Description |
Document.Builder |
getBoilerplateHandling()
public 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;
Type | Description |
Document.BoilerplateHandling | The boilerplateHandling. |
getBoilerplateHandlingValue()
public 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;
Type | Description |
int | The enum numeric value on the wire for boilerplateHandling. |
getContent()
public String getContent()
The content of the input in string format. Cloud audit logging exempt since it is based on user data.
string content = 2;
Type | Description |
String | The content. |
getContentBytes()
public ByteString getContentBytes()
The content of the input in string format. Cloud audit logging exempt since it is based on user data.
string content = 2;
Type | Description |
ByteString | The bytes for content. |
getDefaultInstanceForType()
public Document getDefaultInstanceForType()
Type | Description |
Document |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Type | Description |
Descriptor |
getGcsContentUri()
public 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;
Type | Description |
String | The gcsContentUri. |
getGcsContentUriBytes()
public 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;
Type | Description |
ByteString | The bytes for gcsContentUri. |
getLanguage()
public 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;
Type | Description |
String | The language. |
getLanguageBytes()
public 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;
Type | Description |
ByteString | The bytes for language. |
getReferenceWebUri()
public 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;
Type | Description |
String | The referenceWebUri. |
getReferenceWebUriBytes()
public 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;
Type | Description |
ByteString | The bytes for referenceWebUri. |
getSourceCase()
public Document.SourceCase getSourceCase()
Type | Description |
Document.SourceCase |
getType()
public 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;
Type | Description |
Document.Type | The type. |
getTypeValue()
public 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;
Type | Description |
int | The enum numeric value on the wire for type. |
hasContent()
public boolean hasContent()
The content of the input in string format. Cloud audit logging exempt since it is based on user data.
string content = 2;
Type | Description |
boolean | Whether the content field is set. |
hasGcsContentUri()
public 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;
Type | Description |
boolean | Whether the gcsContentUri field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
mergeFrom(Document other)
public Document.Builder mergeFrom(Document other)
Name | Description |
other | Document |
Type | Description |
Document.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Document.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
Document.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public Document.Builder mergeFrom(Message other)
Name | Description |
other | Message |
Type | Description |
Document.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Document.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
Document.Builder |
setBoilerplateHandling(Document.BoilerplateHandling value)
public Document.Builder setBoilerplateHandling(Document.BoilerplateHandling value)
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;
Name | Description |
value | Document.BoilerplateHandling The boilerplateHandling to set. |
Type | Description |
Document.Builder | This builder for chaining. |
setBoilerplateHandlingValue(int value)
public Document.Builder setBoilerplateHandlingValue(int value)
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;
Name | Description |
value | int The enum numeric value on the wire for boilerplateHandling to set. |
Type | Description |
Document.Builder | This builder for chaining. |
setContent(String value)
public Document.Builder setContent(String value)
The content of the input in string format. Cloud audit logging exempt since it is based on user data.
string content = 2;
Name | Description |
value | String The content to set. |
Type | Description |
Document.Builder | This builder for chaining. |
setContentBytes(ByteString value)
public Document.Builder setContentBytes(ByteString value)
The content of the input in string format. Cloud audit logging exempt since it is based on user data.
string content = 2;
Name | Description |
value | ByteString The bytes for content to set. |
Type | Description |
Document.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Document.Builder setField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
Document.Builder |
setGcsContentUri(String value)
public Document.Builder setGcsContentUri(String value)
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;
Name | Description |
value | String The gcsContentUri to set. |
Type | Description |
Document.Builder | This builder for chaining. |
setGcsContentUriBytes(ByteString value)
public Document.Builder setGcsContentUriBytes(ByteString value)
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;
Name | Description |
value | ByteString The bytes for gcsContentUri to set. |
Type | Description |
Document.Builder | This builder for chaining. |
setLanguage(String value)
public Document.Builder setLanguage(String value)
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;
Name | Description |
value | String The language to set. |
Type | Description |
Document.Builder | This builder for chaining. |
setLanguageBytes(ByteString value)
public Document.Builder setLanguageBytes(ByteString value)
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;
Name | Description |
value | ByteString The bytes for language to set. |
Type | Description |
Document.Builder | This builder for chaining. |
setReferenceWebUri(String value)
public Document.Builder setReferenceWebUri(String value)
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;
Name | Description |
value | String The referenceWebUri to set. |
Type | Description |
Document.Builder | This builder for chaining. |
setReferenceWebUriBytes(ByteString value)
public Document.Builder setReferenceWebUriBytes(ByteString value)
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;
Name | Description |
value | ByteString The bytes for referenceWebUri to set. |
Type | Description |
Document.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Document.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Type | Description |
Document.Builder |
setType(Document.Type value)
public Document.Builder setType(Document.Type value)
Required. If the type is not set or is TYPE_UNSPECIFIED
,
returns an INVALID_ARGUMENT
error.
.google.cloud.language.v1beta2.Document.Type type = 1;
Name | Description |
value | Document.Type The type to set. |
Type | Description |
Document.Builder | This builder for chaining. |
setTypeValue(int value)
public Document.Builder setTypeValue(int value)
Required. If the type is not set or is TYPE_UNSPECIFIED
,
returns an INVALID_ARGUMENT
error.
.google.cloud.language.v1beta2.Document.Type type = 1;
Name | Description |
value | int The enum numeric value on the wire for type to set. |
Type | Description |
Document.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Document.Builder setUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
Document.Builder |