Package com.google.cloud.language.v1beta2

Class AnnotateTextRequest.Features

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.language.v1beta2.AnnotateTextRequest.Features

All Implemented Interfaces:

AnnotateTextRequest.FeaturesOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

AnnotateTextRequest

public static final class AnnotateTextRequest.Features
extends com.google.protobuf.GeneratedMessageV3
implements AnnotateTextRequest.FeaturesOrBuilder

 All available features for sentiment, syntax, and semantic analysis.
 Setting each one to true will enable that specific analysis for the input.
 Next ID: 12
 

Protobuf type google.cloud.language.v1beta2.AnnotateTextRequest.Features

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AnnotateTextRequest.Features.Builder	All available features for sentiment, syntax, and semantic analysis.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static int	CLASSIFICATION_MODEL_OPTIONS_FIELD_NUMBER
static int	CLASSIFY_TEXT_FIELD_NUMBER
static int	EXTRACT_DOCUMENT_SENTIMENT_FIELD_NUMBER
static int	EXTRACT_ENTITIES_FIELD_NUMBER
static int	EXTRACT_ENTITY_SENTIMENT_FIELD_NUMBER
static int	EXTRACT_SYNTAX_FIELD_NUMBER
static int	MODERATE_TEXT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
ClassificationModelOptions	getClassificationModelOptions()	The model options to use for classification.
ClassificationModelOptionsOrBuilder	getClassificationModelOptionsOrBuilder()	The model options to use for classification.
boolean	getClassifyText()	Classify the full document into categories.
static AnnotateTextRequest.Features	getDefaultInstance()
AnnotateTextRequest.Features	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getExtractDocumentSentiment()	Extract document-level sentiment.
boolean	getExtractEntities()	Extract entities.
boolean	getExtractEntitySentiment()	Extract entities and their associated sentiment.
boolean	getExtractSyntax()	Extract syntax information.
boolean	getModerateText()	Moderate the document for harmful and sensitive categories.
com.google.protobuf.Parser<AnnotateTextRequest.Features>	getParserForType()
int	getSerializedSize()
boolean	hasClassificationModelOptions()	The model options to use for classification.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static AnnotateTextRequest.Features.Builder	newBuilder()
static AnnotateTextRequest.Features.Builder	newBuilder(AnnotateTextRequest.Features prototype)
AnnotateTextRequest.Features.Builder	newBuilderForType()
protected AnnotateTextRequest.Features.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static AnnotateTextRequest.Features	parseDelimitedFrom(InputStream input)
static AnnotateTextRequest.Features	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnnotateTextRequest.Features	parseFrom(byte[] data)
static AnnotateTextRequest.Features	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnnotateTextRequest.Features	parseFrom(com.google.protobuf.ByteString data)
static AnnotateTextRequest.Features	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnnotateTextRequest.Features	parseFrom(com.google.protobuf.CodedInputStream input)
static AnnotateTextRequest.Features	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnnotateTextRequest.Features	parseFrom(InputStream input)
static AnnotateTextRequest.Features	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AnnotateTextRequest.Features	parseFrom(ByteBuffer data)
static AnnotateTextRequest.Features	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<AnnotateTextRequest.Features>	parser()
AnnotateTextRequest.Features.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Detail

EXTRACT_SYNTAX_FIELD_NUMBER

public static final int EXTRACT_SYNTAX_FIELD_NUMBER

See Also:

Constant Field Values

EXTRACT_ENTITIES_FIELD_NUMBER

public static final int EXTRACT_ENTITIES_FIELD_NUMBER

See Also:

Constant Field Values

EXTRACT_DOCUMENT_SENTIMENT_FIELD_NUMBER

public static final int EXTRACT_DOCUMENT_SENTIMENT_FIELD_NUMBER

See Also:

Constant Field Values

EXTRACT_ENTITY_SENTIMENT_FIELD_NUMBER

public static final int EXTRACT_ENTITY_SENTIMENT_FIELD_NUMBER

See Also:

Constant Field Values

CLASSIFY_TEXT_FIELD_NUMBER

public static final int CLASSIFY_TEXT_FIELD_NUMBER

See Also:

Constant Field Values

MODERATE_TEXT_FIELD_NUMBER

public static final int MODERATE_TEXT_FIELD_NUMBER

See Also:

Constant Field Values

CLASSIFICATION_MODEL_OPTIONS_FIELD_NUMBER

public static final int CLASSIFICATION_MODEL_OPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getExtractSyntax

public boolean getExtractSyntax()

 Extract syntax information.
 

bool extract_syntax = 1;

Specified by:

