Class ClassificationCategory (2.55.0)

public final class ClassificationCategory extends GeneratedMessageV3 implements ClassificationCategoryOrBuilder

Represents a category returned from the text classifier.

Protobuf type google.cloud.language.v2.ClassificationCategory

Static Fields

CONFIDENCE_FIELD_NUMBER

public static final int CONFIDENCE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SEVERITY_FIELD_NUMBER

public static final int SEVERITY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ClassificationCategory getDefaultInstance()
Returns
Type Description
ClassificationCategory

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ClassificationCategory.Builder newBuilder()
Returns
Type Description
ClassificationCategory.Builder

newBuilder(ClassificationCategory prototype)

public static ClassificationCategory.Builder newBuilder(ClassificationCategory prototype)
Parameter
Name Description
prototype ClassificationCategory
Returns
Type Description
ClassificationCategory.Builder

parseDelimitedFrom(InputStream input)

public static ClassificationCategory parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ClassificationCategory
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ClassificationCategory parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ClassificationCategory
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ClassificationCategory parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ClassificationCategory
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ClassificationCategory parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ClassificationCategory
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ClassificationCategory parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ClassificationCategory
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ClassificationCategory parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ClassificationCategory
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ClassificationCategory parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ClassificationCategory
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ClassificationCategory parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ClassificationCategory
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ClassificationCategory parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ClassificationCategory
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ClassificationCategory parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ClassificationCategory
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ClassificationCategory parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ClassificationCategory
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ClassificationCategory parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ClassificationCategory
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ClassificationCategory> parser()
Returns
Type Description
Parser<ClassificationCategory>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getConfidence()

public float getConfidence()

The classifier's confidence of the category. Number represents how certain the classifier is that this category represents the given text.

float confidence = 2;

Returns
Type Description
float

The confidence.

getDefaultInstanceForType()

public ClassificationCategory getDefaultInstanceForType()
Returns
Type Description
ClassificationCategory

getName()

public String getName()

The name of the category representing the document.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of the category representing the document.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<ClassificationCategory> getParserForType()
Returns
Type Description
Parser<ClassificationCategory>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSeverity()

public float getSeverity()

Optional. The classifier's severity of the category. This is only present when the ModerateTextRequest.ModelVersion is set to MODEL_VERSION_2, and the corresponding category has a severity score.

float severity = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
float

The severity.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ClassificationCategory.Builder newBuilderForType()
Returns
Type Description
ClassificationCategory.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ClassificationCategory.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ClassificationCategory.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ClassificationCategory.Builder toBuilder()
Returns
Type Description
ClassificationCategory.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException