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/managedidentities/v1/resource.proto 18 19 package com.google.cloud.managedidentities.v1; 20 21 public interface DomainOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.managedidentities.v1.Domain) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required. The unique name of the domain using the form: 31 * `projects/{project_id}/locations/global/domains/{domain_name}`. 32 * </pre> 33 * 34 * <code>string name = 1 [(.google.api.field_behavior) = REQUIRED];</code> 35 * 36 * @return The name. 37 */ getName()38 java.lang.String getName(); 39 /** 40 * 41 * 42 * <pre> 43 * Required. The unique name of the domain using the form: 44 * `projects/{project_id}/locations/global/domains/{domain_name}`. 45 * </pre> 46 * 47 * <code>string name = 1 [(.google.api.field_behavior) = REQUIRED];</code> 48 * 49 * @return The bytes for name. 50 */ getNameBytes()51 com.google.protobuf.ByteString getNameBytes(); 52 53 /** 54 * 55 * 56 * <pre> 57 * Optional. Resource labels that can contain user-provided metadata. 58 * </pre> 59 * 60 * <code>map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];</code> 61 */ getLabelsCount()62 int getLabelsCount(); 63 /** 64 * 65 * 66 * <pre> 67 * Optional. Resource labels that can contain user-provided metadata. 68 * </pre> 69 * 70 * <code>map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];</code> 71 */ containsLabels(java.lang.String key)72 boolean containsLabels(java.lang.String key); 73 /** Use {@link #getLabelsMap()} instead. */ 74 @java.lang.Deprecated getLabels()75 java.util.Map<java.lang.String, java.lang.String> getLabels(); 76 /** 77 * 78 * 79 * <pre> 80 * Optional. Resource labels that can contain user-provided metadata. 81 * </pre> 82 * 83 * <code>map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];</code> 84 */ getLabelsMap()85 java.util.Map<java.lang.String, java.lang.String> getLabelsMap(); 86 /** 87 * 88 * 89 * <pre> 90 * Optional. Resource labels that can contain user-provided metadata. 91 * </pre> 92 * 93 * <code>map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];</code> 94 */ 95 /* nullable */ getLabelsOrDefault( java.lang.String key, java.lang.String defaultValue)96 java.lang.String getLabelsOrDefault( 97 java.lang.String key, 98 /* nullable */ 99 java.lang.String defaultValue); 100 /** 101 * 102 * 103 * <pre> 104 * Optional. Resource labels that can contain user-provided metadata. 105 * </pre> 106 * 107 * <code>map<string, string> labels = 2 [(.google.api.field_behavior) = OPTIONAL];</code> 108 */ getLabelsOrThrow(java.lang.String key)109 java.lang.String getLabelsOrThrow(java.lang.String key); 110 111 /** 112 * 113 * 114 * <pre> 115 * Optional. The full names of the Google Compute Engine 116 * [networks](/compute/docs/networks-and-firewalls#networks) the domain 117 * instance is connected to. Networks can be added using UpdateDomain. 118 * The domain is only available on networks listed in `authorized_networks`. 119 * If CIDR subnets overlap between networks, domain creation will fail. 120 * </pre> 121 * 122 * <code>repeated string authorized_networks = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 123 * 124 * @return A list containing the authorizedNetworks. 125 */ getAuthorizedNetworksList()126 java.util.List<java.lang.String> getAuthorizedNetworksList(); 127 /** 128 * 129 * 130 * <pre> 131 * Optional. The full names of the Google Compute Engine 132 * [networks](/compute/docs/networks-and-firewalls#networks) the domain 133 * instance is connected to. Networks can be added using UpdateDomain. 134 * The domain is only available on networks listed in `authorized_networks`. 135 * If CIDR subnets overlap between networks, domain creation will fail. 136 * </pre> 137 * 138 * <code>repeated string authorized_networks = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 139 * 140 * @return The count of authorizedNetworks. 141 */ getAuthorizedNetworksCount()142 int getAuthorizedNetworksCount(); 143 /** 144 * 145 * 146 * <pre> 147 * Optional. The full names of the Google Compute Engine 148 * [networks](/compute/docs/networks-and-firewalls#networks) the domain 149 * instance is connected to. Networks can be added using UpdateDomain. 150 * The domain is only available on networks listed in `authorized_networks`. 151 * If CIDR subnets overlap between networks, domain creation will fail. 152 * </pre> 153 * 154 * <code>repeated string authorized_networks = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 155 * 156 * @param index The index of the element to return. 157 * @return The authorizedNetworks at the given index. 158 */ getAuthorizedNetworks(int index)159 java.lang.String getAuthorizedNetworks(int index); 160 /** 161 * 162 * 163 * <pre> 164 * Optional. The full names of the Google Compute Engine 165 * [networks](/compute/docs/networks-and-firewalls#networks) the domain 166 * instance is connected to. Networks can be added using UpdateDomain. 167 * The domain is only available on networks listed in `authorized_networks`. 168 * If CIDR subnets overlap between networks, domain creation will fail. 169 * </pre> 170 * 171 * <code>repeated string authorized_networks = 3 [(.google.api.field_behavior) = OPTIONAL];</code> 172 * 173 * @param index The index of the value to return. 174 * @return The bytes of the authorizedNetworks at the given index. 175 */ getAuthorizedNetworksBytes(int index)176 com.google.protobuf.ByteString getAuthorizedNetworksBytes(int index); 177 178 /** 179 * 180 * 181 * <pre> 182 * Required. The CIDR range of internal addresses that are reserved for this 183 * domain. Reserved networks must be /24 or larger. Ranges must be 184 * unique and non-overlapping with existing subnets in 185 * [Domain].[authorized_networks]. 186 * </pre> 187 * 188 * <code>string reserved_ip_range = 4 [(.google.api.field_behavior) = REQUIRED];</code> 189 * 190 * @return The reservedIpRange. 191 */ getReservedIpRange()192 java.lang.String getReservedIpRange(); 193 /** 194 * 195 * 196 * <pre> 197 * Required. The CIDR range of internal addresses that are reserved for this 198 * domain. Reserved networks must be /24 or larger. Ranges must be 199 * unique and non-overlapping with existing subnets in 200 * [Domain].[authorized_networks]. 201 * </pre> 202 * 203 * <code>string reserved_ip_range = 4 [(.google.api.field_behavior) = REQUIRED];</code> 204 * 205 * @return The bytes for reservedIpRange. 206 */ getReservedIpRangeBytes()207 com.google.protobuf.ByteString getReservedIpRangeBytes(); 208 209 /** 210 * 211 * 212 * <pre> 213 * Required. Locations where domain needs to be provisioned. 214 * [regions][compute/docs/regions-zones/] 215 * e.g. us-west1 or us-east4 216 * Service supports up to 4 locations at once. Each location will use a /26 217 * block. 218 * </pre> 219 * 220 * <code>repeated string locations = 5 [(.google.api.field_behavior) = REQUIRED];</code> 221 * 222 * @return A list containing the locations. 223 */ getLocationsList()224 java.util.List<java.lang.String> getLocationsList(); 225 /** 226 * 227 * 228 * <pre> 229 * Required. Locations where domain needs to be provisioned. 230 * [regions][compute/docs/regions-zones/] 231 * e.g. us-west1 or us-east4 232 * Service supports up to 4 locations at once. Each location will use a /26 233 * block. 234 * </pre> 235 * 236 * <code>repeated string locations = 5 [(.google.api.field_behavior) = REQUIRED];</code> 237 * 238 * @return The count of locations. 239 */ getLocationsCount()240 int getLocationsCount(); 241 /** 242 * 243 * 244 * <pre> 245 * Required. Locations where domain needs to be provisioned. 246 * [regions][compute/docs/regions-zones/] 247 * e.g. us-west1 or us-east4 248 * Service supports up to 4 locations at once. Each location will use a /26 249 * block. 250 * </pre> 251 * 252 * <code>repeated string locations = 5 [(.google.api.field_behavior) = REQUIRED];</code> 253 * 254 * @param index The index of the element to return. 255 * @return The locations at the given index. 256 */ getLocations(int index)257 java.lang.String getLocations(int index); 258 /** 259 * 260 * 261 * <pre> 262 * Required. Locations where domain needs to be provisioned. 263 * [regions][compute/docs/regions-zones/] 264 * e.g. us-west1 or us-east4 265 * Service supports up to 4 locations at once. Each location will use a /26 266 * block. 267 * </pre> 268 * 269 * <code>repeated string locations = 5 [(.google.api.field_behavior) = REQUIRED];</code> 270 * 271 * @param index The index of the value to return. 272 * @return The bytes of the locations at the given index. 273 */ getLocationsBytes(int index)274 com.google.protobuf.ByteString getLocationsBytes(int index); 275 276 /** 277 * 278 * 279 * <pre> 280 * Optional. The name of delegated administrator account used to perform 281 * Active Directory operations. If not specified, `setupadmin` will be used. 282 * </pre> 283 * 284 * <code>string admin = 6 [(.google.api.field_behavior) = OPTIONAL];</code> 285 * 286 * @return The admin. 287 */ getAdmin()288 java.lang.String getAdmin(); 289 /** 290 * 291 * 292 * <pre> 293 * Optional. The name of delegated administrator account used to perform 294 * Active Directory operations. If not specified, `setupadmin` will be used. 295 * </pre> 296 * 297 * <code>string admin = 6 [(.google.api.field_behavior) = OPTIONAL];</code> 298 * 299 * @return The bytes for admin. 300 */ getAdminBytes()301 com.google.protobuf.ByteString getAdminBytes(); 302 303 /** 304 * 305 * 306 * <pre> 307 * Output only. The fully-qualified domain name of the exposed domain used by 308 * clients to connect to the service. Similar to what would be chosen for an 309 * Active Directory set up on an internal network. 310 * </pre> 311 * 312 * <code>string fqdn = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 313 * 314 * @return The fqdn. 315 */ getFqdn()316 java.lang.String getFqdn(); 317 /** 318 * 319 * 320 * <pre> 321 * Output only. The fully-qualified domain name of the exposed domain used by 322 * clients to connect to the service. Similar to what would be chosen for an 323 * Active Directory set up on an internal network. 324 * </pre> 325 * 326 * <code>string fqdn = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 327 * 328 * @return The bytes for fqdn. 329 */ getFqdnBytes()330 com.google.protobuf.ByteString getFqdnBytes(); 331 332 /** 333 * 334 * 335 * <pre> 336 * Output only. The time the instance was created. 337 * </pre> 338 * 339 * <code>.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; 340 * </code> 341 * 342 * @return Whether the createTime field is set. 343 */ hasCreateTime()344 boolean hasCreateTime(); 345 /** 346 * 347 * 348 * <pre> 349 * Output only. The time the instance was created. 350 * </pre> 351 * 352 * <code>.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; 353 * </code> 354 * 355 * @return The createTime. 356 */ getCreateTime()357 com.google.protobuf.Timestamp getCreateTime(); 358 /** 359 * 360 * 361 * <pre> 362 * Output only. The time the instance was created. 363 * </pre> 364 * 365 * <code>.google.protobuf.Timestamp create_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY]; 366 * </code> 367 */ getCreateTimeOrBuilder()368 com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder(); 369 370 /** 371 * 372 * 373 * <pre> 374 * Output only. The last update time. 375 * </pre> 376 * 377 * <code>.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 378 * </code> 379 * 380 * @return Whether the updateTime field is set. 381 */ hasUpdateTime()382 boolean hasUpdateTime(); 383 /** 384 * 385 * 386 * <pre> 387 * Output only. The last update time. 388 * </pre> 389 * 390 * <code>.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 391 * </code> 392 * 393 * @return The updateTime. 394 */ getUpdateTime()395 com.google.protobuf.Timestamp getUpdateTime(); 396 /** 397 * 398 * 399 * <pre> 400 * Output only. The last update time. 401 * </pre> 402 * 403 * <code>.google.protobuf.Timestamp update_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY]; 404 * </code> 405 */ getUpdateTimeOrBuilder()406 com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder(); 407 408 /** 409 * 410 * 411 * <pre> 412 * Output only. The current state of this domain. 413 * </pre> 414 * 415 * <code> 416 * .google.cloud.managedidentities.v1.Domain.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; 417 * </code> 418 * 419 * @return The enum numeric value on the wire for state. 420 */ getStateValue()421 int getStateValue(); 422 /** 423 * 424 * 425 * <pre> 426 * Output only. The current state of this domain. 427 * </pre> 428 * 429 * <code> 430 * .google.cloud.managedidentities.v1.Domain.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY]; 431 * </code> 432 * 433 * @return The state. 434 */ getState()435 com.google.cloud.managedidentities.v1.Domain.State getState(); 436 437 /** 438 * 439 * 440 * <pre> 441 * Output only. Additional information about the current status of this 442 * domain, if available. 443 * </pre> 444 * 445 * <code>string status_message = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 446 * 447 * @return The statusMessage. 448 */ getStatusMessage()449 java.lang.String getStatusMessage(); 450 /** 451 * 452 * 453 * <pre> 454 * Output only. Additional information about the current status of this 455 * domain, if available. 456 * </pre> 457 * 458 * <code>string status_message = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];</code> 459 * 460 * @return The bytes for statusMessage. 461 */ getStatusMessageBytes()462 com.google.protobuf.ByteString getStatusMessageBytes(); 463 464 /** 465 * 466 * 467 * <pre> 468 * Output only. The current trusts associated with the domain. 469 * </pre> 470 * 471 * <code> 472 * repeated .google.cloud.managedidentities.v1.Trust trusts = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; 473 * </code> 474 */ getTrustsList()475 java.util.List<com.google.cloud.managedidentities.v1.Trust> getTrustsList(); 476 /** 477 * 478 * 479 * <pre> 480 * Output only. The current trusts associated with the domain. 481 * </pre> 482 * 483 * <code> 484 * repeated .google.cloud.managedidentities.v1.Trust trusts = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; 485 * </code> 486 */ getTrusts(int index)487 com.google.cloud.managedidentities.v1.Trust getTrusts(int index); 488 /** 489 * 490 * 491 * <pre> 492 * Output only. The current trusts associated with the domain. 493 * </pre> 494 * 495 * <code> 496 * repeated .google.cloud.managedidentities.v1.Trust trusts = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; 497 * </code> 498 */ getTrustsCount()499 int getTrustsCount(); 500 /** 501 * 502 * 503 * <pre> 504 * Output only. The current trusts associated with the domain. 505 * </pre> 506 * 507 * <code> 508 * repeated .google.cloud.managedidentities.v1.Trust trusts = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; 509 * </code> 510 */ 511 java.util.List<? extends com.google.cloud.managedidentities.v1.TrustOrBuilder> getTrustsOrBuilderList()512 getTrustsOrBuilderList(); 513 /** 514 * 515 * 516 * <pre> 517 * Output only. The current trusts associated with the domain. 518 * </pre> 519 * 520 * <code> 521 * repeated .google.cloud.managedidentities.v1.Trust trusts = 15 [(.google.api.field_behavior) = OUTPUT_ONLY]; 522 * </code> 523 */ getTrustsOrBuilder(int index)524 com.google.cloud.managedidentities.v1.TrustOrBuilder getTrustsOrBuilder(int index); 525 } 526