{ "fullyEncodeReservedExpansion": true, "basePath": "", "discoveryVersion": "v1", "servicePath": "", "name": "maintenance", "ownerName": "Google", "baseUrl": "https://maintenance.googleapis.com/", "description": "The Maintenance API provides a centralized view of planned disruptive maintenance events across supported Google Cloud products. It offers users visibility into upcoming, ongoing, and completed maintenance, along with controls to manage certain maintenance activities, such as maintenance windows, rescheduling, and on-demand updates.", "version": "v1beta", "schemas": { "Maintenance": { "type": "object", "description": "Maintenance is the maintenance details of a resource's maintenance.", "id": "Maintenance", "properties": { "maintenanceName": { "type": "string", "description": "Maintenance is the name of the corresponding maintenance resource following the standard naming scheme: `\"{maintenance-id}\"`" }, "category": { "type": "string", "enum": [ "MAINTENANCE_CATEGORY_UNSPECIFIED", "INFRASTRUCTURE", "SERVICE_UPDATE" ], "description": "Output only. The category of the maintenance.", "readOnly": true, "enumDescriptions": [ "Unspecified category.", "Infrastructure maintenance events are times that Google Cloud performs regular maintenance on network equipment e.g. Google Cloud Interconnect These events are usually scheduled in advance and we provide notification, when possible, so that users can plan for the infrastructure maintenance event and prevent downtime. Infrastructure maintenance events don't have a set interval between occurrences, but generally occur several times a year.", "Updates that can include bug fixes, changes, or new features that are backward compatible with existing versions (including patches). Some SPs allow users to control the scheduling of these maintenance events using maintenance windows and/or deny maintenance features." ] }, "description": { "readOnly": true, "description": "Output only. The description of the maintenance.", "type": "string" }, "title": { "description": "Output only. The title of the maintenance.", "readOnly": true, "type": "string" } } }, "SummarizeMaintenancesResponse": { "type": "object", "description": "Request message for SummarizeMaintenances custom method.", "id": "SummarizeMaintenancesResponse", "properties": { "unreachable": { "items": { "type": "string" }, "type": "array", "description": "Unordered list. Locations that could not be reached." }, "maintenances": { "items": { "$ref": "MaintenanceSummary" }, "description": "The resulting summaries.", "type": "array" }, "nextPageToken": { "description": "If present, the next page token can be provided to a subsequent SummarizeMaintenances call to list the next page. If empty, there are no more pages.", "type": "string" } } }, "GoogleCloudLocationLocation": { "description": "A resource that represents a Google Cloud location.", "id": "GoogleCloudLocationLocation", "properties": { "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "metadata": { "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "locationId": { "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "labels": { "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object" }, "Stats": { "id": "Stats", "description": "Stats indicates the type of aggregate and the corresponding aggregates.", "type": "object", "properties": { "groupBy": { "description": "groupBy specifies the type of aggregate. For example a group_by might be `\"state\"`", "type": "string" }, "aggregates": { "items": { "$ref": "Aggregate" }, "description": "Aggregates is a list pairs. For example, if the group_by is `\"state\"` a possible tuple in the aggregates list could be \"SCHEDULED\" : `11`,", "type": "array" } } }, "MaintenanceControl": { "properties": { "documentation": { "description": "Link to Service Producer documentation about maintenance control. Provided only when `isCustom` is `true`.", "type": "string" }, "isCustom": { "description": "Indicates whether the control is available only in Service Producer API (not through Unified Maintenance).", "type": "boolean" }, "control": { "enum": [ "CONTROL_UNSPECIFIED", "APPLY", "MANAGE_POLICY", "RESCHEDULE" ], "description": "The control of the resource maintenance.", "enumDescriptions": [ "Unspecified control.", "Apply control.", "Manage policy control.", "Reschedule control." ], "type": "string" } }, "description": "The control of the maintenance.", "type": "object", "id": "MaintenanceControl" }, "ListResourceMaintenancesResponse": { "id": "ListResourceMaintenancesResponse", "description": "The response structure for the ListResourceMaintenances method.", "type": "object", "properties": { "resourceMaintenances": { "type": "array", "description": "The resulting resource maintenances.", "items": { "$ref": "ResourceMaintenance" } }, "nextPageToken": { "type": "string", "description": "If present, the next page token can be provided to a subsequent ListResourceMaintenances call to list the next page. If empty, there are no more pages." }, "unreachable": { "items": { "type": "string" }, "description": "Locations that could not be reached.", "type": "array" } } }, "Aggregate": { "properties": { "group": { "type": "string", "description": "Specifies what specific value of the group_by the count represents. For example if group_by is `\"state\"` its corresponding group could be `\"SCHEDULED\"`." }, "count": { "format": "int64", "type": "string", "description": "The count of the group." } }, "id": "Aggregate", "description": "Aggregate is a pair.", "type": "object" }, "ResourceMaintenance": { "id": "ResourceMaintenance", "properties": { "updateTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. The update time of the resource maintenance." }, "labels": { "additionalProperties": { "type": "string" }, "description": "Optional. The labels on the resource, which can be used for categorization. similar to Kubernetes resource labels.", "type": "object" }, "maintenance": { "$ref": "Maintenance", "description": "Output only. The details of the maintenance.", "readOnly": true }, "uid": { "readOnly": true, "type": "string", "description": "Output only. The unique identifier of the resource. UID is unique in the time and space for this resource within the scope of the service. It is typically generated by the server on successful creation of a resource and must not be changed. UID is used to uniquely identify resources with resource name reuses. This should be a UUID4." }, "userControllable": { "type": "boolean", "readOnly": true, "description": "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)" }, "createTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. The create time of the resource maintenance." }, "state": { "type": "string", "enumDescriptions": [ "Unspecified state.", "Scheduled for a particular window. For disruptive maintenance it should respect maintenance policy, i.e. its available windows, exclusions and notification period.", "Maintenance is ongoing.", "No longer planned, typically when other maintenance (e.g. upgrade to newer version) already happened, or the user skipped the maintenance.", "Successfully completed." ], "description": "Output only. The state of the resource maintenance.", "readOnly": true, "enum": [ "STATE_UNSPECIFIED", "SCHEDULED", "RUNNING", "CANCELLED", "SUCCEEDED" ] }, "maintenanceStartTime": { "readOnly": true, "description": "Output only. The time when the resource maintenance has started.", "type": "string", "format": "google-datetime" }, "maintenanceScheduledStartTime": { "format": "google-datetime", "description": "Output only. The time when the maintenance on the resource was scheduled to start.", "readOnly": true, "type": "string" }, "annotations": { "description": "Optional. Annotations is an unstructured key-value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/user-guide/annotations", "additionalProperties": { "type": "string" }, "type": "object" }, "maintenanceCancelTime": { "description": "Output only. The time when the resource maintenance was cancelled.", "type": "string", "format": "google-datetime", "readOnly": true }, "etag": { "description": "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.", "type": "string", "readOnly": true }, "maintenanceScheduledEndTime": { "readOnly": true, "format": "google-datetime", "description": "Output only. The time when the maintenance on the resource was scheduled to end.", "type": "string" }, "resource": { "readOnly": true, "$ref": "Resource", "description": "Output only. The resource spec of the resource maintenance." }, "name": { "description": "Identifier. The name of the resource_maintenance resource. Format: `\"projects/{project}/locations/{location}/resourceMaintenance/{resource-maintenance-id}\"`", "type": "string" }, "maintenanceEndTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. The time when the resource maintenance has completed." }, "controls": { "items": { "$ref": "MaintenanceControl" }, "description": "Output only. The controls of the maintenance.", "type": "array", "readOnly": true } }, "description": "ResourceMaintenance is a resource that represents a maintenance operation on a resource.", "type": "object" }, "MaintenanceSummary": { "id": "MaintenanceSummary", "description": "MaintenanceSummary contains maintenance statistics calculated based on ResourceMaintenances within the scope: project and location.", "properties": { "maintenanceScheduledEndTime": { "format": "google-datetime", "description": "Output only. An estimated (best effort, not guaranteed) end time of the scheduled maintenance.", "readOnly": true, "type": "string" }, "userControllable": { "type": "boolean", "description": "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).", "readOnly": true }, "maintenanceScheduledStartTime": { "description": "Output only. Scheduled start time of the maintenance. The maintenance will start at `maintenanceScheduledStartTime` or later, with best effort to finish before `maintenanceScheduledEndTime`.", "type": "string", "format": "google-datetime", "readOnly": true }, "category": { "enum": [ "MAINTENANCE_CATEGORY_UNSPECIFIED", "INFRASTRUCTURE", "SERVICE_UPDATE" ], "enumDescriptions": [ "Unspecified category.", "Infrastructure maintenance events are times that Google Cloud performs regular maintenance on network equipment e.g. Google Cloud Interconnect These events are usually scheduled in advance and we provide notification, when possible, so that users can plan for the infrastructure maintenance event and prevent downtime. Infrastructure maintenance events don't have a set interval between occurrences, but generally occur several times a year.", "Updates that can include bug fixes, changes, or new features that are backward compatible with existing versions (including patches). Some SPs allow users to control the scheduling of these maintenance events using maintenance windows and/or deny maintenance features." ], "description": "Output only. The category of the maintenance event.", "readOnly": true, "type": "string" }, "maintenanceStartTime": { "readOnly": true, "type": "string", "format": "google-datetime", "description": "Output only. Actual date when the maintenance started. Field present only after the state changed to `RUNNING`." }, "stats": { "readOnly": true, "description": "Output only. Stats is a field of ResourceMaintenance used to aggregate the stats.", "items": { "$ref": "Stats" }, "type": "array" }, "description": { "type": "string", "readOnly": true, "description": "Output only. The description of the maintenance." }, "maintenanceName": { "readOnly": true, "description": "Output only. The name of the maintenance.", "type": "string" }, "title": { "readOnly": true, "description": "Output only. The title of the maintenance.", "type": "string" }, "maintenanceEndTime": { "type": "string", "readOnly": true, "description": "Output only. Actual date when the maintenance successfully completed. Field present only after the state changed to `SUCCEEDED`.", "format": "google-datetime" }, "controls": { "readOnly": true, "type": "array", "description": "Output only. Control available for that Maintenance (might not be available for every resource that maintenance is applied to).", "items": { "$ref": "MaintenanceControl" } } }, "type": "object" }, "Resource": { "type": "object", "properties": { "type": { "readOnly": true, "description": "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.", "type": "string" }, "resourceName": { "description": "Output only. Name is the reference to the consumer resource affected by the maintenance. Available values can be found here: https://cloud.google.com/asset-inventory/docs/asset-names", "readOnly": true, "type": "string" }, "location": { "type": "string", "description": "Output only. The location of the resource. Format: `us-central1`", "readOnly": true } }, "id": "Resource", "description": "Resource contains information about the resource affected by maintenance." }, "ListLocationsResponse": { "id": "ListLocationsResponse", "type": "object", "description": "The response message for Locations.ListLocations.", "properties": { "nextPageToken": { "type": "string", "description": "The standard List next-page token." }, "locations": { "description": "A list of locations that matches the specified filter in the request.", "items": { "$ref": "GoogleCloudLocationLocation" }, "type": "array" } } } }, "kind": "discovery#restDescription", "ownerDomain": "google.com", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/maintenance.readonly": { "description": "See your Google Cloud Unified Maintenance data and the email address of your Google Account" }, "https://www.googleapis.com/auth/maintenance.read-write": { "description": "See, edit, configure, and delete your Google Cloud Unified Maintenance data and see the email address for your Google Account" }, "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "revision": "20261014", "parameters": { "upload_protocol": { "type": "string", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query" }, "alt": { "location": "query", "type": "string", "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "description": "Data format for response.", "enum": [ "json", "media", "proto" ] }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", "type": "string" }, "$.xgafv": { "enum": [ "1", "2" ], "description": "V1 error format.", "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "type": "string" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, "key": { "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "location": "query", "type": "string" }, "uploadType": { "type": "string", "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "callback": { "type": "string", "description": "JSONP", "location": "query" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "default": "true", "type": "boolean", "location": "query" }, "quotaUser": { "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query", "type": "string" }, "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" } }, "rootUrl": "https://maintenance.googleapis.com/", "mtlsRootUrl": "https://maintenance.mtls.googleapis.com/", "documentationLink": "https://cloud.google.com/unified-maintenance/docs/overview", "title": "Maintenance API", "id": "maintenance:v1beta", "protocol": "rest", "version_module": true, "batchPath": "batch", "resources": { "projects": { "resources": { "locations": { "resources": { "resourceMaintenances": { "methods": { "get": { "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/resourceMaintenances/{resourceMaintenancesId}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/maintenance.read-write", "https://www.googleapis.com/auth/maintenance.readonly" ], "response": { "$ref": "ResourceMaintenance" }, "id": "maintenance.projects.locations.resourceMaintenances.get", "path": "v1beta/{+name}", "parameters": { "name": { "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/resourceMaintenances/[^/]+$", "location": "path", "required": true, "description": "Required. The resource name of the resource within a service." } }, "description": "Retrieve a single resource maintenance.", "httpMethod": "GET" }, "summarize": { "response": { "$ref": "SummarizeMaintenancesResponse" }, "id": "maintenance.projects.locations.resourceMaintenances.summarize", "parameters": { "pageSize": { "location": "query", "description": "The maximum number of resource maintenances to send per page. The default page size is 20 and the maximum is 1000.", "type": "integer", "format": "int32" }, "pageToken": { "description": "The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page.", "location": "query", "type": "string" }, "parent": { "type": "string", "description": "Required. The parent of the resource maintenance. eg. `projects/123/locations/*`", "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "required": true }, "orderBy": { "description": "Order results as specified in https://google.aip.dev/132.", "location": "query", "type": "string" }, "filter": { "type": "string", "description": "Filter the list as specified in https://google.aip.dev/160. Supported fields include: - `maintenance.maintenanceName` Examples: - `maintenance.maintenanceName=\"eb3b709c-9ca1-5472-9fb6-800a3849eda1\"`", "location": "query" } }, "path": "v1beta/{+parent}/resourceMaintenances:summarize", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/maintenance.read-write", "https://www.googleapis.com/auth/maintenance.readonly" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/resourceMaintenances:summarize", "description": "Retrieves the statistics of a specific maintenance.", "httpMethod": "GET", "parameterOrder": [ "parent" ] }, "list": { "id": "maintenance.projects.locations.resourceMaintenances.list", "description": "Retrieve a collection of resource maintenances.", "path": "v1beta/{+parent}/resourceMaintenances", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/maintenance.read-write", "https://www.googleapis.com/auth/maintenance.readonly" ], "parameters": { "pageToken": { "type": "string", "location": "query", "description": "The page token: If the next_page_token from a previous response is provided, this request will send the subsequent page." }, "parent": { "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "type": "string", "description": "Required. The parent of the resource maintenance." }, "orderBy": { "location": "query", "type": "string", "description": "Order results as specified in https://google.aip.dev/132." }, "pageSize": { "location": "query", "type": "integer", "format": "int32", "description": "The maximum number of resource maintenances to send per page." }, "filter": { "description": "Filter the list as specified in https://google.aip.dev/160.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/resourceMaintenances", "response": { "$ref": "ListResourceMaintenancesResponse" } } } } }, "methods": { "list": { "id": "maintenance.projects.locations.list", "parameters": { "filter": { "location": "query", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "type": "string" }, "pageSize": { "location": "query", "format": "int32", "description": "The maximum number of results to return. If not set, the service selects a default.", "type": "integer" }, "name": { "description": "The resource that owns the locations collection, if applicable.", "location": "path", "pattern": "^projects/[^/]+$", "type": "string", "required": true }, "pageToken": { "type": "string", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", "location": "query" }, "extraLocationTypes": { "repeated": true, "type": "string", "location": "query", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage." } }, "response": { "$ref": "ListLocationsResponse" }, "flatPath": "v1beta/projects/{projectsId}/locations", "path": "v1beta/{+name}/locations", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/maintenance.read-write", "https://www.googleapis.com/auth/maintenance.readonly" ], "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "httpMethod": "GET" }, "get": { "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/maintenance.read-write", "https://www.googleapis.com/auth/maintenance.readonly" ], "description": "Gets information about a location.", "parameters": { "name": { "location": "path", "type": "string", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Resource name for the location." } }, "response": { "$ref": "GoogleCloudLocationLocation" }, "path": "v1beta/{+name}", "httpMethod": "GET", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}", "id": "maintenance.projects.locations.get" } } } } } }, "canonicalName": "Maintenance" }