Class UpdateSnoozeRequest.Builder (3.23.0)

public static final class UpdateSnoozeRequest.Builder extends GeneratedMessageV3.Builder<UpdateSnoozeRequest.Builder> 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 Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UpdateSnoozeRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
UpdateSnoozeRequest.Builder
Overrides

build()

public UpdateSnoozeRequest build()
Returns
TypeDescription
UpdateSnoozeRequest

buildPartial()

public UpdateSnoozeRequest buildPartial()
Returns
TypeDescription
UpdateSnoozeRequest

clear()

public UpdateSnoozeRequest.Builder clear()
Returns
TypeDescription
UpdateSnoozeRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public UpdateSnoozeRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
UpdateSnoozeRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateSnoozeRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
UpdateSnoozeRequest.Builder
Overrides

clearSnooze()

public UpdateSnoozeRequest.Builder clearSnooze()

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

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

Returns
TypeDescription
UpdateSnoozeRequest.Builder

clearUpdateMask()

public UpdateSnoozeRequest.Builder clearUpdateMask()

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
TypeDescription
UpdateSnoozeRequest.Builder

clone()

public UpdateSnoozeRequest.Builder clone()
Returns
TypeDescription
UpdateSnoozeRequest.Builder
Overrides

getDefaultInstanceForType()

public UpdateSnoozeRequest getDefaultInstanceForType()
Returns
TypeDescription
UpdateSnoozeRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
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
TypeDescription
Snooze

The snooze.

getSnoozeBuilder()

public Snooze.Builder getSnoozeBuilder()

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

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

Returns
TypeDescription
Snooze.Builder

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
TypeDescription
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
TypeDescription
FieldMask

The updateMask.

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

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
TypeDescription
Builder

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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the updateMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(UpdateSnoozeRequest other)

public UpdateSnoozeRequest.Builder mergeFrom(UpdateSnoozeRequest other)
Parameter
NameDescription
otherUpdateSnoozeRequest
Returns
TypeDescription
UpdateSnoozeRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UpdateSnoozeRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UpdateSnoozeRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public UpdateSnoozeRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
UpdateSnoozeRequest.Builder
Overrides

mergeSnooze(Snooze value)

public UpdateSnoozeRequest.Builder mergeSnooze(Snooze value)

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

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

Parameter
NameDescription
valueSnooze
Returns
TypeDescription
UpdateSnoozeRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UpdateSnoozeRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
UpdateSnoozeRequest.Builder
Overrides

mergeUpdateMask(FieldMask value)

public UpdateSnoozeRequest.Builder mergeUpdateMask(FieldMask value)

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];

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
UpdateSnoozeRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public UpdateSnoozeRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
UpdateSnoozeRequest.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public UpdateSnoozeRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
UpdateSnoozeRequest.Builder
Overrides

setSnooze(Snooze value)

public UpdateSnoozeRequest.Builder setSnooze(Snooze value)

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

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

Parameter
NameDescription
valueSnooze
Returns
TypeDescription
UpdateSnoozeRequest.Builder

setSnooze(Snooze.Builder builderForValue)

public UpdateSnoozeRequest.Builder setSnooze(Snooze.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueSnooze.Builder
Returns
TypeDescription
UpdateSnoozeRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final UpdateSnoozeRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
UpdateSnoozeRequest.Builder
Overrides

setUpdateMask(FieldMask value)

public UpdateSnoozeRequest.Builder setUpdateMask(FieldMask value)

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];

Parameter
NameDescription
valueFieldMask
Returns
TypeDescription
UpdateSnoozeRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public UpdateSnoozeRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

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];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
UpdateSnoozeRequest.Builder