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,
  "maintenanceCompleteTime": string,
  "maintenanceCancelTime": string,
  "maintenanceScheduledStartTime": string,
  "maintenanceScheduledEndTime": string,
  "labels": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string
}
Fields
name

string

Identifier. The name of the resourceMaintenance resource. Format: projects/{project}/locations/{location}/resourceMaintenance/{resourceMaintenanceId}
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.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The update time of the resource maintenance.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
maintenanceStartTime

string (Timestamp format)

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

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
maintenanceCompleteTime

string (Timestamp format)

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

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
maintenanceCancelTime

string (Timestamp format)

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

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
maintenanceScheduledStartTime

string (Timestamp format)

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

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
maintenanceScheduledEndTime

string (Timestamp format)

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

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
labels

map (key: string, value: string)

Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
uid

string

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

string

Output only. An opaque value that uniquely identifies a version or generation of a resource. It can be used to confirm that the client and server agree on the ordering of a resource being written.

Resource

Spec is the spec of a resource 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. Available values can be found here: https://cloud.google.com/iam/docs/full-resource-names
location

string

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

string

Output only. The type of the resource. Available values can be found here: https://cloud.google.com/asset-inventory/docs/asset-types#supported_resource_types Please note that not all the resource types will have their maintenances reported.

Maintenance

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

JSON representation 
{
  "maintenanceName": string,
  "title": string,
  "description": string
}
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.

State

State is the state of a resource maintenance.

Enums
STATE_UNSPECIFIED Unspecified state.
SCHEDULED The resource maintenance is available.
STARTED The resource maintenance is started.
CANCELLED The resource maintenance is cancelled.
COMPLETED The resource maintenance is completed.

Methods

get

 Retrieve a single resource maintenance.

list

 Retrieve a collection of resource maintenances.