Package com.google.cloud.datacatalog.v1

Class SearchCatalogRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SearchCatalogRequest.Builder>
com.google.cloud.datacatalog.v1.SearchCatalogRequest.Builder
All Implemented Interfaces:
SearchCatalogRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SearchCatalogRequest
public static final class SearchCatalogRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<SearchCatalogRequest.Builder> implements SearchCatalogRequestOrBuilder
 Request message for
 [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
Protobuf type google.cloud.datacatalog.v1.SearchCatalogRequest

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<SearchCatalogRequest.Builder>

    • clear

      public SearchCatalogRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<SearchCatalogRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SearchCatalogRequest.Builder>

    • getDefaultInstanceForType

      public SearchCatalogRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public SearchCatalogRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public SearchCatalogRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public SearchCatalogRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchCatalogRequest.Builder>

    • mergeFrom

      public SearchCatalogRequest.Builder mergeFrom(SearchCatalogRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<SearchCatalogRequest.Builder>

    • mergeFrom

      public SearchCatalogRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchCatalogRequest.Builder>
      Throws:
      IOException

    • hasScope

      public boolean hasScope()
       Required. The scope of this search request.

 The `scope` is invalid if `include_org_ids`, `include_project_ids` are
 empty AND `include_gcp_public_datasets` is set to `false`. In this case,
 the request returns an error.
      .google.cloud.datacatalog.v1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasScope in interface SearchCatalogRequestOrBuilder
      Returns:
      Whether the scope field is set.

    • getScope

      public SearchCatalogRequest.Scope getScope()
       Required. The scope of this search request.

 The `scope` is invalid if `include_org_ids`, `include_project_ids` are
 empty AND `include_gcp_public_datasets` is set to `false`. In this case,
 the request returns an error.
      .google.cloud.datacatalog.v1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getScope in interface SearchCatalogRequestOrBuilder
      Returns:
      The scope.

    • setScope

      public SearchCatalogRequest.Builder setScope(SearchCatalogRequest.Scope value)
       Required. The scope of this search request.

 The `scope` is invalid if `include_org_ids`, `include_project_ids` are
 empty AND `include_gcp_public_datasets` is set to `false`. In this case,
 the request returns an error.
      .google.cloud.datacatalog.v1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];

    • setScope

      public SearchCatalogRequest.Builder setScope(SearchCatalogRequest.Scope.Builder builderForValue)
       Required. The scope of this search request.

 The `scope` is invalid if `include_org_ids`, `include_project_ids` are
 empty AND `include_gcp_public_datasets` is set to `false`. In this case,
 the request returns an error.
      .google.cloud.datacatalog.v1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];

    • mergeScope

      public SearchCatalogRequest.Builder mergeScope(SearchCatalogRequest.Scope value)
       Required. The scope of this search request.

 The `scope` is invalid if `include_org_ids`, `include_project_ids` are
 empty AND `include_gcp_public_datasets` is set to `false`. In this case,
 the request returns an error.
      .google.cloud.datacatalog.v1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];

    • clearScope

      public SearchCatalogRequest.Builder clearScope()
       Required. The scope of this search request.

 The `scope` is invalid if `include_org_ids`, `include_project_ids` are
 empty AND `include_gcp_public_datasets` is set to `false`. In this case,
 the request returns an error.
      .google.cloud.datacatalog.v1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];

    • getScopeBuilder

      public SearchCatalogRequest.Scope.Builder getScopeBuilder()
       Required. The scope of this search request.

 The `scope` is invalid if `include_org_ids`, `include_project_ids` are
 empty AND `include_gcp_public_datasets` is set to `false`. In this case,
 the request returns an error.
      .google.cloud.datacatalog.v1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];

    • getScopeOrBuilder

      public SearchCatalogRequest.ScopeOrBuilder getScopeOrBuilder()
       Required. The scope of this search request.

 The `scope` is invalid if `include_org_ids`, `include_project_ids` are
 empty AND `include_gcp_public_datasets` is set to `false`. In this case,
 the request returns an error.
      .google.cloud.datacatalog.v1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getScopeOrBuilder in interface SearchCatalogRequestOrBuilder

    • getQuery

      public String getQuery()
       Optional. The query string with a minimum of 3 characters and specific
 syntax. For more information, see [Data Catalog search
 syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference).

 An empty query string returns all data assets (in the specified scope)
 that you have access to.

 A query string can be a simple `xyz` or qualified by predicates:

 * `name:x`
 * `column:y`
 * `description:z`
      string query = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getQuery in interface SearchCatalogRequestOrBuilder
      Returns:
      The query.

    • getQueryBytes

      public com.google.protobuf.ByteString getQueryBytes()
       Optional. The query string with a minimum of 3 characters and specific
 syntax. For more information, see [Data Catalog search
 syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference).

 An empty query string returns all data assets (in the specified scope)
 that you have access to.

 A query string can be a simple `xyz` or qualified by predicates:

 * `name:x`
 * `column:y`
 * `description:z`
      string query = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getQueryBytes in interface SearchCatalogRequestOrBuilder
      Returns:
      The bytes for query.

    • setQuery

      public SearchCatalogRequest.Builder setQuery(String value)
       Optional. The query string with a minimum of 3 characters and specific
 syntax. For more information, see [Data Catalog search
 syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference).

 An empty query string returns all data assets (in the specified scope)
 that you have access to.

 A query string can be a simple `xyz` or qualified by predicates:

 * `name:x`
 * `column:y`
 * `description:z`
      string query = 1 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The query to set.
      Returns:
      This builder for chaining.

    • clearQuery

      public SearchCatalogRequest.Builder clearQuery()
       Optional. The query string with a minimum of 3 characters and specific
 syntax. For more information, see [Data Catalog search
 syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference).

 An empty query string returns all data assets (in the specified scope)
 that you have access to.

 A query string can be a simple `xyz` or qualified by predicates:

 * `name:x`
 * `column:y`
 * `description:z`
      string query = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setQueryBytes

      public SearchCatalogRequest.Builder setQueryBytes(com.google.protobuf.ByteString value)
       Optional. The query string with a minimum of 3 characters and specific
 syntax. For more information, see [Data Catalog search
 syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference).

 An empty query string returns all data assets (in the specified scope)
 that you have access to.

 A query string can be a simple `xyz` or qualified by predicates:

 * `name:x`
 * `column:y`
 * `description:z`
      string query = 1 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for query to set.
      Returns:
      This builder for chaining.

    • getPageSize

      public int getPageSize()
       Upper bound on the number of results you can get in a single response.

 Can't be negative or 0, defaults to 10 in this case.
 The maximum number is 1000. If exceeded, throws an "invalid argument"
 exception.
      int32 page_size = 2;
      Specified by:
      getPageSize in interface SearchCatalogRequestOrBuilder
      Returns:
      The pageSize.

    • setPageSize

      public SearchCatalogRequest.Builder setPageSize(int value)
       Upper bound on the number of results you can get in a single response.

 Can't be negative or 0, defaults to 10 in this case.
 The maximum number is 1000. If exceeded, throws an "invalid argument"
 exception.
      int32 page_size = 2;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public SearchCatalogRequest.Builder clearPageSize()
       Upper bound on the number of results you can get in a single response.

 Can't be negative or 0, defaults to 10 in this case.
 The maximum number is 1000. If exceeded, throws an "invalid argument"
 exception.
      int32 page_size = 2;
      Returns:
      This builder for chaining.

    • getPageToken

      public String getPageToken()
       Optional. Pagination token that, if specified, returns the next page of
 search results. If empty, returns the first page.

 This token is returned in the
 [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1.SearchCatalogResponse.next_page_token]
 field of the response to a previous
 [SearchCatalogRequest][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog]
 call.
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageToken in interface SearchCatalogRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       Optional. Pagination token that, if specified, returns the next page of
 search results. If empty, returns the first page.

 This token is returned in the
 [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1.SearchCatalogResponse.next_page_token]
 field of the response to a previous
 [SearchCatalogRequest][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog]
 call.
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageTokenBytes in interface SearchCatalogRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • setPageToken

      public SearchCatalogRequest.Builder setPageToken(String value)
       Optional. Pagination token that, if specified, returns the next page of
 search results. If empty, returns the first page.

 This token is returned in the
 [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1.SearchCatalogResponse.next_page_token]
 field of the response to a previous
 [SearchCatalogRequest][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog]
 call.
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public SearchCatalogRequest.Builder clearPageToken()
       Optional. Pagination token that, if specified, returns the next page of
 search results. If empty, returns the first page.

 This token is returned in the
 [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1.SearchCatalogResponse.next_page_token]
 field of the response to a previous
 [SearchCatalogRequest][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog]
 call.
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setPageTokenBytes

      public SearchCatalogRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       Optional. Pagination token that, if specified, returns the next page of
 search results. If empty, returns the first page.

 This token is returned in the
 [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1.SearchCatalogResponse.next_page_token]
 field of the response to a previous
 [SearchCatalogRequest][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog]
 call.
      string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.

    • getOrderBy

      public String getOrderBy()
       Specifies the order of results.

 Currently supported case-sensitive values are:

 * `relevance` that can only be descending
 * `last_modified_timestamp [asc|desc]` with descending (`desc`) as default
 * `default` that can only be descending

 Search queries don't guarantee full recall. Results that match your query
 might not be returned, even in subsequent result pages. Additionally,
 returned (and not returned) results can vary if you repeat search queries.
 If you are experiencing recall issues and you don't have to fetch the
 results in any specific order, consider setting this parameter to
 `default`.

 If this parameter is omitted, it defaults to the descending `relevance`.
      string order_by = 5;
      Specified by:
      getOrderBy in interface SearchCatalogRequestOrBuilder
      Returns:
      The orderBy.

    • getOrderByBytes

      public com.google.protobuf.ByteString getOrderByBytes()
       Specifies the order of results.

 Currently supported case-sensitive values are:

 * `relevance` that can only be descending
 * `last_modified_timestamp [asc|desc]` with descending (`desc`) as default
 * `default` that can only be descending

 Search queries don't guarantee full recall. Results that match your query
 might not be returned, even in subsequent result pages. Additionally,
 returned (and not returned) results can vary if you repeat search queries.
 If you are experiencing recall issues and you don't have to fetch the
 results in any specific order, consider setting this parameter to
 `default`.

 If this parameter is omitted, it defaults to the descending `relevance`.
      string order_by = 5;
      Specified by:
      getOrderByBytes in interface SearchCatalogRequestOrBuilder
      Returns:
      The bytes for orderBy.

    • setOrderBy

      public SearchCatalogRequest.Builder setOrderBy(String value)
       Specifies the order of results.

 Currently supported case-sensitive values are:

 * `relevance` that can only be descending
 * `last_modified_timestamp [asc|desc]` with descending (`desc`) as default
 * `default` that can only be descending

 Search queries don't guarantee full recall. Results that match your query
 might not be returned, even in subsequent result pages. Additionally,
 returned (and not returned) results can vary if you repeat search queries.
 If you are experiencing recall issues and you don't have to fetch the
 results in any specific order, consider setting this parameter to
 `default`.

 If this parameter is omitted, it defaults to the descending `relevance`.
      string order_by = 5;
      Parameters:
      value - The orderBy to set.
      Returns:
      This builder for chaining.

    • clearOrderBy

      public SearchCatalogRequest.Builder clearOrderBy()
       Specifies the order of results.

 Currently supported case-sensitive values are:

 * `relevance` that can only be descending
 * `last_modified_timestamp [asc|desc]` with descending (`desc`) as default
 * `default` that can only be descending

 Search queries don't guarantee full recall. Results that match your query
 might not be returned, even in subsequent result pages. Additionally,
 returned (and not returned) results can vary if you repeat search queries.
 If you are experiencing recall issues and you don't have to fetch the
 results in any specific order, consider setting this parameter to
 `default`.

 If this parameter is omitted, it defaults to the descending `relevance`.
      string order_by = 5;
      Returns:
      This builder for chaining.

    • setOrderByBytes

      public SearchCatalogRequest.Builder setOrderByBytes(com.google.protobuf.ByteString value)
       Specifies the order of results.

 Currently supported case-sensitive values are:

 * `relevance` that can only be descending
 * `last_modified_timestamp [asc|desc]` with descending (`desc`) as default
 * `default` that can only be descending

 Search queries don't guarantee full recall. Results that match your query
 might not be returned, even in subsequent result pages. Additionally,
 returned (and not returned) results can vary if you repeat search queries.
 If you are experiencing recall issues and you don't have to fetch the
 results in any specific order, consider setting this parameter to
 `default`.

 If this parameter is omitted, it defaults to the descending `relevance`.
      string order_by = 5;
      Parameters:
      value - The bytes for orderBy to set.
      Returns:
      This builder for chaining.

    • getAdminSearch

      public boolean getAdminSearch()
       Optional. If set, use searchAll permission granted on organizations from
 `include_org_ids` and projects from `include_project_ids` instead of the
 fine grained per resource permissions when filtering the search results.
 The only allowed `order_by` criteria for admin_search mode is `default`.
 Using this flags guarantees a full recall of the search results.
      bool admin_search = 17 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAdminSearch in interface SearchCatalogRequestOrBuilder
      Returns:
      The adminSearch.

    • setAdminSearch

      public SearchCatalogRequest.Builder setAdminSearch(boolean value)
       Optional. If set, use searchAll permission granted on organizations from
 `include_org_ids` and projects from `include_project_ids` instead of the
 fine grained per resource permissions when filtering the search results.
 The only allowed `order_by` criteria for admin_search mode is `default`.
 Using this flags guarantees a full recall of the search results.
      bool admin_search = 17 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The adminSearch to set.
      Returns:
      This builder for chaining.

    • clearAdminSearch

      public SearchCatalogRequest.Builder clearAdminSearch()
       Optional. If set, use searchAll permission granted on organizations from
 `include_org_ids` and projects from `include_project_ids` instead of the
 fine grained per resource permissions when filtering the search results.
 The only allowed `order_by` criteria for admin_search mode is `default`.
 Using this flags guarantees a full recall of the search results.
      bool admin_search = 17 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.