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.
| Parameters | |
|---|---|
| Name | Description |
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 |
↳ 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 |
↳ maintenance_end_time |
Google\Protobuf\Timestamp
Output only. Actual date when the maintenance successfully completed. Field present only after the state changed to |
↳ 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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setMaintenanceName
Output only. The name of the maintenance.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTitle
Output only. The title of the maintenance.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTitle
Output only. The title of the maintenance.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Output only. The description of the maintenance.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Output only. The description of the maintenance.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCategory
Output only. The category of the maintenance event.
| Returns | |
|---|---|
| Type | Description |
int |
|
setCategory
Output only. The category of the maintenance event.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaintenanceScheduledEndTime
Output only. An estimated (best effort, not guaranteed) end time of the scheduled maintenance.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasMaintenanceScheduledEndTime
clearMaintenanceScheduledEndTime
setMaintenanceScheduledEndTime
Output only. An estimated (best effort, not guaranteed) end time of the scheduled maintenance.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaintenanceStartTime
Output only. Actual date when the maintenance started. Field present only
after the state changed to RUNNING.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasMaintenanceStartTime
clearMaintenanceStartTime
setMaintenanceStartTime
Output only. Actual date when the maintenance started. Field present only
after the state changed to RUNNING.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaintenanceEndTime
Output only. Actual date when the maintenance successfully completed. Field
present only after the state changed to SUCCEEDED.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasMaintenanceEndTime
clearMaintenanceEndTime
setMaintenanceEndTime
Output only. Actual date when the maintenance successfully completed. Field
present only after the state changed to SUCCEEDED.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$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).
| Returns | |
|---|---|
| Type | Description |
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).
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getControls
Output only. Control available for that Maintenance (might not be available for every resource that maintenance is applied to).
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setControls
Output only. Control available for that Maintenance (might not be available for every resource that maintenance is applied to).
| Parameter | |
|---|---|
| Name | Description |
var |
array<MaintenanceControl>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStats
Output only. Stats is a field of ResourceMaintenance used to aggregate the stats.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setStats
Output only. Stats is a field of ResourceMaintenance used to aggregate the stats.
| Parameter | |
|---|---|
| Name | Description |
var |
array<MaintenanceSummary\Stats>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|