Class UpdateSnoozeRequest

  • All Implemented Interfaces:
    UpdateSnoozeRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class UpdateSnoozeRequest
    extends com.google.protobuf.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 `Snooze`s 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
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  UpdateSnoozeRequest.Builder
      The message definition for updating a `Snooze`.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int SNOOZE_FIELD_NUMBER  
      static int UPDATE_MASK_FIELD_NUMBER  
      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields
      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize
      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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];
        Specified by:
        hasSnooze in interface UpdateSnoozeRequestOrBuilder
        Returns:
        Whether the snooze field is set.
      • 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];
        Specified by:
        getSnooze in interface UpdateSnoozeRequestOrBuilder
        Returns:
        The snooze.
      • 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];
        Specified by:
        hasUpdateMask in interface UpdateSnoozeRequestOrBuilder
        Returns:
        Whether the updateMask field is set.
      • getUpdateMask

        public com.google.protobuf.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];
        Specified by:
        getUpdateMask in interface UpdateSnoozeRequestOrBuilder
        Returns:
        The updateMask.
      • getUpdateMaskOrBuilder

        public com.google.protobuf.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];
        Specified by:
        getUpdateMaskOrBuilder in interface UpdateSnoozeRequestOrBuilder
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static UpdateSnoozeRequest parseFrom​(ByteBuffer data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static UpdateSnoozeRequest parseFrom​(ByteBuffer data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static UpdateSnoozeRequest parseFrom​(com.google.protobuf.ByteString data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static UpdateSnoozeRequest parseFrom​(com.google.protobuf.ByteString data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static UpdateSnoozeRequest parseFrom​(byte[] data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static UpdateSnoozeRequest parseFrom​(byte[] data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static UpdateSnoozeRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException
        Throws:
        IOException
      • newBuilderForType

        public UpdateSnoozeRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public UpdateSnoozeRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected UpdateSnoozeRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<UpdateSnoozeRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public UpdateSnoozeRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder