Class AlertPolicy.AlertStrategy (3.56.0)

public static final class AlertPolicy.AlertStrategy extends GeneratedMessageV3 implements AlertPolicy.AlertStrategyOrBuilder

Control over how the notification channels in notification_channels are notified when this alert fires.

Protobuf type google.monitoring.v3.AlertPolicy.AlertStrategy

Static Fields

AUTO_CLOSE_FIELD_NUMBER

public static final int AUTO_CLOSE_FIELD_NUMBER
Field Value
Type Description
int

NOTIFICATION_CHANNEL_STRATEGY_FIELD_NUMBER

public static final int NOTIFICATION_CHANNEL_STRATEGY_FIELD_NUMBER
Field Value
Type Description
int

NOTIFICATION_PROMPTS_FIELD_NUMBER

public static final int NOTIFICATION_PROMPTS_FIELD_NUMBER
Field Value
Type Description
int

NOTIFICATION_RATE_LIMIT_FIELD_NUMBER

public static final int NOTIFICATION_RATE_LIMIT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AlertPolicy.AlertStrategy getDefaultInstance()
Returns
Type Description
AlertPolicy.AlertStrategy

getDescriptor()

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

newBuilder()

public static AlertPolicy.AlertStrategy.Builder newBuilder()
Returns
Type Description
AlertPolicy.AlertStrategy.Builder

newBuilder(AlertPolicy.AlertStrategy prototype)

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

parseDelimitedFrom(InputStream input)

public static AlertPolicy.AlertStrategy parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AlertPolicy.AlertStrategy
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static AlertPolicy.AlertStrategy parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AlertPolicy.AlertStrategy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static AlertPolicy.AlertStrategy parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AlertPolicy.AlertStrategy
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static AlertPolicy.AlertStrategy parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AlertPolicy.AlertStrategy
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static AlertPolicy.AlertStrategy parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AlertPolicy.AlertStrategy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<AlertPolicy.AlertStrategy> parser()
Returns
Type Description
Parser<AlertStrategy>

Methods

equals(Object obj)

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

getAutoClose()

public Duration getAutoClose()

If an alerting policy that was active has no data for this long, any open incidents will close

.google.protobuf.Duration auto_close = 3;

Returns
Type Description
Duration

The autoClose.

getAutoCloseOrBuilder()

public DurationOrBuilder getAutoCloseOrBuilder()

If an alerting policy that was active has no data for this long, any open incidents will close

.google.protobuf.Duration auto_close = 3;

Returns
Type Description
DurationOrBuilder

getDefaultInstanceForType()

public AlertPolicy.AlertStrategy getDefaultInstanceForType()
Returns
Type Description
AlertPolicy.AlertStrategy

getNotificationChannelStrategy(int index)

public AlertPolicy.AlertStrategy.NotificationChannelStrategy getNotificationChannelStrategy(int index)

Control how notifications will be sent out, on a per-channel basis.

repeated .google.monitoring.v3.AlertPolicy.AlertStrategy.NotificationChannelStrategy notification_channel_strategy = 4;

Parameter
Name Description
index int
Returns
Type Description
AlertPolicy.AlertStrategy.NotificationChannelStrategy

getNotificationChannelStrategyCount()

public int getNotificationChannelStrategyCount()

Control how notifications will be sent out, on a per-channel basis.

repeated .google.monitoring.v3.AlertPolicy.AlertStrategy.NotificationChannelStrategy notification_channel_strategy = 4;

Returns
Type Description
int

getNotificationChannelStrategyList()

public List<AlertPolicy.AlertStrategy.NotificationChannelStrategy> getNotificationChannelStrategyList()

Control how notifications will be sent out, on a per-channel basis.

repeated .google.monitoring.v3.AlertPolicy.AlertStrategy.NotificationChannelStrategy notification_channel_strategy = 4;

Returns
Type Description
List<NotificationChannelStrategy>

getNotificationChannelStrategyOrBuilder(int index)

public AlertPolicy.AlertStrategy.NotificationChannelStrategyOrBuilder getNotificationChannelStrategyOrBuilder(int index)

Control how notifications will be sent out, on a per-channel basis.

repeated .google.monitoring.v3.AlertPolicy.AlertStrategy.NotificationChannelStrategy notification_channel_strategy = 4;

Parameter
Name Description
index int
Returns
Type Description
AlertPolicy.AlertStrategy.NotificationChannelStrategyOrBuilder

getNotificationChannelStrategyOrBuilderList()

public List<? extends AlertPolicy.AlertStrategy.NotificationChannelStrategyOrBuilder> getNotificationChannelStrategyOrBuilderList()

Control how notifications will be sent out, on a per-channel basis.

