Class Snooze (3.57.0) 

public final class Snooze extends GeneratedMessageV3 implements SnoozeOrBuilder

A Snooze will prevent any alerts from being opened, and close any that are already open. The Snooze will work on alerts that match the criteria defined in the Snooze. The Snooze will be active from interval.start_time through interval.end_time.

Protobuf type google.monitoring.v3.Snooze

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Snooze

Implements

SnoozeOrBuilder

Static Fields

CRITERIA_FIELD_NUMBER

public static final int CRITERIA_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

INTERVAL_FIELD_NUMBER

public static final int INTERVAL_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Snooze getDefaultInstance()
Returns
Type Description
Snooze

getDescriptor()

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

newBuilder()

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

newBuilder(Snooze prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCriteria()

public Snooze.Criteria getCriteria()

Required. This defines the criteria for applying the Snooze. See Criteria for more information.

.google.monitoring.v3.Snooze.Criteria criteria = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Snooze.Criteria

The criteria.

getCriteriaOrBuilder()

public Snooze.CriteriaOrBuilder getCriteriaOrBuilder()

Required. This defines the criteria for applying the Snooze. See Criteria for more information.

.google.monitoring.v3.Snooze.Criteria criteria = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Snooze.CriteriaOrBuilder

getDefaultInstanceForType()

public Snooze getDefaultInstanceForType()
Returns
Type Description
Snooze

getDisplayName()

public String getDisplayName()

Required. A display name for the Snooze. This can be, at most, 512 unicode characters.

string display_name = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. A display name for the Snooze. This can be, at most, 512 unicode characters.

string display_name = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for displayName.

getInterval()

public TimeInterval getInterval()

Required. The Snooze will be active from interval.start_time through interval.end_time. interval.start_time cannot be in the past. There is a 15 second clock skew to account for the time it takes for a request to reach the API from the UI.

.google.monitoring.v3.TimeInterval interval = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TimeInterval

The interval.

getIntervalOrBuilder()

public TimeIntervalOrBuilder getIntervalOrBuilder()

Required. The Snooze will be active from interval.start_time through interval.end_time. interval.start_time cannot be in the past. There is a 15 second clock skew to account for the time it takes for a request to reach the API from the UI.

.google.monitoring.v3.TimeInterval interval = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TimeIntervalOrBuilder

getName()

public String getName()

Required. Identifier. The name of the Snooze. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]

The ID of the Snooze will be generated by the system.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. Identifier. The name of the Snooze. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID]

The ID of the Snooze will be generated by the system.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasCriteria()

public boolean hasCriteria()

Required. This defines the criteria for applying the Snooze. See Criteria for more information.

.google.monitoring.v3.Snooze.Criteria criteria = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the criteria field is set.

hasInterval()

public boolean hasInterval()

Required. The Snooze will be active from interval.start_time through interval.end_time. interval.start_time cannot be in the past. There is a 15 second clock skew to account for the time it takes for a request to reach the API from the UI.

.google.monitoring.v3.TimeInterval interval = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the interval 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 Snooze.Builder newBuilderForType()
Returns
Type Description
Snooze.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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