/clients/google-api-services-compute/alpha/1.30.1/com/google/api/services/compute/model/InterconnectOutageNotification.java

https://github.com/googleapis/google-api-java-client-services · Java · 267 lines · 84 code · 29 blank · 154 comment · 0 complexity · c2e31802ceabfc303d9a16b975eb2106 MD5 · raw file

  1. /*
  2. * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
  3. * in compliance with the License. You may obtain a copy of the License at
  4. *
  5. * http://www.apache.org/licenses/LICENSE-2.0
  6. *
  7. * Unless required by applicable law or agreed to in writing, software distributed under the License
  8. * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
  9. * or implied. See the License for the specific language governing permissions and limitations under
  10. * the License.
  11. */
  12. /*
  13. * This code was generated by https://github.com/googleapis/google-api-java-client-services/
  14. * Modify at your own risk.
  15. */
  16. package com.google.api.services.compute.model;
  17. /**
  18. * Description of a planned outage on this Interconnect.
  19. *
  20. * <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is
  21. * transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see:
  22. * <a href="https://developers.google.com/api-client-library/java/google-http-java-client/json">https://developers.google.com/api-client-library/java/google-http-java-client/json</a>
  23. * </p>
  24. *
  25. * @author Google, Inc.
  26. */
  27. @SuppressWarnings("javadoc")
  28. public final class InterconnectOutageNotification extends com.google.api.client.json.GenericJson {
  29. /**
  30. * If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be
  31. * affected.
  32. * The value may be {@code null}.
  33. */
  34. @com.google.api.client.util.Key
  35. private java.util.List<java.lang.String> affectedCircuits;
  36. /**
  37. * A description about the purpose of the outage.
  38. * The value may be {@code null}.
  39. */
  40. @com.google.api.client.util.Key
  41. private java.lang.String description;
  42. /**
  43. * Scheduled end time for the outage (milliseconds since Unix epoch).
  44. * The value may be {@code null}.
  45. */
  46. @com.google.api.client.util.Key @com.google.api.client.json.JsonString
  47. private java.lang.Long endTime;
  48. /**
  49. * Form this outage is expected to take, which can take one of the following values: - OUTAGE: The
  50. * Interconnect may be completely out of service for some or all of the specified window. -
  51. * PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with
  52. * reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated
  53. * in favor of the unprefixed values.
  54. * The value may be {@code null}.
  55. */
  56. @com.google.api.client.util.Key
  57. private java.lang.String issueType;
  58. /**
  59. * Unique identifier for this outage notification.
  60. * The value may be {@code null}.
  61. */
  62. @com.google.api.client.util.Key
  63. private java.lang.String name;
  64. /**
  65. * The party that generated this notification, which can take the following value: - GOOGLE: this
  66. * notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in
  67. * favor of GOOGLE.
  68. * The value may be {@code null}.
  69. */
  70. @com.google.api.client.util.Key
  71. private java.lang.String source;
  72. /**
  73. * Scheduled start time for the outage (milliseconds since Unix epoch).
  74. * The value may be {@code null}.
  75. */
  76. @com.google.api.client.util.Key @com.google.api.client.json.JsonString
  77. private java.lang.Long startTime;
  78. /**
  79. * State of this notification, which can take one of the following values: - ACTIVE: This outage
  80. * notification is active. The event could be in the past, present, or future. See start_time and
  81. * end_time for scheduling. - CANCELLED: The outage associated with this notification was
  82. * cancelled before the outage was due to start. Note that the versions of this enum prefixed with
  83. * "NS_" have been deprecated in favor of the unprefixed values.
  84. * The value may be {@code null}.
  85. */
  86. @com.google.api.client.util.Key
  87. private java.lang.String state;
  88. /**
  89. * If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be
  90. * affected.
  91. * @return value or {@code null} for none
  92. */
  93. public java.util.List<java.lang.String> getAffectedCircuits() {
  94. return affectedCircuits;
  95. }
  96. /**
  97. * If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be
  98. * affected.
  99. * @param affectedCircuits affectedCircuits or {@code null} for none
  100. */
  101. public InterconnectOutageNotification setAffectedCircuits(java.util.List<java.lang.String> affectedCircuits) {
  102. this.affectedCircuits = affectedCircuits;
  103. return this;
  104. }
  105. /**
  106. * A description about the purpose of the outage.
  107. * @return value or {@code null} for none
  108. */
  109. public java.lang.String getDescription() {
  110. return description;
  111. }
  112. /**
  113. * A description about the purpose of the outage.
  114. * @param description description or {@code null} for none
  115. */
  116. public InterconnectOutageNotification setDescription(java.lang.String description) {
  117. this.description = description;
  118. return this;
  119. }
  120. /**
  121. * Scheduled end time for the outage (milliseconds since Unix epoch).
  122. * @return value or {@code null} for none
  123. */
  124. public java.lang.Long getEndTime() {
  125. return endTime;
  126. }
  127. /**
  128. * Scheduled end time for the outage (milliseconds since Unix epoch).
  129. * @param endTime endTime or {@code null} for none
  130. */
  131. public InterconnectOutageNotification setEndTime(java.lang.Long endTime) {
  132. this.endTime = endTime;
  133. return this;
  134. }
  135. /**
  136. * Form this outage is expected to take, which can take one of the following values: - OUTAGE: The
  137. * Interconnect may be completely out of service for some or all of the specified window. -
  138. * PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with
  139. * reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated
  140. * in favor of the unprefixed values.
  141. * @return value or {@code null} for none
  142. */
  143. public java.lang.String getIssueType() {
  144. return issueType;
  145. }
  146. /**
  147. * Form this outage is expected to take, which can take one of the following values: - OUTAGE: The
  148. * Interconnect may be completely out of service for some or all of the specified window. -
  149. * PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with
  150. * reduced bandwidth. Note that the versions of this enum prefixed with "IT_" have been deprecated
  151. * in favor of the unprefixed values.
  152. * @param issueType issueType or {@code null} for none
  153. */
  154. public InterconnectOutageNotification setIssueType(java.lang.String issueType) {
  155. this.issueType = issueType;
  156. return this;
  157. }
  158. /**
  159. * Unique identifier for this outage notification.
  160. * @return value or {@code null} for none
  161. */
  162. public java.lang.String getName() {
  163. return name;
  164. }
  165. /**
  166. * Unique identifier for this outage notification.
  167. * @param name name or {@code null} for none
  168. */
  169. public InterconnectOutageNotification setName(java.lang.String name) {
  170. this.name = name;
  171. return this;
  172. }
  173. /**
  174. * The party that generated this notification, which can take the following value: - GOOGLE: this
  175. * notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in
  176. * favor of GOOGLE.
  177. * @return value or {@code null} for none
  178. */
  179. public java.lang.String getSource() {
  180. return source;
  181. }
  182. /**
  183. * The party that generated this notification, which can take the following value: - GOOGLE: this
  184. * notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in
  185. * favor of GOOGLE.
  186. * @param source source or {@code null} for none
  187. */
  188. public InterconnectOutageNotification setSource(java.lang.String source) {
  189. this.source = source;
  190. return this;
  191. }
  192. /**
  193. * Scheduled start time for the outage (milliseconds since Unix epoch).
  194. * @return value or {@code null} for none
  195. */
  196. public java.lang.Long getStartTime() {
  197. return startTime;
  198. }
  199. /**
  200. * Scheduled start time for the outage (milliseconds since Unix epoch).
  201. * @param startTime startTime or {@code null} for none
  202. */
  203. public InterconnectOutageNotification setStartTime(java.lang.Long startTime) {
  204. this.startTime = startTime;
  205. return this;
  206. }
  207. /**
  208. * State of this notification, which can take one of the following values: - ACTIVE: This outage
  209. * notification is active. The event could be in the past, present, or future. See start_time and
  210. * end_time for scheduling. - CANCELLED: The outage associated with this notification was
  211. * cancelled before the outage was due to start. Note that the versions of this enum prefixed with
  212. * "NS_" have been deprecated in favor of the unprefixed values.
  213. * @return value or {@code null} for none
  214. */
  215. public java.lang.String getState() {
  216. return state;
  217. }
  218. /**
  219. * State of this notification, which can take one of the following values: - ACTIVE: This outage
  220. * notification is active. The event could be in the past, present, or future. See start_time and
  221. * end_time for scheduling. - CANCELLED: The outage associated with this notification was
  222. * cancelled before the outage was due to start. Note that the versions of this enum prefixed with
  223. * "NS_" have been deprecated in favor of the unprefixed values.
  224. * @param state state or {@code null} for none
  225. */
  226. public InterconnectOutageNotification setState(java.lang.String state) {
  227. this.state = state;
  228. return this;
  229. }
  230. @Override
  231. public InterconnectOutageNotification set(String fieldName, Object value) {
  232. return (InterconnectOutageNotification) super.set(fieldName, value);
  233. }
  234. @Override
  235. public InterconnectOutageNotification clone() {
  236. return (InterconnectOutageNotification) super.clone();
  237. }
  238. }