1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/aiplatform/v1/pipeline_state.proto 18 19 package com.google.cloud.aiplatform.v1; 20 21 /** 22 * 23 * 24 * <pre> 25 * Describes the state of a pipeline. 26 * </pre> 27 * 28 * Protobuf enum {@code google.cloud.aiplatform.v1.PipelineState} 29 */ 30 public enum PipelineState implements com.google.protobuf.ProtocolMessageEnum { 31 /** 32 * 33 * 34 * <pre> 35 * The pipeline state is unspecified. 36 * </pre> 37 * 38 * <code>PIPELINE_STATE_UNSPECIFIED = 0;</code> 39 */ 40 PIPELINE_STATE_UNSPECIFIED(0), 41 /** 42 * 43 * 44 * <pre> 45 * The pipeline has been created or resumed, and processing has not yet 46 * begun. 47 * </pre> 48 * 49 * <code>PIPELINE_STATE_QUEUED = 1;</code> 50 */ 51 PIPELINE_STATE_QUEUED(1), 52 /** 53 * 54 * 55 * <pre> 56 * The service is preparing to run the pipeline. 57 * </pre> 58 * 59 * <code>PIPELINE_STATE_PENDING = 2;</code> 60 */ 61 PIPELINE_STATE_PENDING(2), 62 /** 63 * 64 * 65 * <pre> 66 * The pipeline is in progress. 67 * </pre> 68 * 69 * <code>PIPELINE_STATE_RUNNING = 3;</code> 70 */ 71 PIPELINE_STATE_RUNNING(3), 72 /** 73 * 74 * 75 * <pre> 76 * The pipeline completed successfully. 77 * </pre> 78 * 79 * <code>PIPELINE_STATE_SUCCEEDED = 4;</code> 80 */ 81 PIPELINE_STATE_SUCCEEDED(4), 82 /** 83 * 84 * 85 * <pre> 86 * The pipeline failed. 87 * </pre> 88 * 89 * <code>PIPELINE_STATE_FAILED = 5;</code> 90 */ 91 PIPELINE_STATE_FAILED(5), 92 /** 93 * 94 * 95 * <pre> 96 * The pipeline is being cancelled. From this state, the pipeline may only go 97 * to either PIPELINE_STATE_SUCCEEDED, PIPELINE_STATE_FAILED or 98 * PIPELINE_STATE_CANCELLED. 99 * </pre> 100 * 101 * <code>PIPELINE_STATE_CANCELLING = 6;</code> 102 */ 103 PIPELINE_STATE_CANCELLING(6), 104 /** 105 * 106 * 107 * <pre> 108 * The pipeline has been cancelled. 109 * </pre> 110 * 111 * <code>PIPELINE_STATE_CANCELLED = 7;</code> 112 */ 113 PIPELINE_STATE_CANCELLED(7), 114 /** 115 * 116 * 117 * <pre> 118 * The pipeline has been stopped, and can be resumed. 119 * </pre> 120 * 121 * <code>PIPELINE_STATE_PAUSED = 8;</code> 122 */ 123 PIPELINE_STATE_PAUSED(8), 124 UNRECOGNIZED(-1), 125 ; 126 127 /** 128 * 129 * 130 * <pre> 131 * The pipeline state is unspecified. 132 * </pre> 133 * 134 * <code>PIPELINE_STATE_UNSPECIFIED = 0;</code> 135 */ 136 public static final int PIPELINE_STATE_UNSPECIFIED_VALUE = 0; 137 /** 138 * 139 * 140 * <pre> 141 * The pipeline has been created or resumed, and processing has not yet 142 * begun. 143 * </pre> 144 * 145 * <code>PIPELINE_STATE_QUEUED = 1;</code> 146 */ 147 public static final int PIPELINE_STATE_QUEUED_VALUE = 1; 148 /** 149 * 150 * 151 * <pre> 152 * The service is preparing to run the pipeline. 153 * </pre> 154 * 155 * <code>PIPELINE_STATE_PENDING = 2;</code> 156 */ 157 public static final int PIPELINE_STATE_PENDING_VALUE = 2; 158 /** 159 * 160 * 161 * <pre> 162 * The pipeline is in progress. 163 * </pre> 164 * 165 * <code>PIPELINE_STATE_RUNNING = 3;</code> 166 */ 167 public static final int PIPELINE_STATE_RUNNING_VALUE = 3; 168 /** 169 * 170 * 171 * <pre> 172 * The pipeline completed successfully. 173 * </pre> 174 * 175 * <code>PIPELINE_STATE_SUCCEEDED = 4;</code> 176 */ 177 public static final int PIPELINE_STATE_SUCCEEDED_VALUE = 4; 178 /** 179 * 180 * 181 * <pre> 182 * The pipeline failed. 183 * </pre> 184 * 185 * <code>PIPELINE_STATE_FAILED = 5;</code> 186 */ 187 public static final int PIPELINE_STATE_FAILED_VALUE = 5; 188 /** 189 * 190 * 191 * <pre> 192 * The pipeline is being cancelled. From this state, the pipeline may only go 193 * to either PIPELINE_STATE_SUCCEEDED, PIPELINE_STATE_FAILED or 194 * PIPELINE_STATE_CANCELLED. 195 * </pre> 196 * 197 * <code>PIPELINE_STATE_CANCELLING = 6;</code> 198 */ 199 public static final int PIPELINE_STATE_CANCELLING_VALUE = 6; 200 /** 201 * 202 * 203 * <pre> 204 * The pipeline has been cancelled. 205 * </pre> 206 * 207 * <code>PIPELINE_STATE_CANCELLED = 7;</code> 208 */ 209 public static final int PIPELINE_STATE_CANCELLED_VALUE = 7; 210 /** 211 * 212 * 213 * <pre> 214 * The pipeline has been stopped, and can be resumed. 215 * </pre> 216 * 217 * <code>PIPELINE_STATE_PAUSED = 8;</code> 218 */ 219 public static final int PIPELINE_STATE_PAUSED_VALUE = 8; 220 getNumber()221 public final int getNumber() { 222 if (this == UNRECOGNIZED) { 223 throw new java.lang.IllegalArgumentException( 224 "Can't get the number of an unknown enum value."); 225 } 226 return value; 227 } 228 229 /** 230 * @param value The numeric wire value of the corresponding enum entry. 231 * @return The enum associated with the given numeric wire value. 232 * @deprecated Use {@link #forNumber(int)} instead. 233 */ 234 @java.lang.Deprecated valueOf(int value)235 public static PipelineState valueOf(int value) { 236 return forNumber(value); 237 } 238 239 /** 240 * @param value The numeric wire value of the corresponding enum entry. 241 * @return The enum associated with the given numeric wire value. 242 */ forNumber(int value)243 public static PipelineState forNumber(int value) { 244 switch (value) { 245 case 0: 246 return PIPELINE_STATE_UNSPECIFIED; 247 case 1: 248 return PIPELINE_STATE_QUEUED; 249 case 2: 250 return PIPELINE_STATE_PENDING; 251 case 3: 252 return PIPELINE_STATE_RUNNING; 253 case 4: 254 return PIPELINE_STATE_SUCCEEDED; 255 case 5: 256 return PIPELINE_STATE_FAILED; 257 case 6: 258 return PIPELINE_STATE_CANCELLING; 259 case 7: 260 return PIPELINE_STATE_CANCELLED; 261 case 8: 262 return PIPELINE_STATE_PAUSED; 263 default: 264 return null; 265 } 266 } 267 internalGetValueMap()268 public static com.google.protobuf.Internal.EnumLiteMap<PipelineState> internalGetValueMap() { 269 return internalValueMap; 270 } 271 272 private static final com.google.protobuf.Internal.EnumLiteMap<PipelineState> internalValueMap = 273 new com.google.protobuf.Internal.EnumLiteMap<PipelineState>() { 274 public PipelineState findValueByNumber(int number) { 275 return PipelineState.forNumber(number); 276 } 277 }; 278 getValueDescriptor()279 public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor() { 280 if (this == UNRECOGNIZED) { 281 throw new java.lang.IllegalStateException( 282 "Can't get the descriptor of an unrecognized enum value."); 283 } 284 return getDescriptor().getValues().get(ordinal()); 285 } 286 getDescriptorForType()287 public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType() { 288 return getDescriptor(); 289 } 290 getDescriptor()291 public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor() { 292 return com.google.cloud.aiplatform.v1.PipelineStateProto.getDescriptor().getEnumTypes().get(0); 293 } 294 295 private static final PipelineState[] VALUES = values(); 296 valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)297 public static PipelineState valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) { 298 if (desc.getType() != getDescriptor()) { 299 throw new java.lang.IllegalArgumentException("EnumValueDescriptor is not for this type."); 300 } 301 if (desc.getIndex() == -1) { 302 return UNRECOGNIZED; 303 } 304 return VALUES[desc.getIndex()]; 305 } 306 307 private final int value; 308 PipelineState(int value)309 private PipelineState(int value) { 310 this.value = value; 311 } 312 313 // @@protoc_insertion_point(enum_scope:google.cloud.aiplatform.v1.PipelineState) 314 } 315