Class SearchResponse.Summary.SafetyAttributes (0.41.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.v1beta.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
Type Description
int

SCORES_FIELD_NUMBER

public static final int SCORES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchResponse.Summary.SafetyAttributes getDefaultInstance()
Returns
Type Description
SearchResponse.Summary.SafetyAttributes

getDescriptor()

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

newBuilder()

public static SearchResponse.Summary.SafetyAttributes.Builder newBuilder()
Returns
Type Description
SearchResponse.Summary.SafetyAttributes.Builder

newBuilder(SearchResponse.Summary.SafetyAttributes prototype)

public static SearchResponse.Summary.SafetyAttributes.Builder newBuilder(SearchResponse.Summary.SafetyAttributes prototype)
Parameter
Name Description
prototype SearchResponse.Summary.SafetyAttributes
Returns
Type Description
SearchResponse.Summary.SafetyAttributes.Builder

parseDelimitedFrom(InputStream input)

public static SearchResponse.Summary.SafetyAttributes parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchResponse.Summary.SafetyAttributes
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary.SafetyAttributes parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.Summary.SafetyAttributes
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchResponse.Summary.SafetyAttributes parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchResponse.Summary.SafetyAttributes
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary.SafetyAttributes parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.Summary.SafetyAttributes
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchResponse.Summary.SafetyAttributes parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchResponse.Summary.SafetyAttributes
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary.SafetyAttributes parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.Summary.SafetyAttributes
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchResponse.Summary.SafetyAttributes parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchResponse.Summary.SafetyAttributes
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary.SafetyAttributes parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.Summary.SafetyAttributes
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchResponse.Summary.SafetyAttributes parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchResponse.Summary.SafetyAttributes
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary.SafetyAttributes parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.Summary.SafetyAttributes
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchResponse.Summary.SafetyAttributes parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchResponse.Summary.SafetyAttributes
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchResponse.Summary.SafetyAttributes parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.Summary.SafetyAttributes
Exceptions
Type Description
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
ProtocolStringList

A list containing the categories.

getDefaultInstanceForType()

public SearchResponse.Summary.SafetyAttributes getDefaultInstanceForType()
Returns
Type Description
SearchResponse.Summary.SafetyAttributes

getParserForType()

public Parser<SearchResponse.Summary.SafetyAttributes> getParserForType()
Returns
Type Description
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Type Description
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
Type Description
List<Float>

A list containing the scores.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 SearchResponse.Summary.SafetyAttributes.Builder newBuilderForType()
Returns
Type Description
SearchResponse.Summary.SafetyAttributes.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchResponse.Summary.SafetyAttributes.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchResponse.Summary.SafetyAttributes.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public SearchResponse.Summary.SafetyAttributes.Builder toBuilder()
Returns
Type Description
SearchResponse.Summary.SafetyAttributes.Builder

writeTo(CodedOutputStream output)

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