Class SafetyRating.Builder (1.0.0)

public static final class SafetyRating.Builder extends GeneratedMessageV3.Builder<SafetyRating.Builder> implements SafetyRatingOrBuilder

Safety rating corresponding to the generated content.

Protobuf type google.cloud.vertexai.v1.SafetyRating

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SafetyRating.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SafetyRating.Builder
Overrides

build()

public SafetyRating build()
Returns
Type Description
SafetyRating

buildPartial()

public SafetyRating buildPartial()
Returns
Type Description
SafetyRating

clear()

public SafetyRating.Builder clear()
Returns
Type Description
SafetyRating.Builder
Overrides

clearBlocked()

public SafetyRating.Builder clearBlocked()

Output only. Indicates whether the content was filtered out because of this rating.

bool blocked = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SafetyRating.Builder

This builder for chaining.

clearCategory()

public SafetyRating.Builder clearCategory()

Output only. Harm category.

.google.cloud.vertexai.v1.HarmCategory category = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SafetyRating.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SafetyRating.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SafetyRating.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SafetyRating.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SafetyRating.Builder
Overrides

clearProbability()

public SafetyRating.Builder clearProbability()

Output only. Harm probability levels in the content.

.google.cloud.vertexai.v1.SafetyRating.HarmProbability probability = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SafetyRating.Builder

This builder for chaining.

clearProbabilityScore()

public SafetyRating.Builder clearProbabilityScore()

Output only. Harm probability score.

float probability_score = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SafetyRating.Builder

This builder for chaining.

clearSeverity()

public SafetyRating.Builder clearSeverity()

Output only. Harm severity levels in the content.

.google.cloud.vertexai.v1.SafetyRating.HarmSeverity severity = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SafetyRating.Builder

This builder for chaining.

clearSeverityScore()

public SafetyRating.Builder clearSeverityScore()

Output only. Harm severity score.

float severity_score = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SafetyRating.Builder

This builder for chaining.

clone()

public SafetyRating.Builder clone()
Returns
Type Description
SafetyRating.Builder
Overrides

getBlocked()

public boolean getBlocked()

Output only. Indicates whether the content was filtered out because of this rating.

bool blocked = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The blocked.

getCategory()

public HarmCategory getCategory()

Output only. Harm category.

.google.cloud.vertexai.v1.HarmCategory category = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
HarmCategory

The category.

getCategoryValue()

public int getCategoryValue()

Output only. Harm category.

.google.cloud.vertexai.v1.HarmCategory category = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for category.

getDefaultInstanceForType()

public SafetyRating getDefaultInstanceForType()
Returns
Type Description
SafetyRating

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getProbability()

public SafetyRating.HarmProbability getProbability()

Output only. Harm probability levels in the content.

.google.cloud.vertexai.v1.SafetyRating.HarmProbability probability = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SafetyRating.HarmProbability

The probability.

getProbabilityScore()

public float getProbabilityScore()

Output only. Harm probability score.

float probability_score = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
float

The probabilityScore.

getProbabilityValue()

public int getProbabilityValue()

Output only. Harm probability levels in the content.

.google.cloud.vertexai.v1.SafetyRating.HarmProbability probability = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for probability.

getSeverity()

public SafetyRating.HarmSeverity getSeverity()

Output only. Harm severity levels in the content.

.google.cloud.vertexai.v1.SafetyRating.HarmSeverity severity = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SafetyRating.HarmSeverity

The severity.

getSeverityScore()

public float getSeverityScore()

Output only. Harm severity score.

float severity_score = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
float

The severityScore.

getSeverityValue()

public int getSeverityValue()

Output only. Harm severity levels in the content.

.google.cloud.vertexai.v1.SafetyRating.HarmSeverity severity = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for severity.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SafetyRating other)

public SafetyRating.Builder mergeFrom(SafetyRating other)
Parameter
Name Description
other SafetyRating
Returns
Type Description
SafetyRating.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SafetyRating.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SafetyRating.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SafetyRating.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SafetyRating.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SafetyRating.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SafetyRating.Builder
Overrides

setBlocked(boolean value)

public SafetyRating.Builder setBlocked(boolean value)

Output only. Indicates whether the content was filtered out because of this rating.

bool blocked = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The blocked to set.

Returns
Type Description
SafetyRating.Builder

This builder for chaining.

setCategory(HarmCategory value)

public SafetyRating.Builder setCategory(HarmCategory value)

Output only. Harm category.

.google.cloud.vertexai.v1.HarmCategory category = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value HarmCategory

The category to set.

Returns
Type Description
SafetyRating.Builder

This builder for chaining.

setCategoryValue(int value)

public SafetyRating.Builder setCategoryValue(int value)

Output only. Harm category.

.google.cloud.vertexai.v1.HarmCategory category = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for category to set.

Returns
Type Description
SafetyRating.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SafetyRating.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SafetyRating.Builder
Overrides

setProbability(SafetyRating.HarmProbability value)

public SafetyRating.Builder setProbability(SafetyRating.HarmProbability value)

Output only. Harm probability levels in the content.

.google.cloud.vertexai.v1.SafetyRating.HarmProbability probability = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value SafetyRating.HarmProbability

The probability to set.

Returns
Type Description
SafetyRating.Builder

This builder for chaining.

setProbabilityScore(float value)

public SafetyRating.Builder setProbabilityScore(float value)

Output only. Harm probability score.

float probability_score = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value float

The probabilityScore to set.

Returns
Type Description
SafetyRating.Builder

This builder for chaining.

setProbabilityValue(int value)

public SafetyRating.Builder setProbabilityValue(int value)

Output only. Harm probability levels in the content.

.google.cloud.vertexai.v1.SafetyRating.HarmProbability probability = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for probability to set.

Returns
Type Description
SafetyRating.Builder

This builder for chaining.

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

public SafetyRating.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SafetyRating.Builder
Overrides

setSeverity(SafetyRating.HarmSeverity value)

public SafetyRating.Builder setSeverity(SafetyRating.HarmSeverity value)

Output only. Harm severity levels in the content.

.google.cloud.vertexai.v1.SafetyRating.HarmSeverity severity = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value SafetyRating.HarmSeverity

The severity to set.

Returns
Type Description
SafetyRating.Builder

This builder for chaining.

setSeverityScore(float value)

public SafetyRating.Builder setSeverityScore(float value)

Output only. Harm severity score.

float severity_score = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value float

The severityScore to set.

Returns
Type Description
SafetyRating.Builder

This builder for chaining.

setSeverityValue(int value)

public SafetyRating.Builder setSeverityValue(int value)

Output only. Harm severity levels in the content.

.google.cloud.vertexai.v1.SafetyRating.HarmSeverity severity = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for severity to set.

Returns
Type Description
SafetyRating.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SafetyRating.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SafetyRating.Builder
Overrides