Class SafetySetting (3.49.0)

public final class SafetySetting extends GeneratedMessageV3 implements SafetySettingOrBuilder

Safety settings.

Protobuf type google.cloud.aiplatform.v1beta1.SafetySetting

Static Fields

CATEGORY_FIELD_NUMBER

public static final int CATEGORY_FIELD_NUMBER
Field Value
Type Description
int

METHOD_FIELD_NUMBER

public static final int METHOD_FIELD_NUMBER
Field Value
Type Description
int

THRESHOLD_FIELD_NUMBER

public static final int THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SafetySetting getDefaultInstance()
Returns
Type Description
SafetySetting

getDescriptor()

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

newBuilder()

public static SafetySetting.Builder newBuilder()
Returns
Type Description
SafetySetting.Builder

newBuilder(SafetySetting prototype)

public static SafetySetting.Builder newBuilder(SafetySetting prototype)
Parameter
Name Description
prototype SafetySetting
Returns
Type Description
SafetySetting.Builder

parseDelimitedFrom(InputStream input)

public static SafetySetting parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SafetySetting
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SafetySetting parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SafetySetting
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SafetySetting parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SafetySetting
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SafetySetting parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SafetySetting
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SafetySetting parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SafetySetting
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SafetySetting parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SafetySetting
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SafetySetting parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SafetySetting
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SafetySetting parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SafetySetting
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SafetySetting parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SafetySetting
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SafetySetting parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SafetySetting
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SafetySetting parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SafetySetting
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SafetySetting parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SafetySetting
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SafetySetting> parser()
Returns
Type Description
Parser<SafetySetting>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCategory()

public HarmCategory getCategory()

Required. Harm category.

.google.cloud.aiplatform.v1beta1.HarmCategory category = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
HarmCategory

The category.

getCategoryValue()

public int getCategoryValue()

Required. Harm category.

.google.cloud.aiplatform.v1beta1.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

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.aiplatform.v1beta1.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.aiplatform.v1beta1.SafetySetting.HarmBlockMethod method = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for method.

getParserForType()

public Parser<SafetySetting> getParserForType()
Returns
Type Description
Parser<SafetySetting>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getThreshold()

public SafetySetting.HarmBlockThreshold getThreshold()

Required. The harm block threshold.

.google.cloud.aiplatform.v1beta1.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.aiplatform.v1beta1.SafetySetting.HarmBlockThreshold threshold = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for threshold.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SafetySetting.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SafetySetting.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public SafetySetting.Builder toBuilder()
Returns
Type Description
SafetySetting.Builder

writeTo(CodedOutputStream output)

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