Reference documentation and code samples for the Google Cloud Maintenance Api V1beta Client class MaintenanceSummary.
MaintenanceSummary contains maintenance statistics calculated based on ResourceMaintenances within the scope: project and location.
Generated from protobuf message google.cloud.maintenance.api.v1beta.MaintenanceSummary
Namespace
Google \ Cloud \ Maintenance \ Api \ V1betaMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ maintenance_name
string
Output only. The name of the maintenance.
↳ title
string
Output only. The title of the maintenance.
↳ description
string
Output only. The description of the maintenance.
↳ category
int
Output only. The category of the maintenance event.
↳ maintenance_scheduled_start_time
Google\Protobuf\Timestamp
Output only. Scheduled start time of the maintenance. The maintenance will start at maintenanceScheduledStartTime
or later, with best effort to finish before maintenanceScheduledEndTime
.
↳ maintenance_scheduled_end_time
Google\Protobuf\Timestamp
Output only. An estimated (best effort, not guaranteed) end time of the scheduled maintenance.
↳ maintenance_start_time
Google\Protobuf\Timestamp
Output only. Actual date when the maintenance started. Field present only after the state changed to RUNNING
.
↳ maintenance_end_time
Google\Protobuf\Timestamp
Output only. Actual date when the maintenance successfully completed. Field present only after the state changed to SUCCEEDED
.
↳ user_controllable
bool
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
array< MaintenanceControl
>
Output only. Control available for that Maintenance (might not be available for every resource that maintenance is applied to).
↳ stats
array< MaintenanceSummary\Stats
>
Output only. Stats is a field of ResourceMaintenance used to aggregate the stats.
getMaintenanceName
Output only. The name of the maintenance.
string
setMaintenanceName
Output only. The name of the maintenance.
var
string
$this
getTitle
Output only. The title of the maintenance.
string
setTitle
Output only. The title of the maintenance.
var
string
$this
getDescription
Output only. The description of the maintenance.
string
setDescription
Output only. The description of the maintenance.
var
string
$this
getCategory
Output only. The category of the maintenance event.
int
setCategory
Output only. The category of the maintenance event.
var
int
$this
getMaintenanceScheduledStartTime
Output only. Scheduled start time of the maintenance. The maintenance will
start at maintenanceScheduledStartTime
or later, with best effort to
finish before maintenanceScheduledEndTime
.
hasMaintenanceScheduledStartTime
clearMaintenanceScheduledStartTime
setMaintenanceScheduledStartTime
Output only. Scheduled start time of the maintenance. The maintenance will
start at maintenanceScheduledStartTime
or later, with best effort to
finish before maintenanceScheduledEndTime
.
$this
getMaintenanceScheduledEndTime
Output only. An estimated (best effort, not guaranteed) end time of the scheduled maintenance.
hasMaintenanceScheduledEndTime
clearMaintenanceScheduledEndTime
setMaintenanceScheduledEndTime
Output only. An estimated (best effort, not guaranteed) end time of the scheduled maintenance.
$this
getMaintenanceStartTime
Output only. Actual date when the maintenance started. Field present only
after the state changed to RUNNING
.
hasMaintenanceStartTime
clearMaintenanceStartTime
setMaintenanceStartTime
Output only. Actual date when the maintenance started. Field present only
after the state changed to RUNNING
.
$this
getMaintenanceEndTime
Output only. Actual date when the maintenance successfully completed. Field
present only after the state changed to SUCCEEDED
.
hasMaintenanceEndTime
clearMaintenanceEndTime
setMaintenanceEndTime
Output only. Actual date when the maintenance successfully completed. Field
present only after the state changed to SUCCEEDED
.
$this
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
setUserControllable
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).
var
bool
$this
getControls
Output only. Control available for that Maintenance (might not be available for every resource that maintenance is applied to).
setControls
Output only. Control available for that Maintenance (might not be available for every resource that maintenance is applied to).
$this
getStats
Output only. Stats is a field of ResourceMaintenance used to aggregate the stats.
setStats
Output only. Stats is a field of ResourceMaintenance used to aggregate the stats.
$this
