Reference documentation and code samples for the Compute V1 Client class InterconnectOutageNotification.
Description of a planned outage on this Interconnect.
Generated from protobuf message google.cloud.compute.v1.InterconnectOutageNotification
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ affected_circuits |
array
If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected. |
↳ description |
string
A description about the purpose of the outage. |
↳ end_time |
int|string
Scheduled end time for the outage (milliseconds since Unix epoch). |
↳ issue_type |
string
Form this outage is expected to take, which can take one of the following values: - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values. Check the IssueType enum for the list of possible values. |
↳ name |
string
Unique identifier for this outage notification. |
↳ source |
string
The party that generated this notification, which can take the following value: - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE. Check the Source enum for the list of possible values. |
↳ start_time |
int|string
Scheduled start time for the outage (milliseconds since Unix epoch). |
↳ state |
string
State of this notification, which can take one of the following values: - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. - COMPLETED: The outage associated with this notification is complete. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values. Check the State enum for the list of possible values. |
getAffectedCircuits
If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setAffectedCircuits
If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
A description about the purpose of the outage.
| Returns | |
|---|---|
| Type | Description |
string | |
hasDescription
clearDescription
setDescription
A description about the purpose of the outage.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndTime
Scheduled end time for the outage (milliseconds since Unix epoch).
| Returns | |
|---|---|
| Type | Description |
int|string | |
hasEndTime
clearEndTime
setEndTime
Scheduled end time for the outage (milliseconds since Unix epoch).
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIssueType
Form this outage is expected to take, which can take one of the following values: - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values.
Check the IssueType enum for the list of possible values.
| Returns | |
|---|---|
| Type | Description |
string | |
hasIssueType
clearIssueType
setIssueType
Form this outage is expected to take, which can take one of the following values: - OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated in favor of the unprefixed values.
Check the IssueType enum for the list of possible values.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getName
Unique identifier for this outage notification.
| Returns | |
|---|---|
| Type | Description |
string | |
hasName
clearName
setName
Unique identifier for this outage notification.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSource
The party that generated this notification, which can take the following value: - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.
Check the Source enum for the list of possible values.
| Returns | |
|---|---|
| Type | Description |
string | |
hasSource
clearSource
setSource
The party that generated this notification, which can take the following value: - GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.
Check the Source enum for the list of possible values.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStartTime
Scheduled start time for the outage (milliseconds since Unix epoch).
| Returns | |
|---|---|
| Type | Description |
int|string | |
hasStartTime
clearStartTime
setStartTime
Scheduled start time for the outage (milliseconds since Unix epoch).
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
State of this notification, which can take one of the following values: - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. - COMPLETED: The outage associated with this notification is complete. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values.
Check the State enum for the list of possible values.
| Returns | |
|---|---|
| Type | Description |
string | |
hasState
clearState
setState
State of this notification, which can take one of the following values: - ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. - CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. - COMPLETED: The outage associated with this notification is complete. Note that the versions of this enum prefixed with "NS_" have been deprecated in favor of the unprefixed values.
Check the State enum for the list of possible values.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |