Class ModelMonitoringAlertConfig (3.45.0)

public final class ModelMonitoringAlertConfig extends GeneratedMessageV3 implements ModelMonitoringAlertConfigOrBuilder

The alert config for model monitoring.

Protobuf type google.cloud.aiplatform.v1.ModelMonitoringAlertConfig

Static Fields

EMAIL_ALERT_CONFIG_FIELD_NUMBER

public static final int EMAIL_ALERT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_LOGGING_FIELD_NUMBER

public static final int ENABLE_LOGGING_FIELD_NUMBER
Field Value
Type Description
int

NOTIFICATION_CHANNELS_FIELD_NUMBER

public static final int NOTIFICATION_CHANNELS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ModelMonitoringAlertConfig getDefaultInstance()
Returns
Type Description
ModelMonitoringAlertConfig

getDescriptor()

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

newBuilder()

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

newBuilder(ModelMonitoringAlertConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAlertCase()

public ModelMonitoringAlertConfig.AlertCase getAlertCase()
Returns
Type Description
ModelMonitoringAlertConfig.AlertCase

getDefaultInstanceForType()

public ModelMonitoringAlertConfig getDefaultInstanceForType()
Returns
Type Description
ModelMonitoringAlertConfig

getEmailAlertConfig()

public ModelMonitoringAlertConfig.EmailAlertConfig getEmailAlertConfig()

Email alert config.

.google.cloud.aiplatform.v1.ModelMonitoringAlertConfig.EmailAlertConfig email_alert_config = 1;

Returns
Type Description
ModelMonitoringAlertConfig.EmailAlertConfig

The emailAlertConfig.

getEmailAlertConfigOrBuilder()

public ModelMonitoringAlertConfig.EmailAlertConfigOrBuilder getEmailAlertConfigOrBuilder()

Email alert config.

.google.cloud.aiplatform.v1.ModelMonitoringAlertConfig.EmailAlertConfig email_alert_config = 1;

Returns
Type Description
ModelMonitoringAlertConfig.EmailAlertConfigOrBuilder

getEnableLogging()

public boolean getEnableLogging()

Dump the anomalies to Cloud Logging. The anomalies will be put to json payload encoded from proto [google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry][]. This can be further sinked to Pub/Sub or any other services supported by Cloud Logging.

bool enable_logging = 2;

Returns
Type Description
boolean

The enableLogging.

getNotificationChannels(int index)

public String getNotificationChannels(int index)

Resource names of the NotificationChannels to send alert. Must be of the format projects/<project_id_or_number>/notificationChannels/<channel_id>

repeated string notification_channels = 3 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The notificationChannels at the given index.

getNotificationChannelsBytes(int index)

public ByteString getNotificationChannelsBytes(int index)

Resource names of the NotificationChannels to send alert. Must be of the format projects/<project_id_or_number>/notificationChannels/<channel_id>

repeated string notification_channels = 3 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the notificationChannels at the given index.

getNotificationChannelsCount()

public int getNotificationChannelsCount()

Resource names of the NotificationChannels to send alert. Must be of the format projects/<project_id_or_number>/notificationChannels/<channel_id>

repeated string notification_channels = 3 [(.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of notificationChannels.

getNotificationChannelsList()

public ProtocolStringList getNotificationChannelsList()

Resource names of the NotificationChannels to send alert. Must be of the format projects/<project_id_or_number>/notificationChannels/<channel_id>

repeated string notification_channels = 3 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the notificationChannels.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasEmailAlertConfig()

public boolean hasEmailAlertConfig()

Email alert config.

.google.cloud.aiplatform.v1.ModelMonitoringAlertConfig.EmailAlertConfig email_alert_config = 1;

Returns
Type Description
boolean

Whether the emailAlertConfig field is set.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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