com.google.cloud.vertexai.api

Enum SafetySetting.HarmBlockThreshold

java.lang.Object

java.lang.Enum<SafetySetting.HarmBlockThreshold>

com.google.cloud.vertexai.api.SafetySetting.HarmBlockThreshold

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<SafetySetting.HarmBlockThreshold>

Enclosing class:

SafetySetting

public static enum SafetySetting.HarmBlockThreshold
extends Enum<SafetySetting.HarmBlockThreshold>
implements com.google.protobuf.ProtocolMessageEnum

 Probability based thresholds levels for blocking.
 

Protobuf enum google.cloud.vertexai.v1.SafetySetting.HarmBlockThreshold

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLOCK_LOW_AND_ABOVE Block low threshold and above (i.e. block more).
BLOCK_MEDIUM_AND_ABOVE Block medium threshold and above.
BLOCK_NONE Block none.
BLOCK_ONLY_HIGH Block only high threshold (i.e. block less).
HARM_BLOCK_THRESHOLD_UNSPECIFIED Unspecified harm block threshold.
OFF Turn off the safety filter.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	BLOCK_LOW_AND_ABOVE_VALUE Block low threshold and above (i.e. block more).
static int	BLOCK_MEDIUM_AND_ABOVE_VALUE Block medium threshold and above.
static int	BLOCK_NONE_VALUE Block none.
static int	BLOCK_ONLY_HIGH_VALUE Block only high threshold (i.e. block less).
static int	HARM_BLOCK_THRESHOLD_UNSPECIFIED_VALUE Unspecified harm block threshold.
static int	OFF_VALUE Turn off the safety filter.

Method Summary

Modifier and Type	Method and Description
static SafetySetting.HarmBlockThreshold	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<SafetySetting.HarmBlockThreshold>	internalGetValueMap()
static SafetySetting.HarmBlockThreshold	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static SafetySetting.HarmBlockThreshold	valueOf(int value) Deprecated. Use forNumber(int) instead.
static SafetySetting.HarmBlockThreshold	valueOf(String name) Returns the enum constant of this type with the specified name.
static SafetySetting.HarmBlockThreshold[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HARM_BLOCK_THRESHOLD_UNSPECIFIED

public static final SafetySetting.HarmBlockThreshold HARM_BLOCK_THRESHOLD_UNSPECIFIED

 Unspecified harm block threshold.
 

HARM_BLOCK_THRESHOLD_UNSPECIFIED = 0;

BLOCK_LOW_AND_ABOVE

public static final SafetySetting.HarmBlockThreshold BLOCK_LOW_AND_ABOVE

 Block low threshold and above (i.e. block more).
 

BLOCK_LOW_AND_ABOVE = 1;

BLOCK_MEDIUM_AND_ABOVE

public static final SafetySetting.HarmBlockThreshold BLOCK_MEDIUM_AND_ABOVE

 Block medium threshold and above.
 

BLOCK_MEDIUM_AND_ABOVE = 2;

BLOCK_ONLY_HIGH

public static final SafetySetting.HarmBlockThreshold BLOCK_ONLY_HIGH

 Block only high threshold (i.e. block less).
 

BLOCK_ONLY_HIGH = 3;

BLOCK_NONE

public static final SafetySetting.HarmBlockThreshold BLOCK_NONE

 Block none.
 

BLOCK_NONE = 4;

OFF

public static final SafetySetting.HarmBlockThreshold OFF

 Turn off the safety filter.
 

OFF = 5;

UNRECOGNIZED

public static final SafetySetting.HarmBlockThreshold UNRECOGNIZED

Field Detail

HARM_BLOCK_THRESHOLD_UNSPECIFIED_VALUE

public static final int HARM_BLOCK_THRESHOLD_UNSPECIFIED_VALUE

 Unspecified harm block threshold.
 

HARM_BLOCK_THRESHOLD_UNSPECIFIED = 0;

See Also:

Constant Field Values

BLOCK_LOW_AND_ABOVE_VALUE

public static final int BLOCK_LOW_AND_ABOVE_VALUE

 Block low threshold and above (i.e. block more).
 

BLOCK_LOW_AND_ABOVE = 1;

See Also:

Constant Field Values

BLOCK_MEDIUM_AND_ABOVE_VALUE

public static final int BLOCK_MEDIUM_AND_ABOVE_VALUE

 Block medium threshold and above.
 

BLOCK_MEDIUM_AND_ABOVE = 2;

See Also:

Constant Field Values

BLOCK_ONLY_HIGH_VALUE

public static final int BLOCK_ONLY_HIGH_VALUE

 Block only high threshold (i.e. block less).
 

BLOCK_ONLY_HIGH = 3;

See Also:

Constant Field Values

BLOCK_NONE_VALUE

public static final int BLOCK_NONE_VALUE

 Block none.
 

BLOCK_NONE = 4;

See Also:

Constant Field Values

OFF_VALUE

public static final int OFF_VALUE

 Turn off the safety filter.
 

OFF = 5;

See Also:

Constant Field Values

Method Detail

values

public static SafetySetting.HarmBlockThreshold[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SafetySetting.HarmBlockThreshold c : SafetySetting.HarmBlockThreshold.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SafetySetting.HarmBlockThreshold valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

@Deprecated
public static SafetySetting.HarmBlockThreshold valueOf(int value)

Deprecated. Use forNumber(int) instead.

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

forNumber

public static SafetySetting.HarmBlockThreshold forNumber(int value)

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<SafetySetting.HarmBlockThreshold> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

public static SafetySetting.HarmBlockThreshold valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)