REST Resource: projects.locations.resourceMaintenances

Resource: ResourceMaintenance

ResourceMaintenance is a resource that represents a maintenance operation on a resource.

JSON representation 
{
  "name": string,
  "resource": {
    object (Resource)
  },
  "maintenance": {
    object (Maintenance)
  },
  "state": enum (State),
  "createTime": string,
  "updateTime": string,
  "maintenanceStartTime": string,
  "maintenanceEndTime": string,
  "maintenanceCancelTime": string,
  "maintenanceScheduledStartTime": string,
  "maintenanceScheduledEndTime": string,
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
}
Fields
name

string

Identifier. The name of the resourceMaintenance resource. Format: "projects/{project}/locations/{location}/resourceMaintenance/{resource-maintenance-id}"
resource

object (Resource)

Output only. The resource spec of the resource maintenance.
maintenance

object (Maintenance)

Output only. The details of the maintenance.
state

enum (State)

Output only. The state of the resource maintenance.
createTime

string (Timestamp format)

Output only. The create time of the resource maintenance.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The update time of the resource maintenance.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
maintenanceStartTime

string (Timestamp format)

Output only. The time when the resource maintenance has started.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
maintenanceEndTime

string (Timestamp format)

Output only. The time when the resource maintenance has completed.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
maintenanceCancelTime

string (Timestamp format)

Output only. The time when the resource maintenance was cancelled.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
maintenanceScheduledStartTime

string (Timestamp format)

Output only. The time when the maintenance on the resource was scheduled to start.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
maintenanceScheduledEndTime

string (Timestamp format)

Output only. The time when the maintenance on the resource was scheduled to end.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
userControllable

boolean

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)
controls[]

object (MaintenanceControl)

Output only. The controls of the maintenance.
uid

string

Output only. A universally unique identifier (in UUID4 format) for the ResourceMaintenance.

Resource

Resource contains information about the resource affected by maintenance.

JSON representation 
{
  "resourceName": string,
  "location": string,
  "type": string
}
Fields
resourceName

string

Output only. Name is the reference to the consumer resource affected by the maintenance. For available values, see Asset names.
location

string

Output only. The location of the resource. Format: us-central1
type

string

Output only. The type of the resource. For available values, see resource types of supported services.

Maintenance

Maintenance is the maintenance details of a resource's maintenance.

JSON representation 
{
  "maintenanceName": string,
  "title": string,
  "description": string,
  "category": enum (MaintenanceCategory)
}
Fields
maintenanceName

string

Maintenance is the name of the corresponding maintenance resource following the standard naming scheme: "{maintenance-id}"
title

string

Output only. The title of the maintenance.
description

string

Output only. The description of the maintenance.
category

enum (MaintenanceCategory)

Output only. The category of the maintenance.

MaintenanceCategory

The Category of the maintenance.

Enums
MAINTENANCE_CATEGORY_UNSPECIFIED Unspecified category.
INFRASTRUCTURE

Infrastructure maintenance is regular maintenance on equipment (for example network equipment).

They are usually scheduled in advance and we provide notification, when possible, so that users can plan for the infrastructure maintenance and prevent downtime. Infrastructure maintenance do not have a set interval between occurrences, but generally occur several times a year.
SERVICE_UPDATE

Updates that can include bug fixes, changes, or new features that are backward compatible with existing versions (including patches). Some Service Producers allow users to control the scheduling of those maintenances using maintenance windows.

State

State is the state of a resource maintenance.

Enums
STATE_UNSPECIFIED Unspecified state.
SCHEDULED The resource maintenance is scheduled.
RUNNING The resource maintenance is running.
CANCELLED The resource maintenance is cancelled.
SUCCEEDED The resource maintenance is succeeded.

MaintenanceControl

The control of the maintenance.

JSON representation 
{
  "control": enum (Control),
  "isCustom": boolean,
  "documentation": string
}
Fields
control

enum (Control)

The control of the resource maintenance.
isCustom

boolean

Indicates whether the control is available only in Service Producer API.
documentation

string

Link to Service Producer documentation for maintenance control. Provided only when isCustom is true.

Control

Sets the type of control supported. comment (as in logs).

Enums
CONTROL_UNSPECIFIED Unspecified control.
APPLY Apply control.
MANAGE_POLICY Manage policy control.
RESCHEDULE Reschedule control.

Methods

get

 Retrieve a single resource maintenance.

list

 Retrieve a collection of resource maintenances.

summarize

 Retrieve a statistics of a specific maintenance.