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/contentwarehouse/v1/document_service_request.proto 18 19 package com.google.cloud.contentwarehouse.v1; 20 21 /** 22 * 23 * 24 * <pre> 25 * Request message for DocumentService.SearchDocuments. 26 * </pre> 27 * 28 * Protobuf type {@code google.cloud.contentwarehouse.v1.SearchDocumentsRequest} 29 */ 30 public final class SearchDocumentsRequest extends com.google.protobuf.GeneratedMessageV3 31 implements 32 // @@protoc_insertion_point(message_implements:google.cloud.contentwarehouse.v1.SearchDocumentsRequest) 33 SearchDocumentsRequestOrBuilder { 34 private static final long serialVersionUID = 0L; 35 // Use SearchDocumentsRequest.newBuilder() to construct. SearchDocumentsRequest(com.google.protobuf.GeneratedMessageV3.Builder<?> builder)36 private SearchDocumentsRequest(com.google.protobuf.GeneratedMessageV3.Builder<?> builder) { 37 super(builder); 38 } 39 SearchDocumentsRequest()40 private SearchDocumentsRequest() { 41 parent_ = ""; 42 pageToken_ = ""; 43 orderBy_ = ""; 44 histogramQueries_ = java.util.Collections.emptyList(); 45 totalResultSize_ = 0; 46 } 47 48 @java.lang.Override 49 @SuppressWarnings({"unused"}) newInstance(UnusedPrivateParameter unused)50 protected java.lang.Object newInstance(UnusedPrivateParameter unused) { 51 return new SearchDocumentsRequest(); 52 } 53 54 @java.lang.Override getUnknownFields()55 public final com.google.protobuf.UnknownFieldSet getUnknownFields() { 56 return this.unknownFields; 57 } 58 getDescriptor()59 public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() { 60 return com.google.cloud.contentwarehouse.v1.DocumentServiceRequestProto 61 .internal_static_google_cloud_contentwarehouse_v1_SearchDocumentsRequest_descriptor; 62 } 63 64 @java.lang.Override 65 protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()66 internalGetFieldAccessorTable() { 67 return com.google.cloud.contentwarehouse.v1.DocumentServiceRequestProto 68 .internal_static_google_cloud_contentwarehouse_v1_SearchDocumentsRequest_fieldAccessorTable 69 .ensureFieldAccessorsInitialized( 70 com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.class, 71 com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.Builder.class); 72 } 73 74 /** 75 * 76 * 77 * <pre> 78 * The total number of matching documents. 79 * </pre> 80 * 81 * Protobuf enum {@code google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize} 82 */ 83 public enum TotalResultSize implements com.google.protobuf.ProtocolMessageEnum { 84 /** 85 * 86 * 87 * <pre> 88 * Total number calculation will be skipped. 89 * </pre> 90 * 91 * <code>TOTAL_RESULT_SIZE_UNSPECIFIED = 0;</code> 92 */ 93 TOTAL_RESULT_SIZE_UNSPECIFIED(0), 94 /** 95 * 96 * 97 * <pre> 98 * Estimate total number. The total result size will be accurated up to 99 * 10,000. This option will add cost and latency to your request. 100 * </pre> 101 * 102 * <code>ESTIMATED_SIZE = 1;</code> 103 */ 104 ESTIMATED_SIZE(1), 105 /** 106 * 107 * 108 * <pre> 109 * It may adversely impact performance. The limit is 1000,000. 110 * </pre> 111 * 112 * <code>ACTUAL_SIZE = 2;</code> 113 */ 114 ACTUAL_SIZE(2), 115 UNRECOGNIZED(-1), 116 ; 117 118 /** 119 * 120 * 121 * <pre> 122 * Total number calculation will be skipped. 123 * </pre> 124 * 125 * <code>TOTAL_RESULT_SIZE_UNSPECIFIED = 0;</code> 126 */ 127 public static final int TOTAL_RESULT_SIZE_UNSPECIFIED_VALUE = 0; 128 /** 129 * 130 * 131 * <pre> 132 * Estimate total number. The total result size will be accurated up to 133 * 10,000. This option will add cost and latency to your request. 134 * </pre> 135 * 136 * <code>ESTIMATED_SIZE = 1;</code> 137 */ 138 public static final int ESTIMATED_SIZE_VALUE = 1; 139 /** 140 * 141 * 142 * <pre> 143 * It may adversely impact performance. The limit is 1000,000. 144 * </pre> 145 * 146 * <code>ACTUAL_SIZE = 2;</code> 147 */ 148 public static final int ACTUAL_SIZE_VALUE = 2; 149 getNumber()150 public final int getNumber() { 151 if (this == UNRECOGNIZED) { 152 throw new java.lang.IllegalArgumentException( 153 "Can't get the number of an unknown enum value."); 154 } 155 return value; 156 } 157 158 /** 159 * @param value The numeric wire value of the corresponding enum entry. 160 * @return The enum associated with the given numeric wire value. 161 * @deprecated Use {@link #forNumber(int)} instead. 162 */ 163 @java.lang.Deprecated valueOf(int value)164 public static TotalResultSize valueOf(int value) { 165 return forNumber(value); 166 } 167 168 /** 169 * @param value The numeric wire value of the corresponding enum entry. 170 * @return The enum associated with the given numeric wire value. 171 */ forNumber(int value)172 public static TotalResultSize forNumber(int value) { 173 switch (value) { 174 case 0: 175 return TOTAL_RESULT_SIZE_UNSPECIFIED; 176 case 1: 177 return ESTIMATED_SIZE; 178 case 2: 179 return ACTUAL_SIZE; 180 default: 181 return null; 182 } 183 } 184 internalGetValueMap()185 public static com.google.protobuf.Internal.EnumLiteMap<TotalResultSize> internalGetValueMap() { 186 return internalValueMap; 187 } 188 189 private static final com.google.protobuf.Internal.EnumLiteMap<TotalResultSize> 190 internalValueMap = 191 new com.google.protobuf.Internal.EnumLiteMap<TotalResultSize>() { 192 public TotalResultSize findValueByNumber(int number) { 193 return TotalResultSize.forNumber(number); 194 } 195 }; 196 getValueDescriptor()197 public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor() { 198 if (this == UNRECOGNIZED) { 199 throw new java.lang.IllegalStateException( 200 "Can't get the descriptor of an unrecognized enum value."); 201 } 202 return getDescriptor().getValues().get(ordinal()); 203 } 204 getDescriptorForType()205 public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType() { 206 return getDescriptor(); 207 } 208 getDescriptor()209 public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor() { 210 return com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.getDescriptor() 211 .getEnumTypes() 212 .get(0); 213 } 214 215 private static final TotalResultSize[] VALUES = values(); 216 valueOf( com.google.protobuf.Descriptors.EnumValueDescriptor desc)217 public static TotalResultSize valueOf( 218 com.google.protobuf.Descriptors.EnumValueDescriptor desc) { 219 if (desc.getType() != getDescriptor()) { 220 throw new java.lang.IllegalArgumentException("EnumValueDescriptor is not for this type."); 221 } 222 if (desc.getIndex() == -1) { 223 return UNRECOGNIZED; 224 } 225 return VALUES[desc.getIndex()]; 226 } 227 228 private final int value; 229 TotalResultSize(int value)230 private TotalResultSize(int value) { 231 this.value = value; 232 } 233 234 // @@protoc_insertion_point(enum_scope:google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize) 235 } 236 237 public static final int PARENT_FIELD_NUMBER = 1; 238 239 @SuppressWarnings("serial") 240 private volatile java.lang.Object parent_ = ""; 241 /** 242 * 243 * 244 * <pre> 245 * Required. The parent, which owns this collection of documents. 246 * Format: projects/{project_number}/locations/{location}. 247 * </pre> 248 * 249 * <code> 250 * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 251 * </code> 252 * 253 * @return The parent. 254 */ 255 @java.lang.Override getParent()256 public java.lang.String getParent() { 257 java.lang.Object ref = parent_; 258 if (ref instanceof java.lang.String) { 259 return (java.lang.String) ref; 260 } else { 261 com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref; 262 java.lang.String s = bs.toStringUtf8(); 263 parent_ = s; 264 return s; 265 } 266 } 267 /** 268 * 269 * 270 * <pre> 271 * Required. The parent, which owns this collection of documents. 272 * Format: projects/{project_number}/locations/{location}. 273 * </pre> 274 * 275 * <code> 276 * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 277 * </code> 278 * 279 * @return The bytes for parent. 280 */ 281 @java.lang.Override getParentBytes()282 public com.google.protobuf.ByteString getParentBytes() { 283 java.lang.Object ref = parent_; 284 if (ref instanceof java.lang.String) { 285 com.google.protobuf.ByteString b = 286 com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref); 287 parent_ = b; 288 return b; 289 } else { 290 return (com.google.protobuf.ByteString) ref; 291 } 292 } 293 294 public static final int REQUEST_METADATA_FIELD_NUMBER = 3; 295 private com.google.cloud.contentwarehouse.v1.RequestMetadata requestMetadata_; 296 /** 297 * 298 * 299 * <pre> 300 * The meta information collected about the end user, used to enforce access 301 * control and improve the search quality of the service. 302 * </pre> 303 * 304 * <code>.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;</code> 305 * 306 * @return Whether the requestMetadata field is set. 307 */ 308 @java.lang.Override hasRequestMetadata()309 public boolean hasRequestMetadata() { 310 return requestMetadata_ != null; 311 } 312 /** 313 * 314 * 315 * <pre> 316 * The meta information collected about the end user, used to enforce access 317 * control and improve the search quality of the service. 318 * </pre> 319 * 320 * <code>.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;</code> 321 * 322 * @return The requestMetadata. 323 */ 324 @java.lang.Override getRequestMetadata()325 public com.google.cloud.contentwarehouse.v1.RequestMetadata getRequestMetadata() { 326 return requestMetadata_ == null 327 ? com.google.cloud.contentwarehouse.v1.RequestMetadata.getDefaultInstance() 328 : requestMetadata_; 329 } 330 /** 331 * 332 * 333 * <pre> 334 * The meta information collected about the end user, used to enforce access 335 * control and improve the search quality of the service. 336 * </pre> 337 * 338 * <code>.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;</code> 339 */ 340 @java.lang.Override 341 public com.google.cloud.contentwarehouse.v1.RequestMetadataOrBuilder getRequestMetadataOrBuilder()342 getRequestMetadataOrBuilder() { 343 return requestMetadata_ == null 344 ? com.google.cloud.contentwarehouse.v1.RequestMetadata.getDefaultInstance() 345 : requestMetadata_; 346 } 347 348 public static final int DOCUMENT_QUERY_FIELD_NUMBER = 4; 349 private com.google.cloud.contentwarehouse.v1.DocumentQuery documentQuery_; 350 /** 351 * 352 * 353 * <pre> 354 * Query used to search against documents (keyword, filters, etc.). 355 * </pre> 356 * 357 * <code>.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;</code> 358 * 359 * @return Whether the documentQuery field is set. 360 */ 361 @java.lang.Override hasDocumentQuery()362 public boolean hasDocumentQuery() { 363 return documentQuery_ != null; 364 } 365 /** 366 * 367 * 368 * <pre> 369 * Query used to search against documents (keyword, filters, etc.). 370 * </pre> 371 * 372 * <code>.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;</code> 373 * 374 * @return The documentQuery. 375 */ 376 @java.lang.Override getDocumentQuery()377 public com.google.cloud.contentwarehouse.v1.DocumentQuery getDocumentQuery() { 378 return documentQuery_ == null 379 ? com.google.cloud.contentwarehouse.v1.DocumentQuery.getDefaultInstance() 380 : documentQuery_; 381 } 382 /** 383 * 384 * 385 * <pre> 386 * Query used to search against documents (keyword, filters, etc.). 387 * </pre> 388 * 389 * <code>.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;</code> 390 */ 391 @java.lang.Override getDocumentQueryOrBuilder()392 public com.google.cloud.contentwarehouse.v1.DocumentQueryOrBuilder getDocumentQueryOrBuilder() { 393 return documentQuery_ == null 394 ? com.google.cloud.contentwarehouse.v1.DocumentQuery.getDefaultInstance() 395 : documentQuery_; 396 } 397 398 public static final int OFFSET_FIELD_NUMBER = 5; 399 private int offset_ = 0; 400 /** 401 * 402 * 403 * <pre> 404 * An integer that specifies the current offset (that is, starting result 405 * location, amongst the documents deemed by the API as relevant) in search 406 * results. This field is only considered if 407 * [page_token][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.page_token] 408 * is unset. 409 * The maximum allowed value is 5000. Otherwise an error is thrown. 410 * For example, 0 means to return results starting from the first matching 411 * document, and 10 means to return from the 11th document. This can be used 412 * for pagination, (for example, pageSize = 10 and offset = 10 means to return 413 * from the second page). 414 * </pre> 415 * 416 * <code>int32 offset = 5;</code> 417 * 418 * @return The offset. 419 */ 420 @java.lang.Override getOffset()421 public int getOffset() { 422 return offset_; 423 } 424 425 public static final int PAGE_SIZE_FIELD_NUMBER = 6; 426 private int pageSize_ = 0; 427 /** 428 * 429 * 430 * <pre> 431 * A limit on the number of documents returned in the search results. 432 * Increasing this value above the default value of 10 can increase search 433 * response time. The value can be between 1 and 100. 434 * </pre> 435 * 436 * <code>int32 page_size = 6;</code> 437 * 438 * @return The pageSize. 439 */ 440 @java.lang.Override getPageSize()441 public int getPageSize() { 442 return pageSize_; 443 } 444 445 public static final int PAGE_TOKEN_FIELD_NUMBER = 7; 446 447 @SuppressWarnings("serial") 448 private volatile java.lang.Object pageToken_ = ""; 449 /** 450 * 451 * 452 * <pre> 453 * The token specifying the current offset within search results. 454 * See 455 * [SearchDocumentsResponse.next_page_token][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.next_page_token] 456 * for an explanation of how to obtain the next set of query results. 457 * </pre> 458 * 459 * <code>string page_token = 7;</code> 460 * 461 * @return The pageToken. 462 */ 463 @java.lang.Override getPageToken()464 public java.lang.String getPageToken() { 465 java.lang.Object ref = pageToken_; 466 if (ref instanceof java.lang.String) { 467 return (java.lang.String) ref; 468 } else { 469 com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref; 470 java.lang.String s = bs.toStringUtf8(); 471 pageToken_ = s; 472 return s; 473 } 474 } 475 /** 476 * 477 * 478 * <pre> 479 * The token specifying the current offset within search results. 480 * See 481 * [SearchDocumentsResponse.next_page_token][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.next_page_token] 482 * for an explanation of how to obtain the next set of query results. 483 * </pre> 484 * 485 * <code>string page_token = 7;</code> 486 * 487 * @return The bytes for pageToken. 488 */ 489 @java.lang.Override getPageTokenBytes()490 public com.google.protobuf.ByteString getPageTokenBytes() { 491 java.lang.Object ref = pageToken_; 492 if (ref instanceof java.lang.String) { 493 com.google.protobuf.ByteString b = 494 com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref); 495 pageToken_ = b; 496 return b; 497 } else { 498 return (com.google.protobuf.ByteString) ref; 499 } 500 } 501 502 public static final int ORDER_BY_FIELD_NUMBER = 8; 503 504 @SuppressWarnings("serial") 505 private volatile java.lang.Object orderBy_ = ""; 506 /** 507 * 508 * 509 * <pre> 510 * The criteria determining how search results are sorted. For non-empty 511 * query, default is `"relevance desc"`. For empty query, default is 512 * `"upload_date desc"`. 513 * Supported options are: 514 * * `"relevance desc"`: By relevance descending, as determined by the API 515 * algorithms. 516 * * `"upload_date desc"`: By upload date descending. 517 * * `"upload_date"`: By upload date ascending. 518 * * `"update_date desc"`: By last updated date descending. 519 * * `"update_date"`: By last updated date ascending. 520 * * `"retrieval_importance desc"`: By retrieval importance of properties 521 * descending. This feature is still under development, please do not use 522 * unless otherwise instructed to do so. 523 * </pre> 524 * 525 * <code>string order_by = 8;</code> 526 * 527 * @return The orderBy. 528 */ 529 @java.lang.Override getOrderBy()530 public java.lang.String getOrderBy() { 531 java.lang.Object ref = orderBy_; 532 if (ref instanceof java.lang.String) { 533 return (java.lang.String) ref; 534 } else { 535 com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref; 536 java.lang.String s = bs.toStringUtf8(); 537 orderBy_ = s; 538 return s; 539 } 540 } 541 /** 542 * 543 * 544 * <pre> 545 * The criteria determining how search results are sorted. For non-empty 546 * query, default is `"relevance desc"`. For empty query, default is 547 * `"upload_date desc"`. 548 * Supported options are: 549 * * `"relevance desc"`: By relevance descending, as determined by the API 550 * algorithms. 551 * * `"upload_date desc"`: By upload date descending. 552 * * `"upload_date"`: By upload date ascending. 553 * * `"update_date desc"`: By last updated date descending. 554 * * `"update_date"`: By last updated date ascending. 555 * * `"retrieval_importance desc"`: By retrieval importance of properties 556 * descending. This feature is still under development, please do not use 557 * unless otherwise instructed to do so. 558 * </pre> 559 * 560 * <code>string order_by = 8;</code> 561 * 562 * @return The bytes for orderBy. 563 */ 564 @java.lang.Override getOrderByBytes()565 public com.google.protobuf.ByteString getOrderByBytes() { 566 java.lang.Object ref = orderBy_; 567 if (ref instanceof java.lang.String) { 568 com.google.protobuf.ByteString b = 569 com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref); 570 orderBy_ = b; 571 return b; 572 } else { 573 return (com.google.protobuf.ByteString) ref; 574 } 575 } 576 577 public static final int HISTOGRAM_QUERIES_FIELD_NUMBER = 9; 578 579 @SuppressWarnings("serial") 580 private java.util.List<com.google.cloud.contentwarehouse.v1.HistogramQuery> histogramQueries_; 581 /** 582 * 583 * 584 * <pre> 585 * An expression specifying a histogram request against matching 586 * documents. Expression syntax is an aggregation function call with 587 * histogram facets and other options. 588 * The following aggregation functions are supported: 589 * * `count(string_histogram_facet)`: Count the number of matching entities 590 * for each distinct attribute value. 591 * Data types: 592 * * Histogram facet (aka filterable properties): Facet names with format 593 * &lt;schema id&gt;.&lt;facet&gt;. Facets will have the 594 * format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child 595 * facet, then the parent hierarchy needs to be specified separated by 596 * dots in the prefix after the schema id. Thus, the format for a multi- 597 * level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. 598 * &lt;child facet name&gt;. Example: 599 * schema123.root_parent_facet.middle_facet.child_facet 600 * * DocumentSchemaId: (with no schema id prefix) to get 601 * histograms for each document type (returns the schema id path, e.g. 602 * projects/12345/locations/us-west/documentSchemas/abc123). 603 * Example expression: 604 * * Document type counts: 605 * count('DocumentSchemaId') 606 * * For schema id, abc123, get the counts for MORTGAGE_TYPE: 607 * count('abc123.MORTGAGE_TYPE') 608 * </pre> 609 * 610 * <code>repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;</code> 611 */ 612 @java.lang.Override 613 public java.util.List<com.google.cloud.contentwarehouse.v1.HistogramQuery> getHistogramQueriesList()614 getHistogramQueriesList() { 615 return histogramQueries_; 616 } 617 /** 618 * 619 * 620 * <pre> 621 * An expression specifying a histogram request against matching 622 * documents. Expression syntax is an aggregation function call with 623 * histogram facets and other options. 624 * The following aggregation functions are supported: 625 * * `count(string_histogram_facet)`: Count the number of matching entities 626 * for each distinct attribute value. 627 * Data types: 628 * * Histogram facet (aka filterable properties): Facet names with format 629 * &lt;schema id&gt;.&lt;facet&gt;. Facets will have the 630 * format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child 631 * facet, then the parent hierarchy needs to be specified separated by 632 * dots in the prefix after the schema id. Thus, the format for a multi- 633 * level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. 634 * &lt;child facet name&gt;. Example: 635 * schema123.root_parent_facet.middle_facet.child_facet 636 * * DocumentSchemaId: (with no schema id prefix) to get 637 * histograms for each document type (returns the schema id path, e.g. 638 * projects/12345/locations/us-west/documentSchemas/abc123). 639 * Example expression: 640 * * Document type counts: 641 * count('DocumentSchemaId') 642 * * For schema id, abc123, get the counts for MORTGAGE_TYPE: 643 * count('abc123.MORTGAGE_TYPE') 644 * </pre> 645 * 646 * <code>repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;</code> 647 */ 648 @java.lang.Override 649 public java.util.List<? extends com.google.cloud.contentwarehouse.v1.HistogramQueryOrBuilder> getHistogramQueriesOrBuilderList()650 getHistogramQueriesOrBuilderList() { 651 return histogramQueries_; 652 } 653 /** 654 * 655 * 656 * <pre> 657 * An expression specifying a histogram request against matching 658 * documents. Expression syntax is an aggregation function call with 659 * histogram facets and other options. 660 * The following aggregation functions are supported: 661 * * `count(string_histogram_facet)`: Count the number of matching entities 662 * for each distinct attribute value. 663 * Data types: 664 * * Histogram facet (aka filterable properties): Facet names with format 665 * &lt;schema id&gt;.&lt;facet&gt;. Facets will have the 666 * format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child 667 * facet, then the parent hierarchy needs to be specified separated by 668 * dots in the prefix after the schema id. Thus, the format for a multi- 669 * level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. 670 * &lt;child facet name&gt;. Example: 671 * schema123.root_parent_facet.middle_facet.child_facet 672 * * DocumentSchemaId: (with no schema id prefix) to get 673 * histograms for each document type (returns the schema id path, e.g. 674 * projects/12345/locations/us-west/documentSchemas/abc123). 675 * Example expression: 676 * * Document type counts: 677 * count('DocumentSchemaId') 678 * * For schema id, abc123, get the counts for MORTGAGE_TYPE: 679 * count('abc123.MORTGAGE_TYPE') 680 * </pre> 681 * 682 * <code>repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;</code> 683 */ 684 @java.lang.Override getHistogramQueriesCount()685 public int getHistogramQueriesCount() { 686 return histogramQueries_.size(); 687 } 688 /** 689 * 690 * 691 * <pre> 692 * An expression specifying a histogram request against matching 693 * documents. Expression syntax is an aggregation function call with 694 * histogram facets and other options. 695 * The following aggregation functions are supported: 696 * * `count(string_histogram_facet)`: Count the number of matching entities 697 * for each distinct attribute value. 698 * Data types: 699 * * Histogram facet (aka filterable properties): Facet names with format 700 * &lt;schema id&gt;.&lt;facet&gt;. Facets will have the 701 * format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child 702 * facet, then the parent hierarchy needs to be specified separated by 703 * dots in the prefix after the schema id. Thus, the format for a multi- 704 * level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. 705 * &lt;child facet name&gt;. Example: 706 * schema123.root_parent_facet.middle_facet.child_facet 707 * * DocumentSchemaId: (with no schema id prefix) to get 708 * histograms for each document type (returns the schema id path, e.g. 709 * projects/12345/locations/us-west/documentSchemas/abc123). 710 * Example expression: 711 * * Document type counts: 712 * count('DocumentSchemaId') 713 * * For schema id, abc123, get the counts for MORTGAGE_TYPE: 714 * count('abc123.MORTGAGE_TYPE') 715 * </pre> 716 * 717 * <code>repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;</code> 718 */ 719 @java.lang.Override getHistogramQueries(int index)720 public com.google.cloud.contentwarehouse.v1.HistogramQuery getHistogramQueries(int index) { 721 return histogramQueries_.get(index); 722 } 723 /** 724 * 725 * 726 * <pre> 727 * An expression specifying a histogram request against matching 728 * documents. Expression syntax is an aggregation function call with 729 * histogram facets and other options. 730 * The following aggregation functions are supported: 731 * * `count(string_histogram_facet)`: Count the number of matching entities 732 * for each distinct attribute value. 733 * Data types: 734 * * Histogram facet (aka filterable properties): Facet names with format 735 * &lt;schema id&gt;.&lt;facet&gt;. Facets will have the 736 * format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child 737 * facet, then the parent hierarchy needs to be specified separated by 738 * dots in the prefix after the schema id. Thus, the format for a multi- 739 * level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. 740 * &lt;child facet name&gt;. Example: 741 * schema123.root_parent_facet.middle_facet.child_facet 742 * * DocumentSchemaId: (with no schema id prefix) to get 743 * histograms for each document type (returns the schema id path, e.g. 744 * projects/12345/locations/us-west/documentSchemas/abc123). 745 * Example expression: 746 * * Document type counts: 747 * count('DocumentSchemaId') 748 * * For schema id, abc123, get the counts for MORTGAGE_TYPE: 749 * count('abc123.MORTGAGE_TYPE') 750 * </pre> 751 * 752 * <code>repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;</code> 753 */ 754 @java.lang.Override getHistogramQueriesOrBuilder( int index)755 public com.google.cloud.contentwarehouse.v1.HistogramQueryOrBuilder getHistogramQueriesOrBuilder( 756 int index) { 757 return histogramQueries_.get(index); 758 } 759 760 public static final int REQUIRE_TOTAL_SIZE_FIELD_NUMBER = 10; 761 private boolean requireTotalSize_ = false; 762 /** 763 * 764 * 765 * <pre> 766 * Controls if the search document request requires the return of a total size 767 * of matched documents. See 768 * [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size]. 769 * Enabling this flag may adversely impact performance. Hint: If this is 770 * used with pagination, set this flag on the initial query but set this 771 * to false on subsequent page calls (keep the total count locally). 772 * Defaults to false. 773 * </pre> 774 * 775 * <code>bool require_total_size = 10;</code> 776 * 777 * @return The requireTotalSize. 778 */ 779 @java.lang.Override getRequireTotalSize()780 public boolean getRequireTotalSize() { 781 return requireTotalSize_; 782 } 783 784 public static final int TOTAL_RESULT_SIZE_FIELD_NUMBER = 12; 785 private int totalResultSize_ = 0; 786 /** 787 * 788 * 789 * <pre> 790 * Controls if the search document request requires the return of a total size 791 * of matched documents. See 792 * [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size]. 793 * </pre> 794 * 795 * <code> 796 * .google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize total_result_size = 12; 797 * </code> 798 * 799 * @return The enum numeric value on the wire for totalResultSize. 800 */ 801 @java.lang.Override getTotalResultSizeValue()802 public int getTotalResultSizeValue() { 803 return totalResultSize_; 804 } 805 /** 806 * 807 * 808 * <pre> 809 * Controls if the search document request requires the return of a total size 810 * of matched documents. See 811 * [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size]. 812 * </pre> 813 * 814 * <code> 815 * .google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize total_result_size = 12; 816 * </code> 817 * 818 * @return The totalResultSize. 819 */ 820 @java.lang.Override 821 public com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize getTotalResultSize()822 getTotalResultSize() { 823 com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize result = 824 com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize.forNumber( 825 totalResultSize_); 826 return result == null 827 ? com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize.UNRECOGNIZED 828 : result; 829 } 830 831 public static final int QA_SIZE_LIMIT_FIELD_NUMBER = 11; 832 private int qaSizeLimit_ = 0; 833 /** 834 * 835 * 836 * <pre> 837 * Experimental, do not use. 838 * The limit on the number of documents returned for the question-answering 839 * feature. To enable the question-answering feature, set 840 * [DocumentQuery].[is_nl_query][] to true. 841 * </pre> 842 * 843 * <code>int32 qa_size_limit = 11;</code> 844 * 845 * @return The qaSizeLimit. 846 */ 847 @java.lang.Override getQaSizeLimit()848 public int getQaSizeLimit() { 849 return qaSizeLimit_; 850 } 851 852 private byte memoizedIsInitialized = -1; 853 854 @java.lang.Override isInitialized()855 public final boolean isInitialized() { 856 byte isInitialized = memoizedIsInitialized; 857 if (isInitialized == 1) return true; 858 if (isInitialized == 0) return false; 859 860 memoizedIsInitialized = 1; 861 return true; 862 } 863 864 @java.lang.Override writeTo(com.google.protobuf.CodedOutputStream output)865 public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException { 866 if (!com.google.protobuf.GeneratedMessageV3.isStringEmpty(parent_)) { 867 com.google.protobuf.GeneratedMessageV3.writeString(output, 1, parent_); 868 } 869 if (requestMetadata_ != null) { 870 output.writeMessage(3, getRequestMetadata()); 871 } 872 if (documentQuery_ != null) { 873 output.writeMessage(4, getDocumentQuery()); 874 } 875 if (offset_ != 0) { 876 output.writeInt32(5, offset_); 877 } 878 if (pageSize_ != 0) { 879 output.writeInt32(6, pageSize_); 880 } 881 if (!com.google.protobuf.GeneratedMessageV3.isStringEmpty(pageToken_)) { 882 com.google.protobuf.GeneratedMessageV3.writeString(output, 7, pageToken_); 883 } 884 if (!com.google.protobuf.GeneratedMessageV3.isStringEmpty(orderBy_)) { 885 com.google.protobuf.GeneratedMessageV3.writeString(output, 8, orderBy_); 886 } 887 for (int i = 0; i < histogramQueries_.size(); i++) { 888 output.writeMessage(9, histogramQueries_.get(i)); 889 } 890 if (requireTotalSize_ != false) { 891 output.writeBool(10, requireTotalSize_); 892 } 893 if (qaSizeLimit_ != 0) { 894 output.writeInt32(11, qaSizeLimit_); 895 } 896 if (totalResultSize_ 897 != com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize 898 .TOTAL_RESULT_SIZE_UNSPECIFIED 899 .getNumber()) { 900 output.writeEnum(12, totalResultSize_); 901 } 902 getUnknownFields().writeTo(output); 903 } 904 905 @java.lang.Override getSerializedSize()906 public int getSerializedSize() { 907 int size = memoizedSize; 908 if (size != -1) return size; 909 910 size = 0; 911 if (!com.google.protobuf.GeneratedMessageV3.isStringEmpty(parent_)) { 912 size += com.google.protobuf.GeneratedMessageV3.computeStringSize(1, parent_); 913 } 914 if (requestMetadata_ != null) { 915 size += com.google.protobuf.CodedOutputStream.computeMessageSize(3, getRequestMetadata()); 916 } 917 if (documentQuery_ != null) { 918 size += com.google.protobuf.CodedOutputStream.computeMessageSize(4, getDocumentQuery()); 919 } 920 if (offset_ != 0) { 921 size += com.google.protobuf.CodedOutputStream.computeInt32Size(5, offset_); 922 } 923 if (pageSize_ != 0) { 924 size += com.google.protobuf.CodedOutputStream.computeInt32Size(6, pageSize_); 925 } 926 if (!com.google.protobuf.GeneratedMessageV3.isStringEmpty(pageToken_)) { 927 size += com.google.protobuf.GeneratedMessageV3.computeStringSize(7, pageToken_); 928 } 929 if (!com.google.protobuf.GeneratedMessageV3.isStringEmpty(orderBy_)) { 930 size += com.google.protobuf.GeneratedMessageV3.computeStringSize(8, orderBy_); 931 } 932 for (int i = 0; i < histogramQueries_.size(); i++) { 933 size += com.google.protobuf.CodedOutputStream.computeMessageSize(9, histogramQueries_.get(i)); 934 } 935 if (requireTotalSize_ != false) { 936 size += com.google.protobuf.CodedOutputStream.computeBoolSize(10, requireTotalSize_); 937 } 938 if (qaSizeLimit_ != 0) { 939 size += com.google.protobuf.CodedOutputStream.computeInt32Size(11, qaSizeLimit_); 940 } 941 if (totalResultSize_ 942 != com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize 943 .TOTAL_RESULT_SIZE_UNSPECIFIED 944 .getNumber()) { 945 size += com.google.protobuf.CodedOutputStream.computeEnumSize(12, totalResultSize_); 946 } 947 size += getUnknownFields().getSerializedSize(); 948 memoizedSize = size; 949 return size; 950 } 951 952 @java.lang.Override equals(final java.lang.Object obj)953 public boolean equals(final java.lang.Object obj) { 954 if (obj == this) { 955 return true; 956 } 957 if (!(obj instanceof com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest)) { 958 return super.equals(obj); 959 } 960 com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest other = 961 (com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest) obj; 962 963 if (!getParent().equals(other.getParent())) return false; 964 if (hasRequestMetadata() != other.hasRequestMetadata()) return false; 965 if (hasRequestMetadata()) { 966 if (!getRequestMetadata().equals(other.getRequestMetadata())) return false; 967 } 968 if (hasDocumentQuery() != other.hasDocumentQuery()) return false; 969 if (hasDocumentQuery()) { 970 if (!getDocumentQuery().equals(other.getDocumentQuery())) return false; 971 } 972 if (getOffset() != other.getOffset()) return false; 973 if (getPageSize() != other.getPageSize()) return false; 974 if (!getPageToken().equals(other.getPageToken())) return false; 975 if (!getOrderBy().equals(other.getOrderBy())) return false; 976 if (!getHistogramQueriesList().equals(other.getHistogramQueriesList())) return false; 977 if (getRequireTotalSize() != other.getRequireTotalSize()) return false; 978 if (totalResultSize_ != other.totalResultSize_) return false; 979 if (getQaSizeLimit() != other.getQaSizeLimit()) return false; 980 if (!getUnknownFields().equals(other.getUnknownFields())) return false; 981 return true; 982 } 983 984 @java.lang.Override hashCode()985 public int hashCode() { 986 if (memoizedHashCode != 0) { 987 return memoizedHashCode; 988 } 989 int hash = 41; 990 hash = (19 * hash) + getDescriptor().hashCode(); 991 hash = (37 * hash) + PARENT_FIELD_NUMBER; 992 hash = (53 * hash) + getParent().hashCode(); 993 if (hasRequestMetadata()) { 994 hash = (37 * hash) + REQUEST_METADATA_FIELD_NUMBER; 995 hash = (53 * hash) + getRequestMetadata().hashCode(); 996 } 997 if (hasDocumentQuery()) { 998 hash = (37 * hash) + DOCUMENT_QUERY_FIELD_NUMBER; 999 hash = (53 * hash) + getDocumentQuery().hashCode(); 1000 } 1001 hash = (37 * hash) + OFFSET_FIELD_NUMBER; 1002 hash = (53 * hash) + getOffset(); 1003 hash = (37 * hash) + PAGE_SIZE_FIELD_NUMBER; 1004 hash = (53 * hash) + getPageSize(); 1005 hash = (37 * hash) + PAGE_TOKEN_FIELD_NUMBER; 1006 hash = (53 * hash) + getPageToken().hashCode(); 1007 hash = (37 * hash) + ORDER_BY_FIELD_NUMBER; 1008 hash = (53 * hash) + getOrderBy().hashCode(); 1009 if (getHistogramQueriesCount() > 0) { 1010 hash = (37 * hash) + HISTOGRAM_QUERIES_FIELD_NUMBER; 1011 hash = (53 * hash) + getHistogramQueriesList().hashCode(); 1012 } 1013 hash = (37 * hash) + REQUIRE_TOTAL_SIZE_FIELD_NUMBER; 1014 hash = (53 * hash) + com.google.protobuf.Internal.hashBoolean(getRequireTotalSize()); 1015 hash = (37 * hash) + TOTAL_RESULT_SIZE_FIELD_NUMBER; 1016 hash = (53 * hash) + totalResultSize_; 1017 hash = (37 * hash) + QA_SIZE_LIMIT_FIELD_NUMBER; 1018 hash = (53 * hash) + getQaSizeLimit(); 1019 hash = (29 * hash) + getUnknownFields().hashCode(); 1020 memoizedHashCode = hash; 1021 return hash; 1022 } 1023 parseFrom( java.nio.ByteBuffer data)1024 public static com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest parseFrom( 1025 java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException { 1026 return PARSER.parseFrom(data); 1027 } 1028 parseFrom( java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)1029 public static com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest parseFrom( 1030 java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) 1031 throws com.google.protobuf.InvalidProtocolBufferException { 1032 return PARSER.parseFrom(data, extensionRegistry); 1033 } 1034 parseFrom( com.google.protobuf.ByteString data)1035 public static com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest parseFrom( 1036 com.google.protobuf.ByteString data) 1037 throws com.google.protobuf.InvalidProtocolBufferException { 1038 return PARSER.parseFrom(data); 1039 } 1040 parseFrom( com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)1041 public static com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest parseFrom( 1042 com.google.protobuf.ByteString data, 1043 com.google.protobuf.ExtensionRegistryLite extensionRegistry) 1044 throws com.google.protobuf.InvalidProtocolBufferException { 1045 return PARSER.parseFrom(data, extensionRegistry); 1046 } 1047 parseFrom(byte[] data)1048 public static com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest parseFrom(byte[] data) 1049 throws com.google.protobuf.InvalidProtocolBufferException { 1050 return PARSER.parseFrom(data); 1051 } 1052 parseFrom( byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)1053 public static com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest parseFrom( 1054 byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) 1055 throws com.google.protobuf.InvalidProtocolBufferException { 1056 return PARSER.parseFrom(data, extensionRegistry); 1057 } 1058 parseFrom( java.io.InputStream input)1059 public static com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest parseFrom( 1060 java.io.InputStream input) throws java.io.IOException { 1061 return com.google.protobuf.GeneratedMessageV3.parseWithIOException(PARSER, input); 1062 } 1063 parseFrom( java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)1064 public static com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest parseFrom( 1065 java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) 1066 throws java.io.IOException { 1067 return com.google.protobuf.GeneratedMessageV3.parseWithIOException( 1068 PARSER, input, extensionRegistry); 1069 } 1070 parseDelimitedFrom( java.io.InputStream input)1071 public static com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest parseDelimitedFrom( 1072 java.io.InputStream input) throws java.io.IOException { 1073 return com.google.protobuf.GeneratedMessageV3.parseDelimitedWithIOException(PARSER, input); 1074 } 1075 parseDelimitedFrom( java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)1076 public static com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest parseDelimitedFrom( 1077 java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) 1078 throws java.io.IOException { 1079 return com.google.protobuf.GeneratedMessageV3.parseDelimitedWithIOException( 1080 PARSER, input, extensionRegistry); 1081 } 1082 parseFrom( com.google.protobuf.CodedInputStream input)1083 public static com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest parseFrom( 1084 com.google.protobuf.CodedInputStream input) throws java.io.IOException { 1085 return com.google.protobuf.GeneratedMessageV3.parseWithIOException(PARSER, input); 1086 } 1087 parseFrom( com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)1088 public static com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest parseFrom( 1089 com.google.protobuf.CodedInputStream input, 1090 com.google.protobuf.ExtensionRegistryLite extensionRegistry) 1091 throws java.io.IOException { 1092 return com.google.protobuf.GeneratedMessageV3.parseWithIOException( 1093 PARSER, input, extensionRegistry); 1094 } 1095 1096 @java.lang.Override newBuilderForType()1097 public Builder newBuilderForType() { 1098 return newBuilder(); 1099 } 1100 newBuilder()1101 public static Builder newBuilder() { 1102 return DEFAULT_INSTANCE.toBuilder(); 1103 } 1104 newBuilder( com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest prototype)1105 public static Builder newBuilder( 1106 com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest prototype) { 1107 return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype); 1108 } 1109 1110 @java.lang.Override toBuilder()1111 public Builder toBuilder() { 1112 return this == DEFAULT_INSTANCE ? new Builder() : new Builder().mergeFrom(this); 1113 } 1114 1115 @java.lang.Override newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)1116 protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) { 1117 Builder builder = new Builder(parent); 1118 return builder; 1119 } 1120 /** 1121 * 1122 * 1123 * <pre> 1124 * Request message for DocumentService.SearchDocuments. 1125 * </pre> 1126 * 1127 * Protobuf type {@code google.cloud.contentwarehouse.v1.SearchDocumentsRequest} 1128 */ 1129 public static final class Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Builder> 1130 implements 1131 // @@protoc_insertion_point(builder_implements:google.cloud.contentwarehouse.v1.SearchDocumentsRequest) 1132 com.google.cloud.contentwarehouse.v1.SearchDocumentsRequestOrBuilder { getDescriptor()1133 public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() { 1134 return com.google.cloud.contentwarehouse.v1.DocumentServiceRequestProto 1135 .internal_static_google_cloud_contentwarehouse_v1_SearchDocumentsRequest_descriptor; 1136 } 1137 1138 @java.lang.Override 1139 protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()1140 internalGetFieldAccessorTable() { 1141 return com.google.cloud.contentwarehouse.v1.DocumentServiceRequestProto 1142 .internal_static_google_cloud_contentwarehouse_v1_SearchDocumentsRequest_fieldAccessorTable 1143 .ensureFieldAccessorsInitialized( 1144 com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.class, 1145 com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.Builder.class); 1146 } 1147 1148 // Construct using com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.newBuilder() Builder()1149 private Builder() {} 1150 Builder(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)1151 private Builder(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) { 1152 super(parent); 1153 } 1154 1155 @java.lang.Override clear()1156 public Builder clear() { 1157 super.clear(); 1158 bitField0_ = 0; 1159 parent_ = ""; 1160 requestMetadata_ = null; 1161 if (requestMetadataBuilder_ != null) { 1162 requestMetadataBuilder_.dispose(); 1163 requestMetadataBuilder_ = null; 1164 } 1165 documentQuery_ = null; 1166 if (documentQueryBuilder_ != null) { 1167 documentQueryBuilder_.dispose(); 1168 documentQueryBuilder_ = null; 1169 } 1170 offset_ = 0; 1171 pageSize_ = 0; 1172 pageToken_ = ""; 1173 orderBy_ = ""; 1174 if (histogramQueriesBuilder_ == null) { 1175 histogramQueries_ = java.util.Collections.emptyList(); 1176 } else { 1177 histogramQueries_ = null; 1178 histogramQueriesBuilder_.clear(); 1179 } 1180 bitField0_ = (bitField0_ & ~0x00000080); 1181 requireTotalSize_ = false; 1182 totalResultSize_ = 0; 1183 qaSizeLimit_ = 0; 1184 return this; 1185 } 1186 1187 @java.lang.Override getDescriptorForType()1188 public com.google.protobuf.Descriptors.Descriptor getDescriptorForType() { 1189 return com.google.cloud.contentwarehouse.v1.DocumentServiceRequestProto 1190 .internal_static_google_cloud_contentwarehouse_v1_SearchDocumentsRequest_descriptor; 1191 } 1192 1193 @java.lang.Override getDefaultInstanceForType()1194 public com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest getDefaultInstanceForType() { 1195 return com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.getDefaultInstance(); 1196 } 1197 1198 @java.lang.Override build()1199 public com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest build() { 1200 com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest result = buildPartial(); 1201 if (!result.isInitialized()) { 1202 throw newUninitializedMessageException(result); 1203 } 1204 return result; 1205 } 1206 1207 @java.lang.Override buildPartial()1208 public com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest buildPartial() { 1209 com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest result = 1210 new com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest(this); 1211 buildPartialRepeatedFields(result); 1212 if (bitField0_ != 0) { 1213 buildPartial0(result); 1214 } 1215 onBuilt(); 1216 return result; 1217 } 1218 buildPartialRepeatedFields( com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest result)1219 private void buildPartialRepeatedFields( 1220 com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest result) { 1221 if (histogramQueriesBuilder_ == null) { 1222 if (((bitField0_ & 0x00000080) != 0)) { 1223 histogramQueries_ = java.util.Collections.unmodifiableList(histogramQueries_); 1224 bitField0_ = (bitField0_ & ~0x00000080); 1225 } 1226 result.histogramQueries_ = histogramQueries_; 1227 } else { 1228 result.histogramQueries_ = histogramQueriesBuilder_.build(); 1229 } 1230 } 1231 buildPartial0(com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest result)1232 private void buildPartial0(com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest result) { 1233 int from_bitField0_ = bitField0_; 1234 if (((from_bitField0_ & 0x00000001) != 0)) { 1235 result.parent_ = parent_; 1236 } 1237 if (((from_bitField0_ & 0x00000002) != 0)) { 1238 result.requestMetadata_ = 1239 requestMetadataBuilder_ == null ? requestMetadata_ : requestMetadataBuilder_.build(); 1240 } 1241 if (((from_bitField0_ & 0x00000004) != 0)) { 1242 result.documentQuery_ = 1243 documentQueryBuilder_ == null ? documentQuery_ : documentQueryBuilder_.build(); 1244 } 1245 if (((from_bitField0_ & 0x00000008) != 0)) { 1246 result.offset_ = offset_; 1247 } 1248 if (((from_bitField0_ & 0x00000010) != 0)) { 1249 result.pageSize_ = pageSize_; 1250 } 1251 if (((from_bitField0_ & 0x00000020) != 0)) { 1252 result.pageToken_ = pageToken_; 1253 } 1254 if (((from_bitField0_ & 0x00000040) != 0)) { 1255 result.orderBy_ = orderBy_; 1256 } 1257 if (((from_bitField0_ & 0x00000100) != 0)) { 1258 result.requireTotalSize_ = requireTotalSize_; 1259 } 1260 if (((from_bitField0_ & 0x00000200) != 0)) { 1261 result.totalResultSize_ = totalResultSize_; 1262 } 1263 if (((from_bitField0_ & 0x00000400) != 0)) { 1264 result.qaSizeLimit_ = qaSizeLimit_; 1265 } 1266 } 1267 1268 @java.lang.Override clone()1269 public Builder clone() { 1270 return super.clone(); 1271 } 1272 1273 @java.lang.Override setField( com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)1274 public Builder setField( 1275 com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value) { 1276 return super.setField(field, value); 1277 } 1278 1279 @java.lang.Override clearField(com.google.protobuf.Descriptors.FieldDescriptor field)1280 public Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field) { 1281 return super.clearField(field); 1282 } 1283 1284 @java.lang.Override clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)1285 public Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) { 1286 return super.clearOneof(oneof); 1287 } 1288 1289 @java.lang.Override setRepeatedField( com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)1290 public Builder setRepeatedField( 1291 com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value) { 1292 return super.setRepeatedField(field, index, value); 1293 } 1294 1295 @java.lang.Override addRepeatedField( com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)1296 public Builder addRepeatedField( 1297 com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value) { 1298 return super.addRepeatedField(field, value); 1299 } 1300 1301 @java.lang.Override mergeFrom(com.google.protobuf.Message other)1302 public Builder mergeFrom(com.google.protobuf.Message other) { 1303 if (other instanceof com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest) { 1304 return mergeFrom((com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest) other); 1305 } else { 1306 super.mergeFrom(other); 1307 return this; 1308 } 1309 } 1310 mergeFrom(com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest other)1311 public Builder mergeFrom(com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest other) { 1312 if (other == com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.getDefaultInstance()) 1313 return this; 1314 if (!other.getParent().isEmpty()) { 1315 parent_ = other.parent_; 1316 bitField0_ |= 0x00000001; 1317 onChanged(); 1318 } 1319 if (other.hasRequestMetadata()) { 1320 mergeRequestMetadata(other.getRequestMetadata()); 1321 } 1322 if (other.hasDocumentQuery()) { 1323 mergeDocumentQuery(other.getDocumentQuery()); 1324 } 1325 if (other.getOffset() != 0) { 1326 setOffset(other.getOffset()); 1327 } 1328 if (other.getPageSize() != 0) { 1329 setPageSize(other.getPageSize()); 1330 } 1331 if (!other.getPageToken().isEmpty()) { 1332 pageToken_ = other.pageToken_; 1333 bitField0_ |= 0x00000020; 1334 onChanged(); 1335 } 1336 if (!other.getOrderBy().isEmpty()) { 1337 orderBy_ = other.orderBy_; 1338 bitField0_ |= 0x00000040; 1339 onChanged(); 1340 } 1341 if (histogramQueriesBuilder_ == null) { 1342 if (!other.histogramQueries_.isEmpty()) { 1343 if (histogramQueries_.isEmpty()) { 1344 histogramQueries_ = other.histogramQueries_; 1345 bitField0_ = (bitField0_ & ~0x00000080); 1346 } else { 1347 ensureHistogramQueriesIsMutable(); 1348 histogramQueries_.addAll(other.histogramQueries_); 1349 } 1350 onChanged(); 1351 } 1352 } else { 1353 if (!other.histogramQueries_.isEmpty()) { 1354 if (histogramQueriesBuilder_.isEmpty()) { 1355 histogramQueriesBuilder_.dispose(); 1356 histogramQueriesBuilder_ = null; 1357 histogramQueries_ = other.histogramQueries_; 1358 bitField0_ = (bitField0_ & ~0x00000080); 1359 histogramQueriesBuilder_ = 1360 com.google.protobuf.GeneratedMessageV3.alwaysUseFieldBuilders 1361 ? getHistogramQueriesFieldBuilder() 1362 : null; 1363 } else { 1364 histogramQueriesBuilder_.addAllMessages(other.histogramQueries_); 1365 } 1366 } 1367 } 1368 if (other.getRequireTotalSize() != false) { 1369 setRequireTotalSize(other.getRequireTotalSize()); 1370 } 1371 if (other.totalResultSize_ != 0) { 1372 setTotalResultSizeValue(other.getTotalResultSizeValue()); 1373 } 1374 if (other.getQaSizeLimit() != 0) { 1375 setQaSizeLimit(other.getQaSizeLimit()); 1376 } 1377 this.mergeUnknownFields(other.getUnknownFields()); 1378 onChanged(); 1379 return this; 1380 } 1381 1382 @java.lang.Override isInitialized()1383 public final boolean isInitialized() { 1384 return true; 1385 } 1386 1387 @java.lang.Override mergeFrom( com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)1388 public Builder mergeFrom( 1389 com.google.protobuf.CodedInputStream input, 1390 com.google.protobuf.ExtensionRegistryLite extensionRegistry) 1391 throws java.io.IOException { 1392 if (extensionRegistry == null) { 1393 throw new java.lang.NullPointerException(); 1394 } 1395 try { 1396 boolean done = false; 1397 while (!done) { 1398 int tag = input.readTag(); 1399 switch (tag) { 1400 case 0: 1401 done = true; 1402 break; 1403 case 10: 1404 { 1405 parent_ = input.readStringRequireUtf8(); 1406 bitField0_ |= 0x00000001; 1407 break; 1408 } // case 10 1409 case 26: 1410 { 1411 input.readMessage(getRequestMetadataFieldBuilder().getBuilder(), extensionRegistry); 1412 bitField0_ |= 0x00000002; 1413 break; 1414 } // case 26 1415 case 34: 1416 { 1417 input.readMessage(getDocumentQueryFieldBuilder().getBuilder(), extensionRegistry); 1418 bitField0_ |= 0x00000004; 1419 break; 1420 } // case 34 1421 case 40: 1422 { 1423 offset_ = input.readInt32(); 1424 bitField0_ |= 0x00000008; 1425 break; 1426 } // case 40 1427 case 48: 1428 { 1429 pageSize_ = input.readInt32(); 1430 bitField0_ |= 0x00000010; 1431 break; 1432 } // case 48 1433 case 58: 1434 { 1435 pageToken_ = input.readStringRequireUtf8(); 1436 bitField0_ |= 0x00000020; 1437 break; 1438 } // case 58 1439 case 66: 1440 { 1441 orderBy_ = input.readStringRequireUtf8(); 1442 bitField0_ |= 0x00000040; 1443 break; 1444 } // case 66 1445 case 74: 1446 { 1447 com.google.cloud.contentwarehouse.v1.HistogramQuery m = 1448 input.readMessage( 1449 com.google.cloud.contentwarehouse.v1.HistogramQuery.parser(), 1450 extensionRegistry); 1451 if (histogramQueriesBuilder_ == null) { 1452 ensureHistogramQueriesIsMutable(); 1453 histogramQueries_.add(m); 1454 } else { 1455 histogramQueriesBuilder_.addMessage(m); 1456 } 1457 break; 1458 } // case 74 1459 case 80: 1460 { 1461 requireTotalSize_ = input.readBool(); 1462 bitField0_ |= 0x00000100; 1463 break; 1464 } // case 80 1465 case 88: 1466 { 1467 qaSizeLimit_ = input.readInt32(); 1468 bitField0_ |= 0x00000400; 1469 break; 1470 } // case 88 1471 case 96: 1472 { 1473 totalResultSize_ = input.readEnum(); 1474 bitField0_ |= 0x00000200; 1475 break; 1476 } // case 96 1477 default: 1478 { 1479 if (!super.parseUnknownField(input, extensionRegistry, tag)) { 1480 done = true; // was an endgroup tag 1481 } 1482 break; 1483 } // default: 1484 } // switch (tag) 1485 } // while (!done) 1486 } catch (com.google.protobuf.InvalidProtocolBufferException e) { 1487 throw e.unwrapIOException(); 1488 } finally { 1489 onChanged(); 1490 } // finally 1491 return this; 1492 } 1493 1494 private int bitField0_; 1495 1496 private java.lang.Object parent_ = ""; 1497 /** 1498 * 1499 * 1500 * <pre> 1501 * Required. The parent, which owns this collection of documents. 1502 * Format: projects/{project_number}/locations/{location}. 1503 * </pre> 1504 * 1505 * <code> 1506 * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 1507 * </code> 1508 * 1509 * @return The parent. 1510 */ getParent()1511 public java.lang.String getParent() { 1512 java.lang.Object ref = parent_; 1513 if (!(ref instanceof java.lang.String)) { 1514 com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref; 1515 java.lang.String s = bs.toStringUtf8(); 1516 parent_ = s; 1517 return s; 1518 } else { 1519 return (java.lang.String) ref; 1520 } 1521 } 1522 /** 1523 * 1524 * 1525 * <pre> 1526 * Required. The parent, which owns this collection of documents. 1527 * Format: projects/{project_number}/locations/{location}. 1528 * </pre> 1529 * 1530 * <code> 1531 * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 1532 * </code> 1533 * 1534 * @return The bytes for parent. 1535 */ getParentBytes()1536 public com.google.protobuf.ByteString getParentBytes() { 1537 java.lang.Object ref = parent_; 1538 if (ref instanceof String) { 1539 com.google.protobuf.ByteString b = 1540 com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref); 1541 parent_ = b; 1542 return b; 1543 } else { 1544 return (com.google.protobuf.ByteString) ref; 1545 } 1546 } 1547 /** 1548 * 1549 * 1550 * <pre> 1551 * Required. The parent, which owns this collection of documents. 1552 * Format: projects/{project_number}/locations/{location}. 1553 * </pre> 1554 * 1555 * <code> 1556 * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 1557 * </code> 1558 * 1559 * @param value The parent to set. 1560 * @return This builder for chaining. 1561 */ setParent(java.lang.String value)1562 public Builder setParent(java.lang.String value) { 1563 if (value == null) { 1564 throw new NullPointerException(); 1565 } 1566 parent_ = value; 1567 bitField0_ |= 0x00000001; 1568 onChanged(); 1569 return this; 1570 } 1571 /** 1572 * 1573 * 1574 * <pre> 1575 * Required. The parent, which owns this collection of documents. 1576 * Format: projects/{project_number}/locations/{location}. 1577 * </pre> 1578 * 1579 * <code> 1580 * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 1581 * </code> 1582 * 1583 * @return This builder for chaining. 1584 */ clearParent()1585 public Builder clearParent() { 1586 parent_ = getDefaultInstance().getParent(); 1587 bitField0_ = (bitField0_ & ~0x00000001); 1588 onChanged(); 1589 return this; 1590 } 1591 /** 1592 * 1593 * 1594 * <pre> 1595 * Required. The parent, which owns this collection of documents. 1596 * Format: projects/{project_number}/locations/{location}. 1597 * </pre> 1598 * 1599 * <code> 1600 * string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 1601 * </code> 1602 * 1603 * @param value The bytes for parent to set. 1604 * @return This builder for chaining. 1605 */ setParentBytes(com.google.protobuf.ByteString value)1606 public Builder setParentBytes(com.google.protobuf.ByteString value) { 1607 if (value == null) { 1608 throw new NullPointerException(); 1609 } 1610 checkByteStringIsUtf8(value); 1611 parent_ = value; 1612 bitField0_ |= 0x00000001; 1613 onChanged(); 1614 return this; 1615 } 1616 1617 private com.google.cloud.contentwarehouse.v1.RequestMetadata requestMetadata_; 1618 private com.google.protobuf.SingleFieldBuilderV3< 1619 com.google.cloud.contentwarehouse.v1.RequestMetadata, 1620 com.google.cloud.contentwarehouse.v1.RequestMetadata.Builder, 1621 com.google.cloud.contentwarehouse.v1.RequestMetadataOrBuilder> 1622 requestMetadataBuilder_; 1623 /** 1624 * 1625 * 1626 * <pre> 1627 * The meta information collected about the end user, used to enforce access 1628 * control and improve the search quality of the service. 1629 * </pre> 1630 * 1631 * <code>.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;</code> 1632 * 1633 * @return Whether the requestMetadata field is set. 1634 */ hasRequestMetadata()1635 public boolean hasRequestMetadata() { 1636 return ((bitField0_ & 0x00000002) != 0); 1637 } 1638 /** 1639 * 1640 * 1641 * <pre> 1642 * The meta information collected about the end user, used to enforce access 1643 * control and improve the search quality of the service. 1644 * </pre> 1645 * 1646 * <code>.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;</code> 1647 * 1648 * @return The requestMetadata. 1649 */ getRequestMetadata()1650 public com.google.cloud.contentwarehouse.v1.RequestMetadata getRequestMetadata() { 1651 if (requestMetadataBuilder_ == null) { 1652 return requestMetadata_ == null 1653 ? com.google.cloud.contentwarehouse.v1.RequestMetadata.getDefaultInstance() 1654 : requestMetadata_; 1655 } else { 1656 return requestMetadataBuilder_.getMessage(); 1657 } 1658 } 1659 /** 1660 * 1661 * 1662 * <pre> 1663 * The meta information collected about the end user, used to enforce access 1664 * control and improve the search quality of the service. 1665 * </pre> 1666 * 1667 * <code>.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;</code> 1668 */ setRequestMetadata(com.google.cloud.contentwarehouse.v1.RequestMetadata value)1669 public Builder setRequestMetadata(com.google.cloud.contentwarehouse.v1.RequestMetadata value) { 1670 if (requestMetadataBuilder_ == null) { 1671 if (value == null) { 1672 throw new NullPointerException(); 1673 } 1674 requestMetadata_ = value; 1675 } else { 1676 requestMetadataBuilder_.setMessage(value); 1677 } 1678 bitField0_ |= 0x00000002; 1679 onChanged(); 1680 return this; 1681 } 1682 /** 1683 * 1684 * 1685 * <pre> 1686 * The meta information collected about the end user, used to enforce access 1687 * control and improve the search quality of the service. 1688 * </pre> 1689 * 1690 * <code>.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;</code> 1691 */ setRequestMetadata( com.google.cloud.contentwarehouse.v1.RequestMetadata.Builder builderForValue)1692 public Builder setRequestMetadata( 1693 com.google.cloud.contentwarehouse.v1.RequestMetadata.Builder builderForValue) { 1694 if (requestMetadataBuilder_ == null) { 1695 requestMetadata_ = builderForValue.build(); 1696 } else { 1697 requestMetadataBuilder_.setMessage(builderForValue.build()); 1698 } 1699 bitField0_ |= 0x00000002; 1700 onChanged(); 1701 return this; 1702 } 1703 /** 1704 * 1705 * 1706 * <pre> 1707 * The meta information collected about the end user, used to enforce access 1708 * control and improve the search quality of the service. 1709 * </pre> 1710 * 1711 * <code>.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;</code> 1712 */ mergeRequestMetadata( com.google.cloud.contentwarehouse.v1.RequestMetadata value)1713 public Builder mergeRequestMetadata( 1714 com.google.cloud.contentwarehouse.v1.RequestMetadata value) { 1715 if (requestMetadataBuilder_ == null) { 1716 if (((bitField0_ & 0x00000002) != 0) 1717 && requestMetadata_ != null 1718 && requestMetadata_ 1719 != com.google.cloud.contentwarehouse.v1.RequestMetadata.getDefaultInstance()) { 1720 getRequestMetadataBuilder().mergeFrom(value); 1721 } else { 1722 requestMetadata_ = value; 1723 } 1724 } else { 1725 requestMetadataBuilder_.mergeFrom(value); 1726 } 1727 bitField0_ |= 0x00000002; 1728 onChanged(); 1729 return this; 1730 } 1731 /** 1732 * 1733 * 1734 * <pre> 1735 * The meta information collected about the end user, used to enforce access 1736 * control and improve the search quality of the service. 1737 * </pre> 1738 * 1739 * <code>.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;</code> 1740 */ clearRequestMetadata()1741 public Builder clearRequestMetadata() { 1742 bitField0_ = (bitField0_ & ~0x00000002); 1743 requestMetadata_ = null; 1744 if (requestMetadataBuilder_ != null) { 1745 requestMetadataBuilder_.dispose(); 1746 requestMetadataBuilder_ = null; 1747 } 1748 onChanged(); 1749 return this; 1750 } 1751 /** 1752 * 1753 * 1754 * <pre> 1755 * The meta information collected about the end user, used to enforce access 1756 * control and improve the search quality of the service. 1757 * </pre> 1758 * 1759 * <code>.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;</code> 1760 */ 1761 public com.google.cloud.contentwarehouse.v1.RequestMetadata.Builder getRequestMetadataBuilder()1762 getRequestMetadataBuilder() { 1763 bitField0_ |= 0x00000002; 1764 onChanged(); 1765 return getRequestMetadataFieldBuilder().getBuilder(); 1766 } 1767 /** 1768 * 1769 * 1770 * <pre> 1771 * The meta information collected about the end user, used to enforce access 1772 * control and improve the search quality of the service. 1773 * </pre> 1774 * 1775 * <code>.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;</code> 1776 */ 1777 public com.google.cloud.contentwarehouse.v1.RequestMetadataOrBuilder getRequestMetadataOrBuilder()1778 getRequestMetadataOrBuilder() { 1779 if (requestMetadataBuilder_ != null) { 1780 return requestMetadataBuilder_.getMessageOrBuilder(); 1781 } else { 1782 return requestMetadata_ == null 1783 ? com.google.cloud.contentwarehouse.v1.RequestMetadata.getDefaultInstance() 1784 : requestMetadata_; 1785 } 1786 } 1787 /** 1788 * 1789 * 1790 * <pre> 1791 * The meta information collected about the end user, used to enforce access 1792 * control and improve the search quality of the service. 1793 * </pre> 1794 * 1795 * <code>.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 3;</code> 1796 */ 1797 private com.google.protobuf.SingleFieldBuilderV3< 1798 com.google.cloud.contentwarehouse.v1.RequestMetadata, 1799 com.google.cloud.contentwarehouse.v1.RequestMetadata.Builder, 1800 com.google.cloud.contentwarehouse.v1.RequestMetadataOrBuilder> getRequestMetadataFieldBuilder()1801 getRequestMetadataFieldBuilder() { 1802 if (requestMetadataBuilder_ == null) { 1803 requestMetadataBuilder_ = 1804 new com.google.protobuf.SingleFieldBuilderV3< 1805 com.google.cloud.contentwarehouse.v1.RequestMetadata, 1806 com.google.cloud.contentwarehouse.v1.RequestMetadata.Builder, 1807 com.google.cloud.contentwarehouse.v1.RequestMetadataOrBuilder>( 1808 getRequestMetadata(), getParentForChildren(), isClean()); 1809 requestMetadata_ = null; 1810 } 1811 return requestMetadataBuilder_; 1812 } 1813 1814 private com.google.cloud.contentwarehouse.v1.DocumentQuery documentQuery_; 1815 private com.google.protobuf.SingleFieldBuilderV3< 1816 com.google.cloud.contentwarehouse.v1.DocumentQuery, 1817 com.google.cloud.contentwarehouse.v1.DocumentQuery.Builder, 1818 com.google.cloud.contentwarehouse.v1.DocumentQueryOrBuilder> 1819 documentQueryBuilder_; 1820 /** 1821 * 1822 * 1823 * <pre> 1824 * Query used to search against documents (keyword, filters, etc.). 1825 * </pre> 1826 * 1827 * <code>.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;</code> 1828 * 1829 * @return Whether the documentQuery field is set. 1830 */ hasDocumentQuery()1831 public boolean hasDocumentQuery() { 1832 return ((bitField0_ & 0x00000004) != 0); 1833 } 1834 /** 1835 * 1836 * 1837 * <pre> 1838 * Query used to search against documents (keyword, filters, etc.). 1839 * </pre> 1840 * 1841 * <code>.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;</code> 1842 * 1843 * @return The documentQuery. 1844 */ getDocumentQuery()1845 public com.google.cloud.contentwarehouse.v1.DocumentQuery getDocumentQuery() { 1846 if (documentQueryBuilder_ == null) { 1847 return documentQuery_ == null 1848 ? com.google.cloud.contentwarehouse.v1.DocumentQuery.getDefaultInstance() 1849 : documentQuery_; 1850 } else { 1851 return documentQueryBuilder_.getMessage(); 1852 } 1853 } 1854 /** 1855 * 1856 * 1857 * <pre> 1858 * Query used to search against documents (keyword, filters, etc.). 1859 * </pre> 1860 * 1861 * <code>.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;</code> 1862 */ setDocumentQuery(com.google.cloud.contentwarehouse.v1.DocumentQuery value)1863 public Builder setDocumentQuery(com.google.cloud.contentwarehouse.v1.DocumentQuery value) { 1864 if (documentQueryBuilder_ == null) { 1865 if (value == null) { 1866 throw new NullPointerException(); 1867 } 1868 documentQuery_ = value; 1869 } else { 1870 documentQueryBuilder_.setMessage(value); 1871 } 1872 bitField0_ |= 0x00000004; 1873 onChanged(); 1874 return this; 1875 } 1876 /** 1877 * 1878 * 1879 * <pre> 1880 * Query used to search against documents (keyword, filters, etc.). 1881 * </pre> 1882 * 1883 * <code>.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;</code> 1884 */ setDocumentQuery( com.google.cloud.contentwarehouse.v1.DocumentQuery.Builder builderForValue)1885 public Builder setDocumentQuery( 1886 com.google.cloud.contentwarehouse.v1.DocumentQuery.Builder builderForValue) { 1887 if (documentQueryBuilder_ == null) { 1888 documentQuery_ = builderForValue.build(); 1889 } else { 1890 documentQueryBuilder_.setMessage(builderForValue.build()); 1891 } 1892 bitField0_ |= 0x00000004; 1893 onChanged(); 1894 return this; 1895 } 1896 /** 1897 * 1898 * 1899 * <pre> 1900 * Query used to search against documents (keyword, filters, etc.). 1901 * </pre> 1902 * 1903 * <code>.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;</code> 1904 */ mergeDocumentQuery(com.google.cloud.contentwarehouse.v1.DocumentQuery value)1905 public Builder mergeDocumentQuery(com.google.cloud.contentwarehouse.v1.DocumentQuery value) { 1906 if (documentQueryBuilder_ == null) { 1907 if (((bitField0_ & 0x00000004) != 0) 1908 && documentQuery_ != null 1909 && documentQuery_ 1910 != com.google.cloud.contentwarehouse.v1.DocumentQuery.getDefaultInstance()) { 1911 getDocumentQueryBuilder().mergeFrom(value); 1912 } else { 1913 documentQuery_ = value; 1914 } 1915 } else { 1916 documentQueryBuilder_.mergeFrom(value); 1917 } 1918 bitField0_ |= 0x00000004; 1919 onChanged(); 1920 return this; 1921 } 1922 /** 1923 * 1924 * 1925 * <pre> 1926 * Query used to search against documents (keyword, filters, etc.). 1927 * </pre> 1928 * 1929 * <code>.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;</code> 1930 */ clearDocumentQuery()1931 public Builder clearDocumentQuery() { 1932 bitField0_ = (bitField0_ & ~0x00000004); 1933 documentQuery_ = null; 1934 if (documentQueryBuilder_ != null) { 1935 documentQueryBuilder_.dispose(); 1936 documentQueryBuilder_ = null; 1937 } 1938 onChanged(); 1939 return this; 1940 } 1941 /** 1942 * 1943 * 1944 * <pre> 1945 * Query used to search against documents (keyword, filters, etc.). 1946 * </pre> 1947 * 1948 * <code>.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;</code> 1949 */ getDocumentQueryBuilder()1950 public com.google.cloud.contentwarehouse.v1.DocumentQuery.Builder getDocumentQueryBuilder() { 1951 bitField0_ |= 0x00000004; 1952 onChanged(); 1953 return getDocumentQueryFieldBuilder().getBuilder(); 1954 } 1955 /** 1956 * 1957 * 1958 * <pre> 1959 * Query used to search against documents (keyword, filters, etc.). 1960 * </pre> 1961 * 1962 * <code>.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;</code> 1963 */ getDocumentQueryOrBuilder()1964 public com.google.cloud.contentwarehouse.v1.DocumentQueryOrBuilder getDocumentQueryOrBuilder() { 1965 if (documentQueryBuilder_ != null) { 1966 return documentQueryBuilder_.getMessageOrBuilder(); 1967 } else { 1968 return documentQuery_ == null 1969 ? com.google.cloud.contentwarehouse.v1.DocumentQuery.getDefaultInstance() 1970 : documentQuery_; 1971 } 1972 } 1973 /** 1974 * 1975 * 1976 * <pre> 1977 * Query used to search against documents (keyword, filters, etc.). 1978 * </pre> 1979 * 1980 * <code>.google.cloud.contentwarehouse.v1.DocumentQuery document_query = 4;</code> 1981 */ 1982 private com.google.protobuf.SingleFieldBuilderV3< 1983 com.google.cloud.contentwarehouse.v1.DocumentQuery, 1984 com.google.cloud.contentwarehouse.v1.DocumentQuery.Builder, 1985 com.google.cloud.contentwarehouse.v1.DocumentQueryOrBuilder> getDocumentQueryFieldBuilder()1986 getDocumentQueryFieldBuilder() { 1987 if (documentQueryBuilder_ == null) { 1988 documentQueryBuilder_ = 1989 new com.google.protobuf.SingleFieldBuilderV3< 1990 com.google.cloud.contentwarehouse.v1.DocumentQuery, 1991 com.google.cloud.contentwarehouse.v1.DocumentQuery.Builder, 1992 com.google.cloud.contentwarehouse.v1.DocumentQueryOrBuilder>( 1993 getDocumentQuery(), getParentForChildren(), isClean()); 1994 documentQuery_ = null; 1995 } 1996 return documentQueryBuilder_; 1997 } 1998 1999 private int offset_; 2000 /** 2001 * 2002 * 2003 * <pre> 2004 * An integer that specifies the current offset (that is, starting result 2005 * location, amongst the documents deemed by the API as relevant) in search 2006 * results. This field is only considered if 2007 * [page_token][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.page_token] 2008 * is unset. 2009 * The maximum allowed value is 5000. Otherwise an error is thrown. 2010 * For example, 0 means to return results starting from the first matching 2011 * document, and 10 means to return from the 11th document. This can be used 2012 * for pagination, (for example, pageSize = 10 and offset = 10 means to return 2013 * from the second page). 2014 * </pre> 2015 * 2016 * <code>int32 offset = 5;</code> 2017 * 2018 * @return The offset. 2019 */ 2020 @java.lang.Override getOffset()2021 public int getOffset() { 2022 return offset_; 2023 } 2024 /** 2025 * 2026 * 2027 * <pre> 2028 * An integer that specifies the current offset (that is, starting result 2029 * location, amongst the documents deemed by the API as relevant) in search 2030 * results. This field is only considered if 2031 * [page_token][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.page_token] 2032 * is unset. 2033 * The maximum allowed value is 5000. Otherwise an error is thrown. 2034 * For example, 0 means to return results starting from the first matching 2035 * document, and 10 means to return from the 11th document. This can be used 2036 * for pagination, (for example, pageSize = 10 and offset = 10 means to return 2037 * from the second page). 2038 * </pre> 2039 * 2040 * <code>int32 offset = 5;</code> 2041 * 2042 * @param value The offset to set. 2043 * @return This builder for chaining. 2044 */ setOffset(int value)2045 public Builder setOffset(int value) { 2046 2047 offset_ = value; 2048 bitField0_ |= 0x00000008; 2049 onChanged(); 2050 return this; 2051 } 2052 /** 2053 * 2054 * 2055 * <pre> 2056 * An integer that specifies the current offset (that is, starting result 2057 * location, amongst the documents deemed by the API as relevant) in search 2058 * results. This field is only considered if 2059 * [page_token][google.cloud.contentwarehouse.v1.SearchDocumentsRequest.page_token] 2060 * is unset. 2061 * The maximum allowed value is 5000. Otherwise an error is thrown. 2062 * For example, 0 means to return results starting from the first matching 2063 * document, and 10 means to return from the 11th document. This can be used 2064 * for pagination, (for example, pageSize = 10 and offset = 10 means to return 2065 * from the second page). 2066 * </pre> 2067 * 2068 * <code>int32 offset = 5;</code> 2069 * 2070 * @return This builder for chaining. 2071 */ clearOffset()2072 public Builder clearOffset() { 2073 bitField0_ = (bitField0_ & ~0x00000008); 2074 offset_ = 0; 2075 onChanged(); 2076 return this; 2077 } 2078 2079 private int pageSize_; 2080 /** 2081 * 2082 * 2083 * <pre> 2084 * A limit on the number of documents returned in the search results. 2085 * Increasing this value above the default value of 10 can increase search 2086 * response time. The value can be between 1 and 100. 2087 * </pre> 2088 * 2089 * <code>int32 page_size = 6;</code> 2090 * 2091 * @return The pageSize. 2092 */ 2093 @java.lang.Override getPageSize()2094 public int getPageSize() { 2095 return pageSize_; 2096 } 2097 /** 2098 * 2099 * 2100 * <pre> 2101 * A limit on the number of documents returned in the search results. 2102 * Increasing this value above the default value of 10 can increase search 2103 * response time. The value can be between 1 and 100. 2104 * </pre> 2105 * 2106 * <code>int32 page_size = 6;</code> 2107 * 2108 * @param value The pageSize to set. 2109 * @return This builder for chaining. 2110 */ setPageSize(int value)2111 public Builder setPageSize(int value) { 2112 2113 pageSize_ = value; 2114 bitField0_ |= 0x00000010; 2115 onChanged(); 2116 return this; 2117 } 2118 /** 2119 * 2120 * 2121 * <pre> 2122 * A limit on the number of documents returned in the search results. 2123 * Increasing this value above the default value of 10 can increase search 2124 * response time. The value can be between 1 and 100. 2125 * </pre> 2126 * 2127 * <code>int32 page_size = 6;</code> 2128 * 2129 * @return This builder for chaining. 2130 */ clearPageSize()2131 public Builder clearPageSize() { 2132 bitField0_ = (bitField0_ & ~0x00000010); 2133 pageSize_ = 0; 2134 onChanged(); 2135 return this; 2136 } 2137 2138 private java.lang.Object pageToken_ = ""; 2139 /** 2140 * 2141 * 2142 * <pre> 2143 * The token specifying the current offset within search results. 2144 * See 2145 * [SearchDocumentsResponse.next_page_token][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.next_page_token] 2146 * for an explanation of how to obtain the next set of query results. 2147 * </pre> 2148 * 2149 * <code>string page_token = 7;</code> 2150 * 2151 * @return The pageToken. 2152 */ getPageToken()2153 public java.lang.String getPageToken() { 2154 java.lang.Object ref = pageToken_; 2155 if (!(ref instanceof java.lang.String)) { 2156 com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref; 2157 java.lang.String s = bs.toStringUtf8(); 2158 pageToken_ = s; 2159 return s; 2160 } else { 2161 return (java.lang.String) ref; 2162 } 2163 } 2164 /** 2165 * 2166 * 2167 * <pre> 2168 * The token specifying the current offset within search results. 2169 * See 2170 * [SearchDocumentsResponse.next_page_token][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.next_page_token] 2171 * for an explanation of how to obtain the next set of query results. 2172 * </pre> 2173 * 2174 * <code>string page_token = 7;</code> 2175 * 2176 * @return The bytes for pageToken. 2177 */ getPageTokenBytes()2178 public com.google.protobuf.ByteString getPageTokenBytes() { 2179 java.lang.Object ref = pageToken_; 2180 if (ref instanceof String) { 2181 com.google.protobuf.ByteString b = 2182 com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref); 2183 pageToken_ = b; 2184 return b; 2185 } else { 2186 return (com.google.protobuf.ByteString) ref; 2187 } 2188 } 2189 /** 2190 * 2191 * 2192 * <pre> 2193 * The token specifying the current offset within search results. 2194 * See 2195 * [SearchDocumentsResponse.next_page_token][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.next_page_token] 2196 * for an explanation of how to obtain the next set of query results. 2197 * </pre> 2198 * 2199 * <code>string page_token = 7;</code> 2200 * 2201 * @param value The pageToken to set. 2202 * @return This builder for chaining. 2203 */ setPageToken(java.lang.String value)2204 public Builder setPageToken(java.lang.String value) { 2205 if (value == null) { 2206 throw new NullPointerException(); 2207 } 2208 pageToken_ = value; 2209 bitField0_ |= 0x00000020; 2210 onChanged(); 2211 return this; 2212 } 2213 /** 2214 * 2215 * 2216 * <pre> 2217 * The token specifying the current offset within search results. 2218 * See 2219 * [SearchDocumentsResponse.next_page_token][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.next_page_token] 2220 * for an explanation of how to obtain the next set of query results. 2221 * </pre> 2222 * 2223 * <code>string page_token = 7;</code> 2224 * 2225 * @return This builder for chaining. 2226 */ clearPageToken()2227 public Builder clearPageToken() { 2228 pageToken_ = getDefaultInstance().getPageToken(); 2229 bitField0_ = (bitField0_ & ~0x00000020); 2230 onChanged(); 2231 return this; 2232 } 2233 /** 2234 * 2235 * 2236 * <pre> 2237 * The token specifying the current offset within search results. 2238 * See 2239 * [SearchDocumentsResponse.next_page_token][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.next_page_token] 2240 * for an explanation of how to obtain the next set of query results. 2241 * </pre> 2242 * 2243 * <code>string page_token = 7;</code> 2244 * 2245 * @param value The bytes for pageToken to set. 2246 * @return This builder for chaining. 2247 */ setPageTokenBytes(com.google.protobuf.ByteString value)2248 public Builder setPageTokenBytes(com.google.protobuf.ByteString value) { 2249 if (value == null) { 2250 throw new NullPointerException(); 2251 } 2252 checkByteStringIsUtf8(value); 2253 pageToken_ = value; 2254 bitField0_ |= 0x00000020; 2255 onChanged(); 2256 return this; 2257 } 2258 2259 private java.lang.Object orderBy_ = ""; 2260 /** 2261 * 2262 * 2263 * <pre> 2264 * The criteria determining how search results are sorted. For non-empty 2265 * query, default is `"relevance desc"`. For empty query, default is 2266 * `"upload_date desc"`. 2267 * Supported options are: 2268 * * `"relevance desc"`: By relevance descending, as determined by the API 2269 * algorithms. 2270 * * `"upload_date desc"`: By upload date descending. 2271 * * `"upload_date"`: By upload date ascending. 2272 * * `"update_date desc"`: By last updated date descending. 2273 * * `"update_date"`: By last updated date ascending. 2274 * * `"retrieval_importance desc"`: By retrieval importance of properties 2275 * descending. This feature is still under development, please do not use 2276 * unless otherwise instructed to do so. 2277 * </pre> 2278 * 2279 * <code>string order_by = 8;</code> 2280 * 2281 * @return The orderBy. 2282 */ getOrderBy()2283 public java.lang.String getOrderBy() { 2284 java.lang.Object ref = orderBy_; 2285 if (!(ref instanceof java.lang.String)) { 2286 com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref; 2287 java.lang.String s = bs.toStringUtf8(); 2288 orderBy_ = s; 2289 return s; 2290 } else { 2291 return (java.lang.String) ref; 2292 } 2293 } 2294 /** 2295 * 2296 * 2297 * <pre> 2298 * The criteria determining how search results are sorted. For non-empty 2299 * query, default is `"relevance desc"`. For empty query, default is 2300 * `"upload_date desc"`. 2301 * Supported options are: 2302 * * `"relevance desc"`: By relevance descending, as determined by the API 2303 * algorithms. 2304 * * `"upload_date desc"`: By upload date descending. 2305 * * `"upload_date"`: By upload date ascending. 2306 * * `"update_date desc"`: By last updated date descending. 2307 * * `"update_date"`: By last updated date ascending. 2308 * * `"retrieval_importance desc"`: By retrieval importance of properties 2309 * descending. This feature is still under development, please do not use 2310 * unless otherwise instructed to do so. 2311 * </pre> 2312 * 2313 * <code>string order_by = 8;</code> 2314 * 2315 * @return The bytes for orderBy. 2316 */ getOrderByBytes()2317 public com.google.protobuf.ByteString getOrderByBytes() { 2318 java.lang.Object ref = orderBy_; 2319 if (ref instanceof String) { 2320 com.google.protobuf.ByteString b = 2321 com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref); 2322 orderBy_ = b; 2323 return b; 2324 } else { 2325 return (com.google.protobuf.ByteString) ref; 2326 } 2327 } 2328 /** 2329 * 2330 * 2331 * <pre> 2332 * The criteria determining how search results are sorted. For non-empty 2333 * query, default is `"relevance desc"`. For empty query, default is 2334 * `"upload_date desc"`. 2335 * Supported options are: 2336 * * `"relevance desc"`: By relevance descending, as determined by the API 2337 * algorithms. 2338 * * `"upload_date desc"`: By upload date descending. 2339 * * `"upload_date"`: By upload date ascending. 2340 * * `"update_date desc"`: By last updated date descending. 2341 * * `"update_date"`: By last updated date ascending. 2342 * * `"retrieval_importance desc"`: By retrieval importance of properties 2343 * descending. This feature is still under development, please do not use 2344 * unless otherwise instructed to do so. 2345 * </pre> 2346 * 2347 * <code>string order_by = 8;</code> 2348 * 2349 * @param value The orderBy to set. 2350 * @return This builder for chaining. 2351 */ setOrderBy(java.lang.String value)2352 public Builder setOrderBy(java.lang.String value) { 2353 if (value == null) { 2354 throw new NullPointerException(); 2355 } 2356 orderBy_ = value; 2357 bitField0_ |= 0x00000040; 2358 onChanged(); 2359 return this; 2360 } 2361 /** 2362 * 2363 * 2364 * <pre> 2365 * The criteria determining how search results are sorted. For non-empty 2366 * query, default is `"relevance desc"`. For empty query, default is 2367 * `"upload_date desc"`. 2368 * Supported options are: 2369 * * `"relevance desc"`: By relevance descending, as determined by the API 2370 * algorithms. 2371 * * `"upload_date desc"`: By upload date descending. 2372 * * `"upload_date"`: By upload date ascending. 2373 * * `"update_date desc"`: By last updated date descending. 2374 * * `"update_date"`: By last updated date ascending. 2375 * * `"retrieval_importance desc"`: By retrieval importance of properties 2376 * descending. This feature is still under development, please do not use 2377 * unless otherwise instructed to do so. 2378 * </pre> 2379 * 2380 * <code>string order_by = 8;</code> 2381 * 2382 * @return This builder for chaining. 2383 */ clearOrderBy()2384 public Builder clearOrderBy() { 2385 orderBy_ = getDefaultInstance().getOrderBy(); 2386 bitField0_ = (bitField0_ & ~0x00000040); 2387 onChanged(); 2388 return this; 2389 } 2390 /** 2391 * 2392 * 2393 * <pre> 2394 * The criteria determining how search results are sorted. For non-empty 2395 * query, default is `"relevance desc"`. For empty query, default is 2396 * `"upload_date desc"`. 2397 * Supported options are: 2398 * * `"relevance desc"`: By relevance descending, as determined by the API 2399 * algorithms. 2400 * * `"upload_date desc"`: By upload date descending. 2401 * * `"upload_date"`: By upload date ascending. 2402 * * `"update_date desc"`: By last updated date descending. 2403 * * `"update_date"`: By last updated date ascending. 2404 * * `"retrieval_importance desc"`: By retrieval importance of properties 2405 * descending. This feature is still under development, please do not use 2406 * unless otherwise instructed to do so. 2407 * </pre> 2408 * 2409 * <code>string order_by = 8;</code> 2410 * 2411 * @param value The bytes for orderBy to set. 2412 * @return This builder for chaining. 2413 */ setOrderByBytes(com.google.protobuf.ByteString value)2414 public Builder setOrderByBytes(com.google.protobuf.ByteString value) { 2415 if (value == null) { 2416 throw new NullPointerException(); 2417 } 2418 checkByteStringIsUtf8(value); 2419 orderBy_ = value; 2420 bitField0_ |= 0x00000040; 2421 onChanged(); 2422 return this; 2423 } 2424 2425 private java.util.List<com.google.cloud.contentwarehouse.v1.HistogramQuery> histogramQueries_ = 2426 java.util.Collections.emptyList(); 2427 ensureHistogramQueriesIsMutable()2428 private void ensureHistogramQueriesIsMutable() { 2429 if (!((bitField0_ & 0x00000080) != 0)) { 2430 histogramQueries_ = 2431 new java.util.ArrayList<com.google.cloud.contentwarehouse.v1.HistogramQuery>( 2432 histogramQueries_); 2433 bitField0_ |= 0x00000080; 2434 } 2435 } 2436 2437 private com.google.protobuf.RepeatedFieldBuilderV3< 2438 com.google.cloud.contentwarehouse.v1.HistogramQuery, 2439 com.google.cloud.contentwarehouse.v1.HistogramQuery.Builder, 2440 com.google.cloud.contentwarehouse.v1.HistogramQueryOrBuilder> 2441 histogramQueriesBuilder_; 2442 2443 /** 2444 * 2445 * 2446 * <pre> 2447 * An expression specifying a histogram request against matching 2448 * documents. Expression syntax is an aggregation function call with 2449 * histogram facets and other options. 2450 * The following aggregation functions are supported: 2451 * * `count(string_histogram_facet)`: Count the number of matching entities 2452 * for each distinct attribute value. 2453 * Data types: 2454 * * Histogram facet (aka filterable properties): Facet names with format 2455 * &lt;schema id&gt;.&lt;facet&gt;. Facets will have the 2456 * format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child 2457 * facet, then the parent hierarchy needs to be specified separated by 2458 * dots in the prefix after the schema id. Thus, the format for a multi- 2459 * level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. 2460 * &lt;child facet name&gt;. Example: 2461 * schema123.root_parent_facet.middle_facet.child_facet 2462 * * DocumentSchemaId: (with no schema id prefix) to get 2463 * histograms for each document type (returns the schema id path, e.g. 2464 * projects/12345/locations/us-west/documentSchemas/abc123). 2465 * Example expression: 2466 * * Document type counts: 2467 * count('DocumentSchemaId') 2468 * * For schema id, abc123, get the counts for MORTGAGE_TYPE: 2469 * count('abc123.MORTGAGE_TYPE') 2470 * </pre> 2471 * 2472 * <code>repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;</code> 2473 */ 2474 public java.util.List<com.google.cloud.contentwarehouse.v1.HistogramQuery> getHistogramQueriesList()2475 getHistogramQueriesList() { 2476 if (histogramQueriesBuilder_ == null) { 2477 return java.util.Collections.unmodifiableList(histogramQueries_); 2478 } else { 2479 return histogramQueriesBuilder_.getMessageList(); 2480 } 2481 } 2482 /** 2483 * 2484 * 2485 * <pre> 2486 * An expression specifying a histogram request against matching 2487 * documents. Expression syntax is an aggregation function call with 2488 * histogram facets and other options. 2489 * The following aggregation functions are supported: 2490 * * `count(string_histogram_facet)`: Count the number of matching entities 2491 * for each distinct attribute value. 2492 * Data types: 2493 * * Histogram facet (aka filterable properties): Facet names with format 2494 * &lt;schema id&gt;.&lt;facet&gt;. Facets will have the 2495 * format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child 2496 * facet, then the parent hierarchy needs to be specified separated by 2497 * dots in the prefix after the schema id. Thus, the format for a multi- 2498 * level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. 2499 * &lt;child facet name&gt;. Example: 2500 * schema123.root_parent_facet.middle_facet.child_facet 2501 * * DocumentSchemaId: (with no schema id prefix) to get 2502 * histograms for each document type (returns the schema id path, e.g. 2503 * projects/12345/locations/us-west/documentSchemas/abc123). 2504 * Example expression: 2505 * * Document type counts: 2506 * count('DocumentSchemaId') 2507 * * For schema id, abc123, get the counts for MORTGAGE_TYPE: 2508 * count('abc123.MORTGAGE_TYPE') 2509 * </pre> 2510 * 2511 * <code>repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;</code> 2512 */ getHistogramQueriesCount()2513 public int getHistogramQueriesCount() { 2514 if (histogramQueriesBuilder_ == null) { 2515 return histogramQueries_.size(); 2516 } else { 2517 return histogramQueriesBuilder_.getCount(); 2518 } 2519 } 2520 /** 2521 * 2522 * 2523 * <pre> 2524 * An expression specifying a histogram request against matching 2525 * documents. Expression syntax is an aggregation function call with 2526 * histogram facets and other options. 2527 * The following aggregation functions are supported: 2528 * * `count(string_histogram_facet)`: Count the number of matching entities 2529 * for each distinct attribute value. 2530 * Data types: 2531 * * Histogram facet (aka filterable properties): Facet names with format 2532 * &lt;schema id&gt;.&lt;facet&gt;. Facets will have the 2533 * format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child 2534 * facet, then the parent hierarchy needs to be specified separated by 2535 * dots in the prefix after the schema id. Thus, the format for a multi- 2536 * level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. 2537 * &lt;child facet name&gt;. Example: 2538 * schema123.root_parent_facet.middle_facet.child_facet 2539 * * DocumentSchemaId: (with no schema id prefix) to get 2540 * histograms for each document type (returns the schema id path, e.g. 2541 * projects/12345/locations/us-west/documentSchemas/abc123). 2542 * Example expression: 2543 * * Document type counts: 2544 * count('DocumentSchemaId') 2545 * * For schema id, abc123, get the counts for MORTGAGE_TYPE: 2546 * count('abc123.MORTGAGE_TYPE') 2547 * </pre> 2548 * 2549 * <code>repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;</code> 2550 */ getHistogramQueries(int index)2551 public com.google.cloud.contentwarehouse.v1.HistogramQuery getHistogramQueries(int index) { 2552 if (histogramQueriesBuilder_ == null) { 2553 return histogramQueries_.get(index); 2554 } else { 2555 return histogramQueriesBuilder_.getMessage(index); 2556 } 2557 } 2558 /** 2559 * 2560 * 2561 * <pre> 2562 * An expression specifying a histogram request against matching 2563 * documents. Expression syntax is an aggregation function call with 2564 * histogram facets and other options. 2565 * The following aggregation functions are supported: 2566 * * `count(string_histogram_facet)`: Count the number of matching entities 2567 * for each distinct attribute value. 2568 * Data types: 2569 * * Histogram facet (aka filterable properties): Facet names with format 2570 * &lt;schema id&gt;.&lt;facet&gt;. Facets will have the 2571 * format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child 2572 * facet, then the parent hierarchy needs to be specified separated by 2573 * dots in the prefix after the schema id. Thus, the format for a multi- 2574 * level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. 2575 * &lt;child facet name&gt;. Example: 2576 * schema123.root_parent_facet.middle_facet.child_facet 2577 * * DocumentSchemaId: (with no schema id prefix) to get 2578 * histograms for each document type (returns the schema id path, e.g. 2579 * projects/12345/locations/us-west/documentSchemas/abc123). 2580 * Example expression: 2581 * * Document type counts: 2582 * count('DocumentSchemaId') 2583 * * For schema id, abc123, get the counts for MORTGAGE_TYPE: 2584 * count('abc123.MORTGAGE_TYPE') 2585 * </pre> 2586 * 2587 * <code>repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;</code> 2588 */ setHistogramQueries( int index, com.google.cloud.contentwarehouse.v1.HistogramQuery value)2589 public Builder setHistogramQueries( 2590 int index, com.google.cloud.contentwarehouse.v1.HistogramQuery value) { 2591 if (histogramQueriesBuilder_ == null) { 2592 if (value == null) { 2593 throw new NullPointerException(); 2594 } 2595 ensureHistogramQueriesIsMutable(); 2596 histogramQueries_.set(index, value); 2597 onChanged(); 2598 } else { 2599 histogramQueriesBuilder_.setMessage(index, value); 2600 } 2601 return this; 2602 } 2603 /** 2604 * 2605 * 2606 * <pre> 2607 * An expression specifying a histogram request against matching 2608 * documents. Expression syntax is an aggregation function call with 2609 * histogram facets and other options. 2610 * The following aggregation functions are supported: 2611 * * `count(string_histogram_facet)`: Count the number of matching entities 2612 * for each distinct attribute value. 2613 * Data types: 2614 * * Histogram facet (aka filterable properties): Facet names with format 2615 * &lt;schema id&gt;.&lt;facet&gt;. Facets will have the 2616 * format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child 2617 * facet, then the parent hierarchy needs to be specified separated by 2618 * dots in the prefix after the schema id. Thus, the format for a multi- 2619 * level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. 2620 * &lt;child facet name&gt;. Example: 2621 * schema123.root_parent_facet.middle_facet.child_facet 2622 * * DocumentSchemaId: (with no schema id prefix) to get 2623 * histograms for each document type (returns the schema id path, e.g. 2624 * projects/12345/locations/us-west/documentSchemas/abc123). 2625 * Example expression: 2626 * * Document type counts: 2627 * count('DocumentSchemaId') 2628 * * For schema id, abc123, get the counts for MORTGAGE_TYPE: 2629 * count('abc123.MORTGAGE_TYPE') 2630 * </pre> 2631 * 2632 * <code>repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;</code> 2633 */ setHistogramQueries( int index, com.google.cloud.contentwarehouse.v1.HistogramQuery.Builder builderForValue)2634 public Builder setHistogramQueries( 2635 int index, com.google.cloud.contentwarehouse.v1.HistogramQuery.Builder builderForValue) { 2636 if (histogramQueriesBuilder_ == null) { 2637 ensureHistogramQueriesIsMutable(); 2638 histogramQueries_.set(index, builderForValue.build()); 2639 onChanged(); 2640 } else { 2641 histogramQueriesBuilder_.setMessage(index, builderForValue.build()); 2642 } 2643 return this; 2644 } 2645 /** 2646 * 2647 * 2648 * <pre> 2649 * An expression specifying a histogram request against matching 2650 * documents. Expression syntax is an aggregation function call with 2651 * histogram facets and other options. 2652 * The following aggregation functions are supported: 2653 * * `count(string_histogram_facet)`: Count the number of matching entities 2654 * for each distinct attribute value. 2655 * Data types: 2656 * * Histogram facet (aka filterable properties): Facet names with format 2657 * &lt;schema id&gt;.&lt;facet&gt;. Facets will have the 2658 * format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child 2659 * facet, then the parent hierarchy needs to be specified separated by 2660 * dots in the prefix after the schema id. Thus, the format for a multi- 2661 * level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. 2662 * &lt;child facet name&gt;. Example: 2663 * schema123.root_parent_facet.middle_facet.child_facet 2664 * * DocumentSchemaId: (with no schema id prefix) to get 2665 * histograms for each document type (returns the schema id path, e.g. 2666 * projects/12345/locations/us-west/documentSchemas/abc123). 2667 * Example expression: 2668 * * Document type counts: 2669 * count('DocumentSchemaId') 2670 * * For schema id, abc123, get the counts for MORTGAGE_TYPE: 2671 * count('abc123.MORTGAGE_TYPE') 2672 * </pre> 2673 * 2674 * <code>repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;</code> 2675 */ addHistogramQueries(com.google.cloud.contentwarehouse.v1.HistogramQuery value)2676 public Builder addHistogramQueries(com.google.cloud.contentwarehouse.v1.HistogramQuery value) { 2677 if (histogramQueriesBuilder_ == null) { 2678 if (value == null) { 2679 throw new NullPointerException(); 2680 } 2681 ensureHistogramQueriesIsMutable(); 2682 histogramQueries_.add(value); 2683 onChanged(); 2684 } else { 2685 histogramQueriesBuilder_.addMessage(value); 2686 } 2687 return this; 2688 } 2689 /** 2690 * 2691 * 2692 * <pre> 2693 * An expression specifying a histogram request against matching 2694 * documents. Expression syntax is an aggregation function call with 2695 * histogram facets and other options. 2696 * The following aggregation functions are supported: 2697 * * `count(string_histogram_facet)`: Count the number of matching entities 2698 * for each distinct attribute value. 2699 * Data types: 2700 * * Histogram facet (aka filterable properties): Facet names with format 2701 * &lt;schema id&gt;.&lt;facet&gt;. Facets will have the 2702 * format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child 2703 * facet, then the parent hierarchy needs to be specified separated by 2704 * dots in the prefix after the schema id. Thus, the format for a multi- 2705 * level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. 2706 * &lt;child facet name&gt;. Example: 2707 * schema123.root_parent_facet.middle_facet.child_facet 2708 * * DocumentSchemaId: (with no schema id prefix) to get 2709 * histograms for each document type (returns the schema id path, e.g. 2710 * projects/12345/locations/us-west/documentSchemas/abc123). 2711 * Example expression: 2712 * * Document type counts: 2713 * count('DocumentSchemaId') 2714 * * For schema id, abc123, get the counts for MORTGAGE_TYPE: 2715 * count('abc123.MORTGAGE_TYPE') 2716 * </pre> 2717 * 2718 * <code>repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;</code> 2719 */ addHistogramQueries( int index, com.google.cloud.contentwarehouse.v1.HistogramQuery value)2720 public Builder addHistogramQueries( 2721 int index, com.google.cloud.contentwarehouse.v1.HistogramQuery value) { 2722 if (histogramQueriesBuilder_ == null) { 2723 if (value == null) { 2724 throw new NullPointerException(); 2725 } 2726 ensureHistogramQueriesIsMutable(); 2727 histogramQueries_.add(index, value); 2728 onChanged(); 2729 } else { 2730 histogramQueriesBuilder_.addMessage(index, value); 2731 } 2732 return this; 2733 } 2734 /** 2735 * 2736 * 2737 * <pre> 2738 * An expression specifying a histogram request against matching 2739 * documents. Expression syntax is an aggregation function call with 2740 * histogram facets and other options. 2741 * The following aggregation functions are supported: 2742 * * `count(string_histogram_facet)`: Count the number of matching entities 2743 * for each distinct attribute value. 2744 * Data types: 2745 * * Histogram facet (aka filterable properties): Facet names with format 2746 * &lt;schema id&gt;.&lt;facet&gt;. Facets will have the 2747 * format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child 2748 * facet, then the parent hierarchy needs to be specified separated by 2749 * dots in the prefix after the schema id. Thus, the format for a multi- 2750 * level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. 2751 * &lt;child facet name&gt;. Example: 2752 * schema123.root_parent_facet.middle_facet.child_facet 2753 * * DocumentSchemaId: (with no schema id prefix) to get 2754 * histograms for each document type (returns the schema id path, e.g. 2755 * projects/12345/locations/us-west/documentSchemas/abc123). 2756 * Example expression: 2757 * * Document type counts: 2758 * count('DocumentSchemaId') 2759 * * For schema id, abc123, get the counts for MORTGAGE_TYPE: 2760 * count('abc123.MORTGAGE_TYPE') 2761 * </pre> 2762 * 2763 * <code>repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;</code> 2764 */ addHistogramQueries( com.google.cloud.contentwarehouse.v1.HistogramQuery.Builder builderForValue)2765 public Builder addHistogramQueries( 2766 com.google.cloud.contentwarehouse.v1.HistogramQuery.Builder builderForValue) { 2767 if (histogramQueriesBuilder_ == null) { 2768 ensureHistogramQueriesIsMutable(); 2769 histogramQueries_.add(builderForValue.build()); 2770 onChanged(); 2771 } else { 2772 histogramQueriesBuilder_.addMessage(builderForValue.build()); 2773 } 2774 return this; 2775 } 2776 /** 2777 * 2778 * 2779 * <pre> 2780 * An expression specifying a histogram request against matching 2781 * documents. Expression syntax is an aggregation function call with 2782 * histogram facets and other options. 2783 * The following aggregation functions are supported: 2784 * * `count(string_histogram_facet)`: Count the number of matching entities 2785 * for each distinct attribute value. 2786 * Data types: 2787 * * Histogram facet (aka filterable properties): Facet names with format 2788 * &lt;schema id&gt;.&lt;facet&gt;. Facets will have the 2789 * format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child 2790 * facet, then the parent hierarchy needs to be specified separated by 2791 * dots in the prefix after the schema id. Thus, the format for a multi- 2792 * level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. 2793 * &lt;child facet name&gt;. Example: 2794 * schema123.root_parent_facet.middle_facet.child_facet 2795 * * DocumentSchemaId: (with no schema id prefix) to get 2796 * histograms for each document type (returns the schema id path, e.g. 2797 * projects/12345/locations/us-west/documentSchemas/abc123). 2798 * Example expression: 2799 * * Document type counts: 2800 * count('DocumentSchemaId') 2801 * * For schema id, abc123, get the counts for MORTGAGE_TYPE: 2802 * count('abc123.MORTGAGE_TYPE') 2803 * </pre> 2804 * 2805 * <code>repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;</code> 2806 */ addHistogramQueries( int index, com.google.cloud.contentwarehouse.v1.HistogramQuery.Builder builderForValue)2807 public Builder addHistogramQueries( 2808 int index, com.google.cloud.contentwarehouse.v1.HistogramQuery.Builder builderForValue) { 2809 if (histogramQueriesBuilder_ == null) { 2810 ensureHistogramQueriesIsMutable(); 2811 histogramQueries_.add(index, builderForValue.build()); 2812 onChanged(); 2813 } else { 2814 histogramQueriesBuilder_.addMessage(index, builderForValue.build()); 2815 } 2816 return this; 2817 } 2818 /** 2819 * 2820 * 2821 * <pre> 2822 * An expression specifying a histogram request against matching 2823 * documents. Expression syntax is an aggregation function call with 2824 * histogram facets and other options. 2825 * The following aggregation functions are supported: 2826 * * `count(string_histogram_facet)`: Count the number of matching entities 2827 * for each distinct attribute value. 2828 * Data types: 2829 * * Histogram facet (aka filterable properties): Facet names with format 2830 * &lt;schema id&gt;.&lt;facet&gt;. Facets will have the 2831 * format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child 2832 * facet, then the parent hierarchy needs to be specified separated by 2833 * dots in the prefix after the schema id. Thus, the format for a multi- 2834 * level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. 2835 * &lt;child facet name&gt;. Example: 2836 * schema123.root_parent_facet.middle_facet.child_facet 2837 * * DocumentSchemaId: (with no schema id prefix) to get 2838 * histograms for each document type (returns the schema id path, e.g. 2839 * projects/12345/locations/us-west/documentSchemas/abc123). 2840 * Example expression: 2841 * * Document type counts: 2842 * count('DocumentSchemaId') 2843 * * For schema id, abc123, get the counts for MORTGAGE_TYPE: 2844 * count('abc123.MORTGAGE_TYPE') 2845 * </pre> 2846 * 2847 * <code>repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;</code> 2848 */ addAllHistogramQueries( java.lang.Iterable<? extends com.google.cloud.contentwarehouse.v1.HistogramQuery> values)2849 public Builder addAllHistogramQueries( 2850 java.lang.Iterable<? extends com.google.cloud.contentwarehouse.v1.HistogramQuery> values) { 2851 if (histogramQueriesBuilder_ == null) { 2852 ensureHistogramQueriesIsMutable(); 2853 com.google.protobuf.AbstractMessageLite.Builder.addAll(values, histogramQueries_); 2854 onChanged(); 2855 } else { 2856 histogramQueriesBuilder_.addAllMessages(values); 2857 } 2858 return this; 2859 } 2860 /** 2861 * 2862 * 2863 * <pre> 2864 * An expression specifying a histogram request against matching 2865 * documents. Expression syntax is an aggregation function call with 2866 * histogram facets and other options. 2867 * The following aggregation functions are supported: 2868 * * `count(string_histogram_facet)`: Count the number of matching entities 2869 * for each distinct attribute value. 2870 * Data types: 2871 * * Histogram facet (aka filterable properties): Facet names with format 2872 * &lt;schema id&gt;.&lt;facet&gt;. Facets will have the 2873 * format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child 2874 * facet, then the parent hierarchy needs to be specified separated by 2875 * dots in the prefix after the schema id. Thus, the format for a multi- 2876 * level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. 2877 * &lt;child facet name&gt;. Example: 2878 * schema123.root_parent_facet.middle_facet.child_facet 2879 * * DocumentSchemaId: (with no schema id prefix) to get 2880 * histograms for each document type (returns the schema id path, e.g. 2881 * projects/12345/locations/us-west/documentSchemas/abc123). 2882 * Example expression: 2883 * * Document type counts: 2884 * count('DocumentSchemaId') 2885 * * For schema id, abc123, get the counts for MORTGAGE_TYPE: 2886 * count('abc123.MORTGAGE_TYPE') 2887 * </pre> 2888 * 2889 * <code>repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;</code> 2890 */ clearHistogramQueries()2891 public Builder clearHistogramQueries() { 2892 if (histogramQueriesBuilder_ == null) { 2893 histogramQueries_ = java.util.Collections.emptyList(); 2894 bitField0_ = (bitField0_ & ~0x00000080); 2895 onChanged(); 2896 } else { 2897 histogramQueriesBuilder_.clear(); 2898 } 2899 return this; 2900 } 2901 /** 2902 * 2903 * 2904 * <pre> 2905 * An expression specifying a histogram request against matching 2906 * documents. Expression syntax is an aggregation function call with 2907 * histogram facets and other options. 2908 * The following aggregation functions are supported: 2909 * * `count(string_histogram_facet)`: Count the number of matching entities 2910 * for each distinct attribute value. 2911 * Data types: 2912 * * Histogram facet (aka filterable properties): Facet names with format 2913 * &lt;schema id&gt;.&lt;facet&gt;. Facets will have the 2914 * format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child 2915 * facet, then the parent hierarchy needs to be specified separated by 2916 * dots in the prefix after the schema id. Thus, the format for a multi- 2917 * level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. 2918 * &lt;child facet name&gt;. Example: 2919 * schema123.root_parent_facet.middle_facet.child_facet 2920 * * DocumentSchemaId: (with no schema id prefix) to get 2921 * histograms for each document type (returns the schema id path, e.g. 2922 * projects/12345/locations/us-west/documentSchemas/abc123). 2923 * Example expression: 2924 * * Document type counts: 2925 * count('DocumentSchemaId') 2926 * * For schema id, abc123, get the counts for MORTGAGE_TYPE: 2927 * count('abc123.MORTGAGE_TYPE') 2928 * </pre> 2929 * 2930 * <code>repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;</code> 2931 */ removeHistogramQueries(int index)2932 public Builder removeHistogramQueries(int index) { 2933 if (histogramQueriesBuilder_ == null) { 2934 ensureHistogramQueriesIsMutable(); 2935 histogramQueries_.remove(index); 2936 onChanged(); 2937 } else { 2938 histogramQueriesBuilder_.remove(index); 2939 } 2940 return this; 2941 } 2942 /** 2943 * 2944 * 2945 * <pre> 2946 * An expression specifying a histogram request against matching 2947 * documents. Expression syntax is an aggregation function call with 2948 * histogram facets and other options. 2949 * The following aggregation functions are supported: 2950 * * `count(string_histogram_facet)`: Count the number of matching entities 2951 * for each distinct attribute value. 2952 * Data types: 2953 * * Histogram facet (aka filterable properties): Facet names with format 2954 * &lt;schema id&gt;.&lt;facet&gt;. Facets will have the 2955 * format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child 2956 * facet, then the parent hierarchy needs to be specified separated by 2957 * dots in the prefix after the schema id. Thus, the format for a multi- 2958 * level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. 2959 * &lt;child facet name&gt;. Example: 2960 * schema123.root_parent_facet.middle_facet.child_facet 2961 * * DocumentSchemaId: (with no schema id prefix) to get 2962 * histograms for each document type (returns the schema id path, e.g. 2963 * projects/12345/locations/us-west/documentSchemas/abc123). 2964 * Example expression: 2965 * * Document type counts: 2966 * count('DocumentSchemaId') 2967 * * For schema id, abc123, get the counts for MORTGAGE_TYPE: 2968 * count('abc123.MORTGAGE_TYPE') 2969 * </pre> 2970 * 2971 * <code>repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;</code> 2972 */ getHistogramQueriesBuilder( int index)2973 public com.google.cloud.contentwarehouse.v1.HistogramQuery.Builder getHistogramQueriesBuilder( 2974 int index) { 2975 return getHistogramQueriesFieldBuilder().getBuilder(index); 2976 } 2977 /** 2978 * 2979 * 2980 * <pre> 2981 * An expression specifying a histogram request against matching 2982 * documents. Expression syntax is an aggregation function call with 2983 * histogram facets and other options. 2984 * The following aggregation functions are supported: 2985 * * `count(string_histogram_facet)`: Count the number of matching entities 2986 * for each distinct attribute value. 2987 * Data types: 2988 * * Histogram facet (aka filterable properties): Facet names with format 2989 * &lt;schema id&gt;.&lt;facet&gt;. Facets will have the 2990 * format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child 2991 * facet, then the parent hierarchy needs to be specified separated by 2992 * dots in the prefix after the schema id. Thus, the format for a multi- 2993 * level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. 2994 * &lt;child facet name&gt;. Example: 2995 * schema123.root_parent_facet.middle_facet.child_facet 2996 * * DocumentSchemaId: (with no schema id prefix) to get 2997 * histograms for each document type (returns the schema id path, e.g. 2998 * projects/12345/locations/us-west/documentSchemas/abc123). 2999 * Example expression: 3000 * * Document type counts: 3001 * count('DocumentSchemaId') 3002 * * For schema id, abc123, get the counts for MORTGAGE_TYPE: 3003 * count('abc123.MORTGAGE_TYPE') 3004 * </pre> 3005 * 3006 * <code>repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;</code> 3007 */ 3008 public com.google.cloud.contentwarehouse.v1.HistogramQueryOrBuilder getHistogramQueriesOrBuilder(int index)3009 getHistogramQueriesOrBuilder(int index) { 3010 if (histogramQueriesBuilder_ == null) { 3011 return histogramQueries_.get(index); 3012 } else { 3013 return histogramQueriesBuilder_.getMessageOrBuilder(index); 3014 } 3015 } 3016 /** 3017 * 3018 * 3019 * <pre> 3020 * An expression specifying a histogram request against matching 3021 * documents. Expression syntax is an aggregation function call with 3022 * histogram facets and other options. 3023 * The following aggregation functions are supported: 3024 * * `count(string_histogram_facet)`: Count the number of matching entities 3025 * for each distinct attribute value. 3026 * Data types: 3027 * * Histogram facet (aka filterable properties): Facet names with format 3028 * &lt;schema id&gt;.&lt;facet&gt;. Facets will have the 3029 * format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child 3030 * facet, then the parent hierarchy needs to be specified separated by 3031 * dots in the prefix after the schema id. Thus, the format for a multi- 3032 * level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. 3033 * &lt;child facet name&gt;. Example: 3034 * schema123.root_parent_facet.middle_facet.child_facet 3035 * * DocumentSchemaId: (with no schema id prefix) to get 3036 * histograms for each document type (returns the schema id path, e.g. 3037 * projects/12345/locations/us-west/documentSchemas/abc123). 3038 * Example expression: 3039 * * Document type counts: 3040 * count('DocumentSchemaId') 3041 * * For schema id, abc123, get the counts for MORTGAGE_TYPE: 3042 * count('abc123.MORTGAGE_TYPE') 3043 * </pre> 3044 * 3045 * <code>repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;</code> 3046 */ 3047 public java.util.List<? extends com.google.cloud.contentwarehouse.v1.HistogramQueryOrBuilder> getHistogramQueriesOrBuilderList()3048 getHistogramQueriesOrBuilderList() { 3049 if (histogramQueriesBuilder_ != null) { 3050 return histogramQueriesBuilder_.getMessageOrBuilderList(); 3051 } else { 3052 return java.util.Collections.unmodifiableList(histogramQueries_); 3053 } 3054 } 3055 /** 3056 * 3057 * 3058 * <pre> 3059 * An expression specifying a histogram request against matching 3060 * documents. Expression syntax is an aggregation function call with 3061 * histogram facets and other options. 3062 * The following aggregation functions are supported: 3063 * * `count(string_histogram_facet)`: Count the number of matching entities 3064 * for each distinct attribute value. 3065 * Data types: 3066 * * Histogram facet (aka filterable properties): Facet names with format 3067 * &lt;schema id&gt;.&lt;facet&gt;. Facets will have the 3068 * format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child 3069 * facet, then the parent hierarchy needs to be specified separated by 3070 * dots in the prefix after the schema id. Thus, the format for a multi- 3071 * level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. 3072 * &lt;child facet name&gt;. Example: 3073 * schema123.root_parent_facet.middle_facet.child_facet 3074 * * DocumentSchemaId: (with no schema id prefix) to get 3075 * histograms for each document type (returns the schema id path, e.g. 3076 * projects/12345/locations/us-west/documentSchemas/abc123). 3077 * Example expression: 3078 * * Document type counts: 3079 * count('DocumentSchemaId') 3080 * * For schema id, abc123, get the counts for MORTGAGE_TYPE: 3081 * count('abc123.MORTGAGE_TYPE') 3082 * </pre> 3083 * 3084 * <code>repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;</code> 3085 */ 3086 public com.google.cloud.contentwarehouse.v1.HistogramQuery.Builder addHistogramQueriesBuilder()3087 addHistogramQueriesBuilder() { 3088 return getHistogramQueriesFieldBuilder() 3089 .addBuilder(com.google.cloud.contentwarehouse.v1.HistogramQuery.getDefaultInstance()); 3090 } 3091 /** 3092 * 3093 * 3094 * <pre> 3095 * An expression specifying a histogram request against matching 3096 * documents. Expression syntax is an aggregation function call with 3097 * histogram facets and other options. 3098 * The following aggregation functions are supported: 3099 * * `count(string_histogram_facet)`: Count the number of matching entities 3100 * for each distinct attribute value. 3101 * Data types: 3102 * * Histogram facet (aka filterable properties): Facet names with format 3103 * &lt;schema id&gt;.&lt;facet&gt;. Facets will have the 3104 * format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child 3105 * facet, then the parent hierarchy needs to be specified separated by 3106 * dots in the prefix after the schema id. Thus, the format for a multi- 3107 * level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. 3108 * &lt;child facet name&gt;. Example: 3109 * schema123.root_parent_facet.middle_facet.child_facet 3110 * * DocumentSchemaId: (with no schema id prefix) to get 3111 * histograms for each document type (returns the schema id path, e.g. 3112 * projects/12345/locations/us-west/documentSchemas/abc123). 3113 * Example expression: 3114 * * Document type counts: 3115 * count('DocumentSchemaId') 3116 * * For schema id, abc123, get the counts for MORTGAGE_TYPE: 3117 * count('abc123.MORTGAGE_TYPE') 3118 * </pre> 3119 * 3120 * <code>repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;</code> 3121 */ addHistogramQueriesBuilder( int index)3122 public com.google.cloud.contentwarehouse.v1.HistogramQuery.Builder addHistogramQueriesBuilder( 3123 int index) { 3124 return getHistogramQueriesFieldBuilder() 3125 .addBuilder( 3126 index, com.google.cloud.contentwarehouse.v1.HistogramQuery.getDefaultInstance()); 3127 } 3128 /** 3129 * 3130 * 3131 * <pre> 3132 * An expression specifying a histogram request against matching 3133 * documents. Expression syntax is an aggregation function call with 3134 * histogram facets and other options. 3135 * The following aggregation functions are supported: 3136 * * `count(string_histogram_facet)`: Count the number of matching entities 3137 * for each distinct attribute value. 3138 * Data types: 3139 * * Histogram facet (aka filterable properties): Facet names with format 3140 * &lt;schema id&gt;.&lt;facet&gt;. Facets will have the 3141 * format of: `[a-zA-Z][a-zA-Z0-9_:/-.]`. If the facet is a child 3142 * facet, then the parent hierarchy needs to be specified separated by 3143 * dots in the prefix after the schema id. Thus, the format for a multi- 3144 * level facet is: &lt;schema id&gt;.&lt;parent facet name&gt;. 3145 * &lt;child facet name&gt;. Example: 3146 * schema123.root_parent_facet.middle_facet.child_facet 3147 * * DocumentSchemaId: (with no schema id prefix) to get 3148 * histograms for each document type (returns the schema id path, e.g. 3149 * projects/12345/locations/us-west/documentSchemas/abc123). 3150 * Example expression: 3151 * * Document type counts: 3152 * count('DocumentSchemaId') 3153 * * For schema id, abc123, get the counts for MORTGAGE_TYPE: 3154 * count('abc123.MORTGAGE_TYPE') 3155 * </pre> 3156 * 3157 * <code>repeated .google.cloud.contentwarehouse.v1.HistogramQuery histogram_queries = 9;</code> 3158 */ 3159 public java.util.List<com.google.cloud.contentwarehouse.v1.HistogramQuery.Builder> getHistogramQueriesBuilderList()3160 getHistogramQueriesBuilderList() { 3161 return getHistogramQueriesFieldBuilder().getBuilderList(); 3162 } 3163 3164 private com.google.protobuf.RepeatedFieldBuilderV3< 3165 com.google.cloud.contentwarehouse.v1.HistogramQuery, 3166 com.google.cloud.contentwarehouse.v1.HistogramQuery.Builder, 3167 com.google.cloud.contentwarehouse.v1.HistogramQueryOrBuilder> getHistogramQueriesFieldBuilder()3168 getHistogramQueriesFieldBuilder() { 3169 if (histogramQueriesBuilder_ == null) { 3170 histogramQueriesBuilder_ = 3171 new com.google.protobuf.RepeatedFieldBuilderV3< 3172 com.google.cloud.contentwarehouse.v1.HistogramQuery, 3173 com.google.cloud.contentwarehouse.v1.HistogramQuery.Builder, 3174 com.google.cloud.contentwarehouse.v1.HistogramQueryOrBuilder>( 3175 histogramQueries_, 3176 ((bitField0_ & 0x00000080) != 0), 3177 getParentForChildren(), 3178 isClean()); 3179 histogramQueries_ = null; 3180 } 3181 return histogramQueriesBuilder_; 3182 } 3183 3184 private boolean requireTotalSize_; 3185 /** 3186 * 3187 * 3188 * <pre> 3189 * Controls if the search document request requires the return of a total size 3190 * of matched documents. See 3191 * [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size]. 3192 * Enabling this flag may adversely impact performance. Hint: If this is 3193 * used with pagination, set this flag on the initial query but set this 3194 * to false on subsequent page calls (keep the total count locally). 3195 * Defaults to false. 3196 * </pre> 3197 * 3198 * <code>bool require_total_size = 10;</code> 3199 * 3200 * @return The requireTotalSize. 3201 */ 3202 @java.lang.Override getRequireTotalSize()3203 public boolean getRequireTotalSize() { 3204 return requireTotalSize_; 3205 } 3206 /** 3207 * 3208 * 3209 * <pre> 3210 * Controls if the search document request requires the return of a total size 3211 * of matched documents. See 3212 * [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size]. 3213 * Enabling this flag may adversely impact performance. Hint: If this is 3214 * used with pagination, set this flag on the initial query but set this 3215 * to false on subsequent page calls (keep the total count locally). 3216 * Defaults to false. 3217 * </pre> 3218 * 3219 * <code>bool require_total_size = 10;</code> 3220 * 3221 * @param value The requireTotalSize to set. 3222 * @return This builder for chaining. 3223 */ setRequireTotalSize(boolean value)3224 public Builder setRequireTotalSize(boolean value) { 3225 3226 requireTotalSize_ = value; 3227 bitField0_ |= 0x00000100; 3228 onChanged(); 3229 return this; 3230 } 3231 /** 3232 * 3233 * 3234 * <pre> 3235 * Controls if the search document request requires the return of a total size 3236 * of matched documents. See 3237 * [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size]. 3238 * Enabling this flag may adversely impact performance. Hint: If this is 3239 * used with pagination, set this flag on the initial query but set this 3240 * to false on subsequent page calls (keep the total count locally). 3241 * Defaults to false. 3242 * </pre> 3243 * 3244 * <code>bool require_total_size = 10;</code> 3245 * 3246 * @return This builder for chaining. 3247 */ clearRequireTotalSize()3248 public Builder clearRequireTotalSize() { 3249 bitField0_ = (bitField0_ & ~0x00000100); 3250 requireTotalSize_ = false; 3251 onChanged(); 3252 return this; 3253 } 3254 3255 private int totalResultSize_ = 0; 3256 /** 3257 * 3258 * 3259 * <pre> 3260 * Controls if the search document request requires the return of a total size 3261 * of matched documents. See 3262 * [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size]. 3263 * </pre> 3264 * 3265 * <code> 3266 * .google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize total_result_size = 12; 3267 * </code> 3268 * 3269 * @return The enum numeric value on the wire for totalResultSize. 3270 */ 3271 @java.lang.Override getTotalResultSizeValue()3272 public int getTotalResultSizeValue() { 3273 return totalResultSize_; 3274 } 3275 /** 3276 * 3277 * 3278 * <pre> 3279 * Controls if the search document request requires the return of a total size 3280 * of matched documents. See 3281 * [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size]. 3282 * </pre> 3283 * 3284 * <code> 3285 * .google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize total_result_size = 12; 3286 * </code> 3287 * 3288 * @param value The enum numeric value on the wire for totalResultSize to set. 3289 * @return This builder for chaining. 3290 */ setTotalResultSizeValue(int value)3291 public Builder setTotalResultSizeValue(int value) { 3292 totalResultSize_ = value; 3293 bitField0_ |= 0x00000200; 3294 onChanged(); 3295 return this; 3296 } 3297 /** 3298 * 3299 * 3300 * <pre> 3301 * Controls if the search document request requires the return of a total size 3302 * of matched documents. See 3303 * [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size]. 3304 * </pre> 3305 * 3306 * <code> 3307 * .google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize total_result_size = 12; 3308 * </code> 3309 * 3310 * @return The totalResultSize. 3311 */ 3312 @java.lang.Override 3313 public com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize getTotalResultSize()3314 getTotalResultSize() { 3315 com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize result = 3316 com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize.forNumber( 3317 totalResultSize_); 3318 return result == null 3319 ? com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize.UNRECOGNIZED 3320 : result; 3321 } 3322 /** 3323 * 3324 * 3325 * <pre> 3326 * Controls if the search document request requires the return of a total size 3327 * of matched documents. See 3328 * [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size]. 3329 * </pre> 3330 * 3331 * <code> 3332 * .google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize total_result_size = 12; 3333 * </code> 3334 * 3335 * @param value The totalResultSize to set. 3336 * @return This builder for chaining. 3337 */ setTotalResultSize( com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize value)3338 public Builder setTotalResultSize( 3339 com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize value) { 3340 if (value == null) { 3341 throw new NullPointerException(); 3342 } 3343 bitField0_ |= 0x00000200; 3344 totalResultSize_ = value.getNumber(); 3345 onChanged(); 3346 return this; 3347 } 3348 /** 3349 * 3350 * 3351 * <pre> 3352 * Controls if the search document request requires the return of a total size 3353 * of matched documents. See 3354 * [SearchDocumentsResponse.total_size][google.cloud.contentwarehouse.v1.SearchDocumentsResponse.total_size]. 3355 * </pre> 3356 * 3357 * <code> 3358 * .google.cloud.contentwarehouse.v1.SearchDocumentsRequest.TotalResultSize total_result_size = 12; 3359 * </code> 3360 * 3361 * @return This builder for chaining. 3362 */ clearTotalResultSize()3363 public Builder clearTotalResultSize() { 3364 bitField0_ = (bitField0_ & ~0x00000200); 3365 totalResultSize_ = 0; 3366 onChanged(); 3367 return this; 3368 } 3369 3370 private int qaSizeLimit_; 3371 /** 3372 * 3373 * 3374 * <pre> 3375 * Experimental, do not use. 3376 * The limit on the number of documents returned for the question-answering 3377 * feature. To enable the question-answering feature, set 3378 * [DocumentQuery].[is_nl_query][] to true. 3379 * </pre> 3380 * 3381 * <code>int32 qa_size_limit = 11;</code> 3382 * 3383 * @return The qaSizeLimit. 3384 */ 3385 @java.lang.Override getQaSizeLimit()3386 public int getQaSizeLimit() { 3387 return qaSizeLimit_; 3388 } 3389 /** 3390 * 3391 * 3392 * <pre> 3393 * Experimental, do not use. 3394 * The limit on the number of documents returned for the question-answering 3395 * feature. To enable the question-answering feature, set 3396 * [DocumentQuery].[is_nl_query][] to true. 3397 * </pre> 3398 * 3399 * <code>int32 qa_size_limit = 11;</code> 3400 * 3401 * @param value The qaSizeLimit to set. 3402 * @return This builder for chaining. 3403 */ setQaSizeLimit(int value)3404 public Builder setQaSizeLimit(int value) { 3405 3406 qaSizeLimit_ = value; 3407 bitField0_ |= 0x00000400; 3408 onChanged(); 3409 return this; 3410 } 3411 /** 3412 * 3413 * 3414 * <pre> 3415 * Experimental, do not use. 3416 * The limit on the number of documents returned for the question-answering 3417 * feature. To enable the question-answering feature, set 3418 * [DocumentQuery].[is_nl_query][] to true. 3419 * </pre> 3420 * 3421 * <code>int32 qa_size_limit = 11;</code> 3422 * 3423 * @return This builder for chaining. 3424 */ clearQaSizeLimit()3425 public Builder clearQaSizeLimit() { 3426 bitField0_ = (bitField0_ & ~0x00000400); 3427 qaSizeLimit_ = 0; 3428 onChanged(); 3429 return this; 3430 } 3431 3432 @java.lang.Override setUnknownFields(final com.google.protobuf.UnknownFieldSet unknownFields)3433 public final Builder setUnknownFields(final com.google.protobuf.UnknownFieldSet unknownFields) { 3434 return super.setUnknownFields(unknownFields); 3435 } 3436 3437 @java.lang.Override mergeUnknownFields( final com.google.protobuf.UnknownFieldSet unknownFields)3438 public final Builder mergeUnknownFields( 3439 final com.google.protobuf.UnknownFieldSet unknownFields) { 3440 return super.mergeUnknownFields(unknownFields); 3441 } 3442 3443 // @@protoc_insertion_point(builder_scope:google.cloud.contentwarehouse.v1.SearchDocumentsRequest) 3444 } 3445 3446 // @@protoc_insertion_point(class_scope:google.cloud.contentwarehouse.v1.SearchDocumentsRequest) 3447 private static final com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest DEFAULT_INSTANCE; 3448 3449 static { 3450 DEFAULT_INSTANCE = new com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest(); 3451 } 3452 getDefaultInstance()3453 public static com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest getDefaultInstance() { 3454 return DEFAULT_INSTANCE; 3455 } 3456 3457 private static final com.google.protobuf.Parser<SearchDocumentsRequest> PARSER = 3458 new com.google.protobuf.AbstractParser<SearchDocumentsRequest>() { 3459 @java.lang.Override 3460 public SearchDocumentsRequest parsePartialFrom( 3461 com.google.protobuf.CodedInputStream input, 3462 com.google.protobuf.ExtensionRegistryLite extensionRegistry) 3463 throws com.google.protobuf.InvalidProtocolBufferException { 3464 Builder builder = newBuilder(); 3465 try { 3466 builder.mergeFrom(input, extensionRegistry); 3467 } catch (com.google.protobuf.InvalidProtocolBufferException e) { 3468 throw e.setUnfinishedMessage(builder.buildPartial()); 3469 } catch (com.google.protobuf.UninitializedMessageException e) { 3470 throw e.asInvalidProtocolBufferException().setUnfinishedMessage(builder.buildPartial()); 3471 } catch (java.io.IOException e) { 3472 throw new com.google.protobuf.InvalidProtocolBufferException(e) 3473 .setUnfinishedMessage(builder.buildPartial()); 3474 } 3475 return builder.buildPartial(); 3476 } 3477 }; 3478 parser()3479 public static com.google.protobuf.Parser<SearchDocumentsRequest> parser() { 3480 return PARSER; 3481 } 3482 3483 @java.lang.Override getParserForType()3484 public com.google.protobuf.Parser<SearchDocumentsRequest> getParserForType() { 3485 return PARSER; 3486 } 3487 3488 @java.lang.Override getDefaultInstanceForType()3489 public com.google.cloud.contentwarehouse.v1.SearchDocumentsRequest getDefaultInstanceForType() { 3490 return DEFAULT_INSTANCE; 3491 } 3492 } 3493