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/bigquery/reservation/v1/reservation.proto 18 19 package com.google.cloud.bigquery.reservation.v1; 20 21 public interface CapacityCommitmentOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.bigquery.reservation.v1.CapacityCommitment) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Output only. The resource name of the capacity commitment, e.g., 31 * `projects/myproject/locations/US/capacityCommitments/123` 32 * The commitment_id must only contain lower case alphanumeric characters or 33 * dashes. It must start with a letter and must not end 34 * with a dash. Its maximum length is 64 characters. 35 * </pre> 36 * 37 * <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 38 * 39 * @return The name. 40 */ getName()41 java.lang.String getName(); 42 /** 43 * 44 * 45 * <pre> 46 * Output only. The resource name of the capacity commitment, e.g., 47 * `projects/myproject/locations/US/capacityCommitments/123` 48 * The commitment_id must only contain lower case alphanumeric characters or 49 * dashes. It must start with a letter and must not end 50 * with a dash. Its maximum length is 64 characters. 51 * </pre> 52 * 53 * <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 54 * 55 * @return The bytes for name. 56 */ getNameBytes()57 com.google.protobuf.ByteString getNameBytes(); 58 59 /** 60 * 61 * 62 * <pre> 63 * Number of slots in this commitment. 64 * </pre> 65 * 66 * <code>int64 slot_count = 2;</code> 67 * 68 * @return The slotCount. 69 */ getSlotCount()70 long getSlotCount(); 71 72 /** 73 * 74 * 75 * <pre> 76 * Capacity commitment commitment plan. 77 * </pre> 78 * 79 * <code>.google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan plan = 3;</code> 80 * 81 * @return The enum numeric value on the wire for plan. 82 */ getPlanValue()83 int getPlanValue(); 84 /** 85 * 86 * 87 * <pre> 88 * Capacity commitment commitment plan. 89 * </pre> 90 * 91 * <code>.google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan plan = 3;</code> 92 * 93 * @return The plan. 94 */ getPlan()95 com.google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan getPlan(); 96 97 /** 98 * 99 * 100 * <pre> 101 * Output only. State of the commitment. 102 * </pre> 103 * 104 * <code> 105 * .google.cloud.bigquery.reservation.v1.CapacityCommitment.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; 106 * </code> 107 * 108 * @return The enum numeric value on the wire for state. 109 */ getStateValue()110 int getStateValue(); 111 /** 112 * 113 * 114 * <pre> 115 * Output only. State of the commitment. 116 * </pre> 117 * 118 * <code> 119 * .google.cloud.bigquery.reservation.v1.CapacityCommitment.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY]; 120 * </code> 121 * 122 * @return The state. 123 */ getState()124 com.google.cloud.bigquery.reservation.v1.CapacityCommitment.State getState(); 125 126 /** 127 * 128 * 129 * <pre> 130 * Output only. The start of the current commitment period. It is applicable 131 * only for ACTIVE capacity commitments. 132 * </pre> 133 * 134 * <code> 135 * .google.protobuf.Timestamp commitment_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; 136 * </code> 137 * 138 * @return Whether the commitmentStartTime field is set. 139 */ hasCommitmentStartTime()140 boolean hasCommitmentStartTime(); 141 /** 142 * 143 * 144 * <pre> 145 * Output only. The start of the current commitment period. It is applicable 146 * only for ACTIVE capacity commitments. 147 * </pre> 148 * 149 * <code> 150 * .google.protobuf.Timestamp commitment_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; 151 * </code> 152 * 153 * @return The commitmentStartTime. 154 */ getCommitmentStartTime()155 com.google.protobuf.Timestamp getCommitmentStartTime(); 156 /** 157 * 158 * 159 * <pre> 160 * Output only. The start of the current commitment period. It is applicable 161 * only for ACTIVE capacity commitments. 162 * </pre> 163 * 164 * <code> 165 * .google.protobuf.Timestamp commitment_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY]; 166 * </code> 167 */ getCommitmentStartTimeOrBuilder()168 com.google.protobuf.TimestampOrBuilder getCommitmentStartTimeOrBuilder(); 169 170 /** 171 * 172 * 173 * <pre> 174 * Output only. The end of the current commitment period. It is applicable 175 * only for ACTIVE capacity commitments. 176 * </pre> 177 * 178 * <code> 179 * .google.protobuf.Timestamp commitment_end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; 180 * </code> 181 * 182 * @return Whether the commitmentEndTime field is set. 183 */ hasCommitmentEndTime()184 boolean hasCommitmentEndTime(); 185 /** 186 * 187 * 188 * <pre> 189 * Output only. The end of the current commitment period. It is applicable 190 * only for ACTIVE capacity commitments. 191 * </pre> 192 * 193 * <code> 194 * .google.protobuf.Timestamp commitment_end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; 195 * </code> 196 * 197 * @return The commitmentEndTime. 198 */ getCommitmentEndTime()199 com.google.protobuf.Timestamp getCommitmentEndTime(); 200 /** 201 * 202 * 203 * <pre> 204 * Output only. The end of the current commitment period. It is applicable 205 * only for ACTIVE capacity commitments. 206 * </pre> 207 * 208 * <code> 209 * .google.protobuf.Timestamp commitment_end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY]; 210 * </code> 211 */ getCommitmentEndTimeOrBuilder()212 com.google.protobuf.TimestampOrBuilder getCommitmentEndTimeOrBuilder(); 213 214 /** 215 * 216 * 217 * <pre> 218 * Output only. For FAILED commitment plan, provides the reason of failure. 219 * </pre> 220 * 221 * <code>.google.rpc.Status failure_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; 222 * </code> 223 * 224 * @return Whether the failureStatus field is set. 225 */ hasFailureStatus()226 boolean hasFailureStatus(); 227 /** 228 * 229 * 230 * <pre> 231 * Output only. For FAILED commitment plan, provides the reason of failure. 232 * </pre> 233 * 234 * <code>.google.rpc.Status failure_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; 235 * </code> 236 * 237 * @return The failureStatus. 238 */ getFailureStatus()239 com.google.rpc.Status getFailureStatus(); 240 /** 241 * 242 * 243 * <pre> 244 * Output only. For FAILED commitment plan, provides the reason of failure. 245 * </pre> 246 * 247 * <code>.google.rpc.Status failure_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY]; 248 * </code> 249 */ getFailureStatusOrBuilder()250 com.google.rpc.StatusOrBuilder getFailureStatusOrBuilder(); 251 252 /** 253 * 254 * 255 * <pre> 256 * The plan this capacity commitment is converted to after commitment_end_time 257 * passes. Once the plan is changed, committed period is extended according to 258 * commitment plan. Only applicable for ANNUAL and TRIAL commitments. 259 * </pre> 260 * 261 * <code>.google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan renewal_plan = 8; 262 * </code> 263 * 264 * @return The enum numeric value on the wire for renewalPlan. 265 */ getRenewalPlanValue()266 int getRenewalPlanValue(); 267 /** 268 * 269 * 270 * <pre> 271 * The plan this capacity commitment is converted to after commitment_end_time 272 * passes. Once the plan is changed, committed period is extended according to 273 * commitment plan. Only applicable for ANNUAL and TRIAL commitments. 274 * </pre> 275 * 276 * <code>.google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan renewal_plan = 8; 277 * </code> 278 * 279 * @return The renewalPlan. 280 */ getRenewalPlan()281 com.google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan getRenewalPlan(); 282 283 /** 284 * 285 * 286 * <pre> 287 * Applicable only for commitments located within one of the BigQuery 288 * multi-regions (US or EU). 289 * If set to true, this commitment is placed in the organization's 290 * secondary region which is designated for disaster recovery purposes. 291 * If false, this commitment is placed in the organization's default region. 292 * NOTE: this is a preview feature. Project must be allow-listed in order to 293 * set this field. 294 * </pre> 295 * 296 * <code>bool multi_region_auxiliary = 10;</code> 297 * 298 * @return The multiRegionAuxiliary. 299 */ getMultiRegionAuxiliary()300 boolean getMultiRegionAuxiliary(); 301 302 /** 303 * 304 * 305 * <pre> 306 * Edition of the capacity commitment. 307 * </pre> 308 * 309 * <code>.google.cloud.bigquery.reservation.v1.Edition edition = 12;</code> 310 * 311 * @return The enum numeric value on the wire for edition. 312 */ getEditionValue()313 int getEditionValue(); 314 /** 315 * 316 * 317 * <pre> 318 * Edition of the capacity commitment. 319 * </pre> 320 * 321 * <code>.google.cloud.bigquery.reservation.v1.Edition edition = 12;</code> 322 * 323 * @return The edition. 324 */ getEdition()325 com.google.cloud.bigquery.reservation.v1.Edition getEdition(); 326 } 327