Class UpdateSnoozeRequest (3.43.0)

public final class UpdateSnoozeRequest extends GeneratedMessageV3 implements UpdateSnoozeRequestOrBuilder

The message definition for updating a Snooze. The field, snooze.name identifies the Snooze to be updated. The remainder of snooze gives the content the Snooze in question will be assigned.

What fields can be updated depends on the start time and end time of the Snooze.

  • end time is in the past: These Snoozes are considered read-only and cannot be updated.
  • start time is in the past and end time is in the future: display_name and interval.end_time can be updated.
  • start time is in the future: display_name, interval.start_time and interval.end_time can be updated.

Protobuf type google.monitoring.v3.UpdateSnoozeRequest

Static Fields

SNOOZE_FIELD_NUMBER

public static final int SNOOZE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UpdateSnoozeRequest getDefaultInstance()
Returns
Type Description
UpdateSnoozeRequest

getDescriptor()

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

newBuilder()

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

newBuilder(UpdateSnoozeRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public UpdateSnoozeRequest getDefaultInstanceForType()
Returns
Type Description
UpdateSnoozeRequest

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSnooze()

public Snooze getSnooze()

Required. The Snooze to update. Must have the name field present.

.google.monitoring.v3.Snooze snooze = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Snooze

The snooze.

getSnoozeOrBuilder()

public SnoozeOrBuilder getSnoozeOrBuilder()

Required. The Snooze to update. Must have the name field present.

.google.monitoring.v3.Snooze snooze = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SnoozeOrBuilder

getUpdateMask()

public FieldMask getUpdateMask()

Required. The fields to update.

For each field listed in update_mask:

  • If the Snooze object supplied in the UpdateSnoozeRequest has a value for that field, the value of the field in the existing Snooze will be set to the value of the field in the supplied Snooze.
  • If the field does not have a value in the supplied Snooze, the field in the existing Snooze is set to its default value.

    Fields not listed retain their existing value.

    The following are the field names that are accepted in update_mask:

  • display_name

  • interval.start_time
  • interval.end_time

    That said, the start time and end time of the Snooze determines which fields can legally be updated. Before attempting an update, users should consult the documentation for UpdateSnoozeRequest, which talks about which fields can be updated.

.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

Required. The fields to update.

For each field listed in update_mask:

  • If the Snooze object supplied in the UpdateSnoozeRequest has a value for that field, the value of the field in the existing Snooze will be set to the value of the field in the supplied Snooze.
  • If the field does not have a value in the supplied Snooze, the field in the existing Snooze is set to its default value.

    Fields not listed retain their existing value.

    The following are the field names that are accepted in update_mask:

  • display_name

  • interval.start_time
  • interval.end_time

    That said, the start time and end time of the Snooze determines which fields can legally be updated. Before attempting an update, users should consult the documentation for UpdateSnoozeRequest, which talks about which fields can be updated.

.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FieldMaskOrBuilder

hasSnooze()

public boolean hasSnooze()

Required. The Snooze to update. Must have the name field present.

.google.monitoring.v3.Snooze snooze = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the snooze field is set.

hasUpdateMask()

public boolean hasUpdateMask()

Required. The fields to update.

For each field listed in update_mask:

  • If the Snooze object supplied in the UpdateSnoozeRequest has a value for that field, the value of the field in the existing Snooze will be set to the value of the field in the supplied Snooze.
  • If the field does not have a value in the supplied Snooze, the field in the existing Snooze is set to its default value.

    Fields not listed retain their existing value.

    The following are the field names that are accepted in update_mask:

  • display_name

  • interval.start_time
  • interval.end_time

    That said, the start time and end time of the Snooze determines which fields can legally be updated. Before attempting an update, users should consult the documentation for UpdateSnoozeRequest, which talks about which fields can be updated.

.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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