Reference documentation and code samples for the Compute V1 Client class InterconnectOutageNotification.
Description of a planned outage on this Interconnect.
Generated from protobuf messagegoogle.cloud.compute.v1.InterconnectOutageNotification
Namespace
Google \ Cloud \ Compute \ V1
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Compute V1 Client - Class InterconnectOutageNotification (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.InterconnectOutageNotification)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.InterconnectOutageNotification)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.InterconnectOutageNotification)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.InterconnectOutageNotification)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.InterconnectOutageNotification)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.InterconnectOutageNotification)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.InterconnectOutageNotification)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.InterconnectOutageNotification)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.InterconnectOutageNotification)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.InterconnectOutageNotification)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.InterconnectOutageNotification)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.InterconnectOutageNotification)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.InterconnectOutageNotification)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.InterconnectOutageNotification)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.InterconnectOutageNotification)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.InterconnectOutageNotification)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.InterconnectOutageNotification)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.InterconnectOutageNotification)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.InterconnectOutageNotification)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.InterconnectOutageNotification)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.InterconnectOutageNotification)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.InterconnectOutageNotification)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.InterconnectOutageNotification)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.InterconnectOutageNotification)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.InterconnectOutageNotification)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.InterconnectOutageNotification)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.InterconnectOutageNotification)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.InterconnectOutageNotification)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.InterconnectOutageNotification)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.InterconnectOutageNotification) \nReference documentation and code samples for the Compute V1 Client class InterconnectOutageNotification.\n\nDescription of a planned outage on this Interconnect.\n\nGenerated from protobuf message `google.cloud.compute.v1.InterconnectOutageNotification`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getAffectedCircuits\n\nIf issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.\n\n### setAffectedCircuits\n\nIf issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.\n\n### getDescription\n\nA description about the purpose of the outage.\n\n### hasDescription\n\n### clearDescription\n\n### setDescription\n\nA description about the purpose of the outage.\n\n### getEndTime\n\nScheduled end time for the outage (milliseconds since Unix epoch).\n\n### hasEndTime\n\n### clearEndTime\n\n### setEndTime\n\nScheduled end time for the outage (milliseconds since Unix epoch).\n\n### getIssueType\n\nForm 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.\n\nCheck the IssueType enum for the list of possible values.\n\n### hasIssueType\n\n### clearIssueType\n\n### setIssueType\n\nForm 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.\n\nCheck the IssueType enum for the list of possible values.\n\n### getName\n\nUnique identifier for this outage notification.\n\n### hasName\n\n### clearName\n\n### setName\n\nUnique identifier for this outage notification.\n\n### getSource\n\nThe 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.\n\nCheck the Source enum for the list of possible values.\n\n### hasSource\n\n### clearSource\n\n### setSource\n\nThe 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.\n\nCheck the Source enum for the list of possible values.\n\n### getStartTime\n\nScheduled start time for the outage (milliseconds since Unix epoch).\n\n### hasStartTime\n\n### clearStartTime\n\n### setStartTime\n\nScheduled start time for the outage (milliseconds since Unix epoch).\n\n### getState\n\nState 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.\n\nCheck the State enum for the list of possible values.\n\n### hasState\n\n### clearState\n\n### setState\n\nState 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.\n\nCheck the State enum for the list of possible values."]]
