Package com.google.cloud.maintenance.api.v1

Class MaintenanceSummary

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.maintenance.api.v1.MaintenanceSummary
All Implemented Interfaces:
MaintenanceSummaryOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class MaintenanceSummary extends com.google.protobuf.GeneratedMessage implements MaintenanceSummaryOrBuilder
 MaintenanceSummary contains maintenance statistics calculated based on
 ResourceMaintenances within the scope: project and location.
Protobuf type google.cloud.maintenance.api.v1.MaintenanceSummary
See Also:

  • Field Details

    • MAINTENANCE_NAME_FIELD_NUMBER

      public static final int MAINTENANCE_NAME_FIELD_NUMBER
      See Also:

    • TITLE_FIELD_NUMBER

      public static final int TITLE_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • CATEGORY_FIELD_NUMBER

      public static final int CATEGORY_FIELD_NUMBER
      See Also:

    • MAINTENANCE_SCHEDULED_START_TIME_FIELD_NUMBER

      public static final int MAINTENANCE_SCHEDULED_START_TIME_FIELD_NUMBER
      See Also:

    • MAINTENANCE_SCHEDULED_END_TIME_FIELD_NUMBER

      public static final int MAINTENANCE_SCHEDULED_END_TIME_FIELD_NUMBER
      See Also:

    • MAINTENANCE_START_TIME_FIELD_NUMBER

      public static final int MAINTENANCE_START_TIME_FIELD_NUMBER
      See Also:

    • MAINTENANCE_END_TIME_FIELD_NUMBER

      public static final int MAINTENANCE_END_TIME_FIELD_NUMBER
      See Also:

    • USER_CONTROLLABLE_FIELD_NUMBER

      public static final int USER_CONTROLLABLE_FIELD_NUMBER
      See Also:

    • CONTROLS_FIELD_NUMBER

      public static final int CONTROLS_FIELD_NUMBER
      See Also:

    • STATS_FIELD_NUMBER

      public static final int STATS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getMaintenanceName

      public String getMaintenanceName()
       Output only. The name of the maintenance.
      string maintenance_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getMaintenanceName in interface MaintenanceSummaryOrBuilder
      Returns:
      The maintenanceName.

    • getMaintenanceNameBytes

      public com.google.protobuf.ByteString getMaintenanceNameBytes()
       Output only. The name of the maintenance.
      string maintenance_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getMaintenanceNameBytes in interface MaintenanceSummaryOrBuilder
      Returns:
      The bytes for maintenanceName.

    • getTitle

      public String getTitle()
       Output only. The title of the maintenance.
      string title = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTitle in interface MaintenanceSummaryOrBuilder
      Returns:
      The title.

    • getTitleBytes

      public com.google.protobuf.ByteString getTitleBytes()
       Output only. The title of the maintenance.
      string title = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTitleBytes in interface MaintenanceSummaryOrBuilder
      Returns:
      The bytes for title.

    • getDescription

      public String getDescription()
       Output only. The description of the maintenance.
      string description = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDescription in interface MaintenanceSummaryOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Output only. The description of the maintenance.
      string description = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDescriptionBytes in interface MaintenanceSummaryOrBuilder
      Returns:
      The bytes for description.

    • getCategoryValue

      public int getCategoryValue()
       Output only. The category of the maintenance event.
      .google.cloud.maintenance.api.v1.MaintenanceCategory category = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCategoryValue in interface MaintenanceSummaryOrBuilder
      Returns:
      The enum numeric value on the wire for category.

    • getCategory

      public MaintenanceCategory getCategory()
       Output only. The category of the maintenance event.
      .google.cloud.maintenance.api.v1.MaintenanceCategory category = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCategory in interface MaintenanceSummaryOrBuilder
      Returns:
      The category.

    • hasMaintenanceScheduledStartTime

      public boolean hasMaintenanceScheduledStartTime()
       Output only. Scheduled start time of the maintenance. The maintenance will
 start at `maintenanceScheduledStartTime` or later, with best effort to
 finish before `maintenanceScheduledEndTime`.
      .google.protobuf.Timestamp maintenance_scheduled_start_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasMaintenanceScheduledStartTime in interface MaintenanceSummaryOrBuilder
      Returns:
      Whether the maintenanceScheduledStartTime field is set.

    • getMaintenanceScheduledStartTime

      public com.google.protobuf.Timestamp getMaintenanceScheduledStartTime()
       Output only. Scheduled start time of the maintenance. The maintenance will
 start at `maintenanceScheduledStartTime` or later, with best effort to
 finish before `maintenanceScheduledEndTime`.
      .google.protobuf.Timestamp maintenance_scheduled_start_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getMaintenanceScheduledStartTime in interface MaintenanceSummaryOrBuilder
      Returns:
      The maintenanceScheduledStartTime.

    • getMaintenanceScheduledStartTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getMaintenanceScheduledStartTimeOrBuilder()
       Output only. Scheduled start time of the maintenance. The maintenance will
 start at `maintenanceScheduledStartTime` or later, with best effort to
 finish before `maintenanceScheduledEndTime`.
      .google.protobuf.Timestamp maintenance_scheduled_start_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getMaintenanceScheduledStartTimeOrBuilder in interface MaintenanceSummaryOrBuilder

    • hasMaintenanceScheduledEndTime

      public boolean hasMaintenanceScheduledEndTime()
       Output only. An estimated (best effort, not guaranteed) end time of the
 scheduled maintenance.
      .google.protobuf.Timestamp maintenance_scheduled_end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasMaintenanceScheduledEndTime in interface MaintenanceSummaryOrBuilder
      Returns:
      Whether the maintenanceScheduledEndTime field is set.

    • getMaintenanceScheduledEndTime

      public com.google.protobuf.Timestamp getMaintenanceScheduledEndTime()
       Output only. An estimated (best effort, not guaranteed) end time of the
 scheduled maintenance.
      .google.protobuf.Timestamp maintenance_scheduled_end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getMaintenanceScheduledEndTime in interface MaintenanceSummaryOrBuilder
      Returns:
      The maintenanceScheduledEndTime.

    • getMaintenanceScheduledEndTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getMaintenanceScheduledEndTimeOrBuilder()
       Output only. An estimated (best effort, not guaranteed) end time of the
 scheduled maintenance.
      .google.protobuf.Timestamp maintenance_scheduled_end_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getMaintenanceScheduledEndTimeOrBuilder in interface MaintenanceSummaryOrBuilder

    • hasMaintenanceStartTime

      public boolean hasMaintenanceStartTime()
       Output only. Actual date when the maintenance started. Field present only
 after the state changed to `RUNNING`.
      .google.protobuf.Timestamp maintenance_start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasMaintenanceStartTime in interface MaintenanceSummaryOrBuilder
      Returns:
      Whether the maintenanceStartTime field is set.

    • getMaintenanceStartTime

      public com.google.protobuf.Timestamp getMaintenanceStartTime()
       Output only. Actual date when the maintenance started. Field present only
 after the state changed to `RUNNING`.
      .google.protobuf.Timestamp maintenance_start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getMaintenanceStartTime in interface MaintenanceSummaryOrBuilder
      Returns:
      The maintenanceStartTime.

    • getMaintenanceStartTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getMaintenanceStartTimeOrBuilder()
       Output only. Actual date when the maintenance started. Field present only
 after the state changed to `RUNNING`.
      .google.protobuf.Timestamp maintenance_start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getMaintenanceStartTimeOrBuilder in interface MaintenanceSummaryOrBuilder

    • hasMaintenanceEndTime

      public boolean hasMaintenanceEndTime()
       Output only. Actual date when the maintenance successfully completed. Field
 present only after the state changed to `SUCCEEDED`.
      .google.protobuf.Timestamp maintenance_end_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasMaintenanceEndTime in interface MaintenanceSummaryOrBuilder
      Returns:
      Whether the maintenanceEndTime field is set.

    • getMaintenanceEndTime

      public com.google.protobuf.Timestamp getMaintenanceEndTime()
       Output only. Actual date when the maintenance successfully completed. Field
 present only after the state changed to `SUCCEEDED`.
      .google.protobuf.Timestamp maintenance_end_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getMaintenanceEndTime in interface MaintenanceSummaryOrBuilder
      Returns:
      The maintenanceEndTime.

    • getMaintenanceEndTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getMaintenanceEndTimeOrBuilder()
       Output only. Actual date when the maintenance successfully completed. Field
 present only after the state changed to `SUCCEEDED`.
      .google.protobuf.Timestamp maintenance_end_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getMaintenanceEndTimeOrBuilder in interface MaintenanceSummaryOrBuilder

    • getUserControllable

      public boolean getUserControllable()
       Output only. Indicates whether the user has some control over that
 maintenance, either proactively before maintenance was scheduled with
 maintenance policy or with reactive controls after it was scheduled (see
 controls field).
      bool user_controllable = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUserControllable in interface MaintenanceSummaryOrBuilder
      Returns:
      The userControllable.

    • getControlsList

      public List<MaintenanceControl> getControlsList()
       Output only. Control available for that Maintenance (might not be available
 for every resource that maintenance is applied to).
      repeated .google.cloud.maintenance.api.v1.MaintenanceControl controls = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getControlsList in interface MaintenanceSummaryOrBuilder

    • getControlsOrBuilderList

      public List<? extends MaintenanceControlOrBuilder> getControlsOrBuilderList()
       Output only. Control available for that Maintenance (might not be available
 for every resource that maintenance is applied to).
      repeated .google.cloud.maintenance.api.v1.MaintenanceControl controls = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getControlsOrBuilderList in interface MaintenanceSummaryOrBuilder

    • getControlsCount

      public int getControlsCount()
       Output only. Control available for that Maintenance (might not be available
 for every resource that maintenance is applied to).
      repeated .google.cloud.maintenance.api.v1.MaintenanceControl controls = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getControlsCount in interface MaintenanceSummaryOrBuilder

    • getControls

      public MaintenanceControl getControls(int index)
       Output only. Control available for that Maintenance (might not be available
 for every resource that maintenance is applied to).
      repeated .google.cloud.maintenance.api.v1.MaintenanceControl controls = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getControls in interface MaintenanceSummaryOrBuilder

    • getControlsOrBuilder

      public MaintenanceControlOrBuilder getControlsOrBuilder(int index)
       Output only. Control available for that Maintenance (might not be available
 for every resource that maintenance is applied to).
      repeated .google.cloud.maintenance.api.v1.MaintenanceControl controls = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getControlsOrBuilder in interface MaintenanceSummaryOrBuilder

    • getStatsList

      public List<MaintenanceSummary.Stats> getStatsList()
       Output only. Stats is a field of ResourceMaintenance used to aggregate the
 stats.
      repeated .google.cloud.maintenance.api.v1.MaintenanceSummary.Stats stats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStatsList in interface MaintenanceSummaryOrBuilder

    • getStatsOrBuilderList

      public List<? extends MaintenanceSummary.StatsOrBuilder> getStatsOrBuilderList()
       Output only. Stats is a field of ResourceMaintenance used to aggregate the
 stats.
      repeated .google.cloud.maintenance.api.v1.MaintenanceSummary.Stats stats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStatsOrBuilderList in interface MaintenanceSummaryOrBuilder

    • getStatsCount

      public int getStatsCount()
       Output only. Stats is a field of ResourceMaintenance used to aggregate the
 stats.
      repeated .google.cloud.maintenance.api.v1.MaintenanceSummary.Stats stats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStatsCount in interface MaintenanceSummaryOrBuilder

    • getStats

      public MaintenanceSummary.Stats getStats(int index)
       Output only. Stats is a field of ResourceMaintenance used to aggregate the
 stats.
      repeated .google.cloud.maintenance.api.v1.MaintenanceSummary.Stats stats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStats in interface MaintenanceSummaryOrBuilder

    • getStatsOrBuilder

      public MaintenanceSummary.StatsOrBuilder getStatsOrBuilder(int index)
       Output only. Stats is a field of ResourceMaintenance used to aggregate the
 stats.
      repeated .google.cloud.maintenance.api.v1.MaintenanceSummary.Stats stats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStatsOrBuilder in interface MaintenanceSummaryOrBuilder

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 MaintenanceSummary parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static MaintenanceSummary parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static MaintenanceSummary parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MaintenanceSummary parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static MaintenanceSummary parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static MaintenanceSummary parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MaintenanceSummary parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MaintenanceSummary parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static MaintenanceSummary.Builder newBuilder()

    • newBuilder

      public static MaintenanceSummary.Builder newBuilder(MaintenanceSummary prototype)

    • toBuilder

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

    • newBuilderForType

      protected MaintenanceSummary.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static MaintenanceSummary getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<MaintenanceSummary> parser()

    • getParserForType

      public com.google.protobuf.Parser<MaintenanceSummary> 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.GeneratedMessage

    • getDefaultInstanceForType

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