Class SearchResponse.Summary.SafetyAttributes.Builder (0.31.0)

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

Safety Attribute categories and their associated confidence scores.

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

Static Methods

getDescriptor()

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

Methods

addAllCategories(Iterable<String> values)

public SearchResponse.Summary.SafetyAttributes.Builder addAllCategories(Iterable<String> values)

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

repeated string categories = 1;

Parameter
NameDescription
valuesIterable<String>

The categories to add.

Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder

This builder for chaining.

addAllScores(Iterable<? extends Float> values)

public SearchResponse.Summary.SafetyAttributes.Builder addAllScores(Iterable<? extends Float> values)

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

repeated float scores = 2;

Parameter
NameDescription
valuesIterable<? extends java.lang.Float>

The scores to add.

Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder

This builder for chaining.

addCategories(String value)

public SearchResponse.Summary.SafetyAttributes.Builder addCategories(String value)

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

repeated string categories = 1;

Parameter
NameDescription
valueString

The categories to add.

Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder

This builder for chaining.

addCategoriesBytes(ByteString value)

public SearchResponse.Summary.SafetyAttributes.Builder addCategoriesBytes(ByteString value)

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

repeated string categories = 1;

Parameter
NameDescription
valueByteString

The bytes of the categories to add.

Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchResponse.Summary.SafetyAttributes.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder
Overrides

addScores(float value)

public SearchResponse.Summary.SafetyAttributes.Builder addScores(float value)

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

repeated float scores = 2;

Parameter
NameDescription
valuefloat

The scores to add.

Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder

This builder for chaining.

build()

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

buildPartial()

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

clear()

public SearchResponse.Summary.SafetyAttributes.Builder clear()
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder
Overrides

clearCategories()

public SearchResponse.Summary.SafetyAttributes.Builder clearCategories()

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

repeated string categories = 1;

Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SearchResponse.Summary.SafetyAttributes.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchResponse.Summary.SafetyAttributes.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder
Overrides

clearScores()

public SearchResponse.Summary.SafetyAttributes.Builder clearScores()

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

repeated float scores = 2;

Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder

This builder for chaining.

clone()

public SearchResponse.Summary.SafetyAttributes.Builder clone()
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SearchResponse.Summary.SafetyAttributes other)

public SearchResponse.Summary.SafetyAttributes.Builder mergeFrom(SearchResponse.Summary.SafetyAttributes other)
Parameter
NameDescription
otherSearchResponse.Summary.SafetyAttributes
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public SearchResponse.Summary.SafetyAttributes.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchResponse.Summary.SafetyAttributes.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder
Overrides

setCategories(int index, String value)

public SearchResponse.Summary.SafetyAttributes.Builder setCategories(int index, String value)

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

repeated string categories = 1;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The categories to set.

Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SearchResponse.Summary.SafetyAttributes.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchResponse.Summary.SafetyAttributes.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder
Overrides

setScores(int index, float value)

public SearchResponse.Summary.SafetyAttributes.Builder setScores(int index, float value)

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

repeated float scores = 2;

Parameters
NameDescription
indexint

The index to set the value at.

valuefloat

The scores to set.

Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchResponse.Summary.SafetyAttributes.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchResponse.Summary.SafetyAttributes.Builder
Overrides