Class SearchResponse.Summary.SafetyAttributes (0.20.0)

public static final class SearchResponse.Summary.SafetyAttributes extends GeneratedMessageV3 implements SearchResponse.Summary.SafetyAttributesOrBuilder

Safety Attribute categories and their associated confidence scores.

Protobuf type google.cloud.discoveryengine.v1.SearchResponse.Summary.SafetyAttributes

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchResponse.Summary.SafetyAttributes

Static Fields

CATEGORIES_FIELD_NUMBER

public static final int CATEGORIES_FIELD_NUMBER
Field Value
TypeDescription
int

SCORES_FIELD_NUMBER

public static final int SCORES_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SearchResponse.Summary.SafetyAttributes getDefaultInstance()
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SearchResponse.Summary.SafetyAttributes.Builder newBuilder()
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder

newBuilder(SearchResponse.Summary.SafetyAttributes prototype)

public static SearchResponse.Summary.SafetyAttributes.Builder newBuilder(SearchResponse.Summary.SafetyAttributes prototype)
Parameter
NameDescription
prototypeSearchResponse.Summary.SafetyAttributes
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder

parseDelimitedFrom(InputStream input)

public static SearchResponse.Summary.SafetyAttributes parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary.SafetyAttributes parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SearchResponse.Summary.SafetyAttributes parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary.SafetyAttributes parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchResponse.Summary.SafetyAttributes parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary.SafetyAttributes parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchResponse.Summary.SafetyAttributes parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary.SafetyAttributes parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SearchResponse.Summary.SafetyAttributes parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary.SafetyAttributes parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SearchResponse.Summary.SafetyAttributes parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary.SafetyAttributes parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SearchResponse.Summary.SafetyAttributes> parser()
Returns
TypeDescription
Parser<SafetyAttributes>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCategories(int index)

public String getCategories(int index)

The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.

repeated string categories = 1;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The categories at the given index.

getCategoriesBytes(int index)

public ByteString getCategoriesBytes(int index)

The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.

repeated string categories = 1;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the categories at the given index.

getCategoriesCount()

public int getCategoriesCount()

The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.

repeated string categories = 1;

Returns
TypeDescription
int

The count of categories.

getCategoriesList()

public ProtocolStringList getCategoriesList()

The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.

repeated string categories = 1;

Returns
TypeDescription
ProtocolStringList

A list containing the categories.

getDefaultInstanceForType()

public SearchResponse.Summary.SafetyAttributes getDefaultInstanceForType()
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes

getParserForType()

public Parser<SearchResponse.Summary.SafetyAttributes> getParserForType()
Returns
TypeDescription
Parser<SafetyAttributes>
Overrides

getScores(int index)

public float getScores(int index)

The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.

repeated float scores = 2;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
float

The scores at the given index.

getScoresCount()

public int getScoresCount()

The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.

repeated float scores = 2;

Returns
TypeDescription
int

The count of scores.

getScoresList()

public List<Float> getScoresList()

The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.

repeated float scores = 2;

Returns
TypeDescription
List<Float>

A list containing the scores.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SearchResponse.Summary.SafetyAttributes.Builder newBuilderForType()
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchResponse.Summary.SafetyAttributes.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SearchResponse.Summary.SafetyAttributes.Builder toBuilder()
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException