Class MaintenanceSummary (0.2.0)

public final class MaintenanceSummary extends GeneratedMessageV3 implements MaintenanceSummaryOrBuilder

MaintenanceSummary contains maintenance statistics calculated based on ResourceMaintenances within the scope: project and location.

Protobuf type google.cloud.maintenance.api.v1beta.MaintenanceSummary

Static Fields

CATEGORY_FIELD_NUMBER

public static final int CATEGORY_FIELD_NUMBER
Field Value
Type Description
int

CONTROLS_FIELD_NUMBER

public static final int CONTROLS_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

MAINTENANCE_END_TIME_FIELD_NUMBER

public static final int MAINTENANCE_END_TIME_FIELD_NUMBER
Field Value
Type Description
int

MAINTENANCE_NAME_FIELD_NUMBER

public static final int MAINTENANCE_NAME_FIELD_NUMBER
Field Value
Type Description
int

MAINTENANCE_SCHEDULED_END_TIME_FIELD_NUMBER

public static final int MAINTENANCE_SCHEDULED_END_TIME_FIELD_NUMBER
Field Value
Type Description
int

MAINTENANCE_SCHEDULED_START_TIME_FIELD_NUMBER

public static final int MAINTENANCE_SCHEDULED_START_TIME_FIELD_NUMBER
Field Value
Type Description
int

MAINTENANCE_START_TIME_FIELD_NUMBER

public static final int MAINTENANCE_START_TIME_FIELD_NUMBER
Field Value
Type Description
int

STATS_FIELD_NUMBER

public static final int STATS_FIELD_NUMBER
Field Value
Type Description
int

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER
Field Value
Type Description
int

USER_CONTROLLABLE_FIELD_NUMBER

public static final int USER_CONTROLLABLE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MaintenanceSummary getDefaultInstance()
Returns
Type Description
MaintenanceSummary

getDescriptor()

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

newBuilder()

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

newBuilder(MaintenanceSummary prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCategory()

public MaintenanceCategory getCategory()

Output only. The category of the maintenance event.

.google.cloud.maintenance.api.v1beta.MaintenanceCategory category = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
MaintenanceCategory

The category.

getCategoryValue()

public int getCategoryValue()

Output only. The category of the maintenance event.

.google.cloud.maintenance.api.v1beta.MaintenanceCategory category = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for category.

getControls(int index)

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.v1beta.MaintenanceControl controls = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
MaintenanceControl

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.v1beta.MaintenanceControl controls = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

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.v1beta.MaintenanceControl controls = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<MaintenanceControl>

getControlsOrBuilder(int index)

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.v1beta.MaintenanceControl controls = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
MaintenanceControlOrBuilder

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.v1beta.MaintenanceControl controls = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.maintenance.api.v1beta.MaintenanceControlOrBuilder>

getDefaultInstanceForType()

public MaintenanceSummary getDefaultInstanceForType()
Returns
Type Description
MaintenanceSummary

getDescription()

public String getDescription()

Output only. The description of the maintenance.

string description = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Output only. The description of the maintenance.

string description = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for description.

getMaintenanceEndTime()

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

Returns
Type Description
Timestamp

The maintenanceEndTime.

getMaintenanceEndTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

getMaintenanceName()

public String getMaintenanceName()

Output only. The name of the maintenance.

string maintenance_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The maintenanceName.

getMaintenanceNameBytes()

public ByteString getMaintenanceNameBytes()

Output only. The name of the maintenance.

string maintenance_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for maintenanceName.

getMaintenanceScheduledEndTime()

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

Returns
Type Description
Timestamp

The maintenanceScheduledEndTime.

getMaintenanceScheduledEndTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

getMaintenanceScheduledStartTime()

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

Returns
Type Description
Timestamp

The maintenanceScheduledStartTime.

getMaintenanceScheduledStartTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

getMaintenanceStartTime()

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

Returns
Type Description
Timestamp

The maintenanceStartTime.

getMaintenanceStartTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStats(int index)

public MaintenanceSummary.Stats getStats(int index)

Output only. Stats is a field of ResourceMaintenance used to aggregate the stats.

repeated .google.cloud.maintenance.api.v1beta.MaintenanceSummary.Stats stats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
MaintenanceSummary.Stats

getStatsCount()

public int getStatsCount()

Output only. Stats is a field of ResourceMaintenance used to aggregate the stats.

repeated .google.cloud.maintenance.api.v1beta.MaintenanceSummary.Stats stats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getStatsList()

public List<MaintenanceSummary.Stats> getStatsList()

Output only. Stats is a field of ResourceMaintenance used to aggregate the stats.

repeated .google.cloud.maintenance.api.v1beta.MaintenanceSummary.Stats stats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Stats>

getStatsOrBuilder(int index)

public MaintenanceSummary.StatsOrBuilder getStatsOrBuilder(int index)

Output only. Stats is a field of ResourceMaintenance used to aggregate the stats.

repeated .google.cloud.maintenance.api.v1beta.MaintenanceSummary.Stats stats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
MaintenanceSummary.StatsOrBuilder

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.v1beta.MaintenanceSummary.Stats stats = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.maintenance.api.v1beta.MaintenanceSummary.StatsOrBuilder>

getTitle()

public String getTitle()

Output only. The title of the maintenance.

string title = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The title.

getTitleBytes()

public ByteString getTitleBytes()

Output only. The title of the maintenance.

string title = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for title.

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

Returns
Type Description
boolean

The userControllable.

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

Returns
Type Description
boolean

Whether the maintenanceEndTime field is set.

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

Returns
Type Description
boolean

Whether the maintenanceScheduledEndTime field is set.

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

Returns
Type Description
boolean

Whether the maintenanceScheduledStartTime field is set.

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

Returns
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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