public static final class SafetySetting.Builder extends GeneratedMessageV3.Builder<SafetySetting.Builder> implements SafetySettingOrBuilder
Safety settings.
Protobuf type google.cloud.vertexai.v1.SafetySetting
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SafetySetting.BuilderImplements
SafetySettingOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SafetySetting.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
SafetySetting.Builder |
build()
public SafetySetting build()
Returns | |
---|---|
Type | Description |
SafetySetting |
buildPartial()
public SafetySetting buildPartial()
Returns | |
---|---|
Type | Description |
SafetySetting |
clear()
public SafetySetting.Builder clear()
Returns | |
---|---|
Type | Description |
SafetySetting.Builder |
clearCategory()
public SafetySetting.Builder clearCategory()
Required. Harm category.
.google.cloud.vertexai.v1.HarmCategory category = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
SafetySetting.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public SafetySetting.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
SafetySetting.Builder |
clearMethod()
public SafetySetting.Builder clearMethod()
Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.
.google.cloud.vertexai.v1.SafetySetting.HarmBlockMethod method = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
SafetySetting.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public SafetySetting.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
SafetySetting.Builder |
clearThreshold()
public SafetySetting.Builder clearThreshold()
Required. The harm block threshold.
.google.cloud.vertexai.v1.SafetySetting.HarmBlockThreshold threshold = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
SafetySetting.Builder |
This builder for chaining. |
clone()
public SafetySetting.Builder clone()
Returns | |
---|---|
Type | Description |
SafetySetting.Builder |
getCategory()
public HarmCategory getCategory()
Required. Harm category.
.google.cloud.vertexai.v1.HarmCategory category = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
HarmCategory |
The category. |
getCategoryValue()
public int getCategoryValue()
Required. Harm category.
.google.cloud.vertexai.v1.HarmCategory category = 1 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for category. |
getDefaultInstanceForType()
public SafetySetting getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
SafetySetting |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getMethod()
public SafetySetting.HarmBlockMethod getMethod()
Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.
.google.cloud.vertexai.v1.SafetySetting.HarmBlockMethod method = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
SafetySetting.HarmBlockMethod |
The method. |
getMethodValue()
public int getMethodValue()
Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.
.google.cloud.vertexai.v1.SafetySetting.HarmBlockMethod method = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for method. |
getThreshold()
public SafetySetting.HarmBlockThreshold getThreshold()
Required. The harm block threshold.
.google.cloud.vertexai.v1.SafetySetting.HarmBlockThreshold threshold = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
SafetySetting.HarmBlockThreshold |
The threshold. |
getThresholdValue()
public int getThresholdValue()
Required. The harm block threshold.
.google.cloud.vertexai.v1.SafetySetting.HarmBlockThreshold threshold = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for threshold. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(SafetySetting other)
public SafetySetting.Builder mergeFrom(SafetySetting other)
Parameter | |
---|---|
Name | Description |
other |
SafetySetting |
Returns | |
---|---|
Type | Description |
SafetySetting.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SafetySetting.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
SafetySetting.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public SafetySetting.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
SafetySetting.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SafetySetting.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
SafetySetting.Builder |
setCategory(HarmCategory value)
public SafetySetting.Builder setCategory(HarmCategory value)
Required. Harm category.
.google.cloud.vertexai.v1.HarmCategory category = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
HarmCategory The category to set. |
Returns | |
---|---|
Type | Description |
SafetySetting.Builder |
This builder for chaining. |
setCategoryValue(int value)
public SafetySetting.Builder setCategoryValue(int value)
Required. Harm category.
.google.cloud.vertexai.v1.HarmCategory category = 1 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
int The enum numeric value on the wire for category to set. |
Returns | |
---|---|
Type | Description |
SafetySetting.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public SafetySetting.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
SafetySetting.Builder |
setMethod(SafetySetting.HarmBlockMethod value)
public SafetySetting.Builder setMethod(SafetySetting.HarmBlockMethod value)
Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.
.google.cloud.vertexai.v1.SafetySetting.HarmBlockMethod method = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
SafetySetting.HarmBlockMethod The method to set. |
Returns | |
---|---|
Type | Description |
SafetySetting.Builder |
This builder for chaining. |
setMethodValue(int value)
public SafetySetting.Builder setMethodValue(int value)
Optional. Specify if the threshold is used for probability or severity score. If not specified, the threshold is used for probability score.
.google.cloud.vertexai.v1.SafetySetting.HarmBlockMethod method = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
int The enum numeric value on the wire for method to set. |
Returns | |
---|---|
Type | Description |
SafetySetting.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SafetySetting.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
SafetySetting.Builder |
setThreshold(SafetySetting.HarmBlockThreshold value)
public SafetySetting.Builder setThreshold(SafetySetting.HarmBlockThreshold value)
Required. The harm block threshold.
.google.cloud.vertexai.v1.SafetySetting.HarmBlockThreshold threshold = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
SafetySetting.HarmBlockThreshold The threshold to set. |
Returns | |
---|---|
Type | Description |
SafetySetting.Builder |
This builder for chaining. |
setThresholdValue(int value)
public SafetySetting.Builder setThresholdValue(int value)
Required. The harm block threshold.
.google.cloud.vertexai.v1.SafetySetting.HarmBlockThreshold threshold = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
int The enum numeric value on the wire for threshold to set. |
Returns | |
---|---|
Type | Description |
SafetySetting.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final SafetySetting.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
SafetySetting.Builder |