repeated .google.monitoring.v3.AlertPolicy.AlertStrategy.NotificationChannelStrategy notification_channel_strategy = 4;

Returns
Type Description
List<? extends com.google.monitoring.v3.AlertPolicy.AlertStrategy.NotificationChannelStrategyOrBuilder>

getNotificationPrompts(int index)

public AlertPolicy.AlertStrategy.NotificationPrompt getNotificationPrompts(int index)

For log-based alert policies, the notification prompts is always [OPENED]. For non log-based alert policies, the notification prompts can be [OPENED] or [OPENED, CLOSED].

repeated .google.monitoring.v3.AlertPolicy.AlertStrategy.NotificationPrompt notification_prompts = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
AlertPolicy.AlertStrategy.NotificationPrompt

The notificationPrompts at the given index.

getNotificationPromptsCount()

public int getNotificationPromptsCount()

For log-based alert policies, the notification prompts is always [OPENED]. For non log-based alert policies, the notification prompts can be [OPENED] or [OPENED, CLOSED].

repeated .google.monitoring.v3.AlertPolicy.AlertStrategy.NotificationPrompt notification_prompts = 2;

Returns
Type Description
int

The count of notificationPrompts.

getNotificationPromptsList()

public List<AlertPolicy.AlertStrategy.NotificationPrompt> getNotificationPromptsList()

For log-based alert policies, the notification prompts is always [OPENED]. For non log-based alert policies, the notification prompts can be [OPENED] or [OPENED, CLOSED].

repeated .google.monitoring.v3.AlertPolicy.AlertStrategy.NotificationPrompt notification_prompts = 2;

Returns
Type Description
List<NotificationPrompt>

A list containing the notificationPrompts.

getNotificationPromptsValue(int index)

public int getNotificationPromptsValue(int index)

For log-based alert policies, the notification prompts is always [OPENED]. For non log-based alert policies, the notification prompts can be [OPENED] or [OPENED, CLOSED].

repeated .google.monitoring.v3.AlertPolicy.AlertStrategy.NotificationPrompt notification_prompts = 2;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of notificationPrompts at the given index.

getNotificationPromptsValueList()

public List<Integer> getNotificationPromptsValueList()

For log-based alert policies, the notification prompts is always [OPENED]. For non log-based alert policies, the notification prompts can be [OPENED] or [OPENED, CLOSED].

repeated .google.monitoring.v3.AlertPolicy.AlertStrategy.NotificationPrompt notification_prompts = 2;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for notificationPrompts.

getNotificationRateLimit()

public AlertPolicy.AlertStrategy.NotificationRateLimit getNotificationRateLimit()

Required for log-based alerting policies, i.e. policies with a LogMatch condition.

This limit is not implemented for alerting policies that do not have a LogMatch condition.

.google.monitoring.v3.AlertPolicy.AlertStrategy.NotificationRateLimit notification_rate_limit = 1;

Returns
Type Description
AlertPolicy.AlertStrategy.NotificationRateLimit

The notificationRateLimit.

getNotificationRateLimitOrBuilder()

public AlertPolicy.AlertStrategy.NotificationRateLimitOrBuilder getNotificationRateLimitOrBuilder()

Required for log-based alerting policies, i.e. policies with a LogMatch condition.

This limit is not implemented for alerting policies that do not have a LogMatch condition.

.google.monitoring.v3.AlertPolicy.AlertStrategy.NotificationRateLimit notification_rate_limit = 1;

Returns
Type Description
AlertPolicy.AlertStrategy.NotificationRateLimitOrBuilder

getParserForType()

public Parser<AlertPolicy.AlertStrategy> getParserForType()
Returns
Type Description
Parser<AlertStrategy>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasAutoClose()

public boolean hasAutoClose()

If an alerting policy that was active has no data for this long, any open incidents will close

.google.protobuf.Duration auto_close = 3;

Returns
Type Description
boolean

Whether the autoClose field is set.

hasNotificationRateLimit()

public boolean hasNotificationRateLimit()

Required for log-based alerting policies, i.e. policies with a LogMatch condition.

This limit is not implemented for alerting policies that do not have a LogMatch condition.

.google.monitoring.v3.AlertPolicy.AlertStrategy.NotificationRateLimit notification_rate_limit = 1;

Returns
Type Description
boolean

Whether the notificationRateLimit 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 AlertPolicy.AlertStrategy.Builder newBuilderForType()
Returns
Type Description
AlertPolicy.AlertStrategy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public AlertPolicy.AlertStrategy.Builder toBuilder()
Returns
Type Description
AlertPolicy.AlertStrategy.Builder

writeTo(CodedOutputStream output)

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