getExtractSyntax in interface AnnotateTextRequest.FeaturesOrBuilder

Returns:

The extractSyntax.

getExtractEntities

public boolean getExtractEntities()

 Extract entities.
 

bool extract_entities = 2;

Specified by:

getExtractEntities in interface AnnotateTextRequest.FeaturesOrBuilder

Returns:

The extractEntities.

getExtractDocumentSentiment

public boolean getExtractDocumentSentiment()

 Extract document-level sentiment.
 

bool extract_document_sentiment = 3;

Specified by:

getExtractDocumentSentiment in interface AnnotateTextRequest.FeaturesOrBuilder

Returns:

The extractDocumentSentiment.

getExtractEntitySentiment

public boolean getExtractEntitySentiment()

 Extract entities and their associated sentiment.
 

bool extract_entity_sentiment = 4;

Specified by:

getExtractEntitySentiment in interface AnnotateTextRequest.FeaturesOrBuilder

Returns:

The extractEntitySentiment.

getClassifyText

public boolean getClassifyText()

 Classify the full document into categories. If this is true,
 the API will use the default model which classifies into a
 [predefined
 taxonomy](https://cloud.google.com/natural-language/docs/categories).
 

bool classify_text = 6;

Specified by:

getClassifyText in interface AnnotateTextRequest.FeaturesOrBuilder

Returns:

The classifyText.

getModerateText

public boolean getModerateText()

 Moderate the document for harmful and sensitive categories.
 

bool moderate_text = 11;

Specified by:

getModerateText in interface AnnotateTextRequest.FeaturesOrBuilder

Returns:

The moderateText.

hasClassificationModelOptions

public boolean hasClassificationModelOptions()

 The model options to use for classification. Defaults to v1 options
 if not specified. Only used if `classify_text` is set to true.
 

.google.cloud.language.v1beta2.ClassificationModelOptions classification_model_options = 10;

Specified by:

hasClassificationModelOptions in interface AnnotateTextRequest.FeaturesOrBuilder

Returns:

Whether the classificationModelOptions field is set.

getClassificationModelOptions

public ClassificationModelOptions getClassificationModelOptions()

 The model options to use for classification. Defaults to v1 options
 if not specified. Only used if `classify_text` is set to true.
 

.google.cloud.language.v1beta2.ClassificationModelOptions classification_model_options = 10;

Specified by:

getClassificationModelOptions in interface AnnotateTextRequest.FeaturesOrBuilder

Returns:

The classificationModelOptions.

getClassificationModelOptionsOrBuilder

public ClassificationModelOptionsOrBuilder getClassificationModelOptionsOrBuilder()

 The model options to use for classification. Defaults to v1 options
 if not specified. Only used if `classify_text` is set to true.
 

.google.cloud.language.v1beta2.ClassificationModelOptions classification_model_options = 10;

Specified by:

getClassificationModelOptionsOrBuilder in interface AnnotateTextRequest.FeaturesOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static AnnotateTextRequest.Features parseFrom(ByteBuffer data)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnnotateTextRequest.Features parseFrom(ByteBuffer data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnnotateTextRequest.Features parseFrom(com.google.protobuf.ByteString data)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnnotateTextRequest.Features parseFrom(com.google.protobuf.ByteString data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnnotateTextRequest.Features parseFrom(byte[] data)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnnotateTextRequest.Features parseFrom(byte[] data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AnnotateTextRequest.Features parseFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseFrom

public static AnnotateTextRequest.Features parseFrom(InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static AnnotateTextRequest.Features parseDelimitedFrom(InputStream input)
                                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static AnnotateTextRequest.Features parseDelimitedFrom(InputStream input,
                                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws IOException

Throws:

IOException

parseFrom

public static AnnotateTextRequest.Features parseFrom(com.google.protobuf.CodedInputStream input)
                                              throws IOException

Throws:

IOException

parseFrom

public static AnnotateTextRequest.Features parseFrom(com.google.protobuf.CodedInputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

newBuilderForType

public AnnotateTextRequest.Features.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static AnnotateTextRequest.Features.Builder newBuilder()

newBuilder

public static AnnotateTextRequest.Features.Builder newBuilder(AnnotateTextRequest.Features prototype)

toBuilder

public AnnotateTextRequest.Features.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected AnnotateTextRequest.Features.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static AnnotateTextRequest.Features getDefaultInstance()

parser

public static com.google.protobuf.Parser<AnnotateTextRequest.Features> parser()

getParserForType

public com.google.protobuf.Parser<AnnotateTextRequest.Features> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public AnnotateTextRequest.Features getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder