Package com.google.cloud.datacatalog.v1beta1

Class 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.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>
implements SearchCatalogRequestOrBuilder
     Request message for
 [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog].
    Protobuf type google.cloud.datacatalog.v1beta1.SearchCatalogRequest

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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.GeneratedMessageV3.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

      • clone

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

      • setField

        public SearchCatalogRequest.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                             Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>

      • clearField

        public SearchCatalogRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>

      • clearOneof

        public SearchCatalogRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>

      • setRepeatedField

        public SearchCatalogRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     int index,
                                                     Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>

      • addRepeatedField

        public SearchCatalogRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.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. A `scope` that has empty
 `include_org_ids`, `include_project_ids` AND false
 `include_gcp_public_datasets` is considered invalid. Data Catalog will
 return an error in such a case.
        .google.cloud.datacatalog.v1beta1.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. A `scope` that has empty
 `include_org_ids`, `include_project_ids` AND false
 `include_gcp_public_datasets` is considered invalid. Data Catalog will
 return an error in such a case.
        .google.cloud.datacatalog.v1beta1.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. A `scope` that has empty
 `include_org_ids`, `include_project_ids` AND false
 `include_gcp_public_datasets` is considered invalid. Data Catalog will
 return an error in such a case.
        .google.cloud.datacatalog.v1beta1.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. A `scope` that has empty
 `include_org_ids`, `include_project_ids` AND false
 `include_gcp_public_datasets` is considered invalid. Data Catalog will
 return an error in such a case.
        .google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];

      • mergeScope

        public SearchCatalogRequest.Builder mergeScope​(SearchCatalogRequest.Scope value)
         Required. The scope of this search request. A `scope` that has empty
 `include_org_ids`, `include_project_ids` AND false
 `include_gcp_public_datasets` is considered invalid. Data Catalog will
 return an error in such a case.
        .google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];

      • clearScope

        public SearchCatalogRequest.Builder clearScope()
         Required. The scope of this search request. A `scope` that has empty
 `include_org_ids`, `include_project_ids` AND false
 `include_gcp_public_datasets` is considered invalid. Data Catalog will
 return an error in such a case.
        .google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];

      • getScopeBuilder

        public SearchCatalogRequest.Scope.Builder getScopeBuilder()
         Required. The scope of this search request. A `scope` that has empty
 `include_org_ids`, `include_project_ids` AND false
 `include_gcp_public_datasets` is considered invalid. Data Catalog will
 return an error in such a case.
        .google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];

      • getScopeOrBuilder

        public SearchCatalogRequest.ScopeOrBuilder getScopeOrBuilder()
         Required. The scope of this search request. A `scope` that has empty
 `include_org_ids`, `include_project_ids` AND false
 `include_gcp_public_datasets` is considered invalid. Data Catalog will
 return an error in such a case.
        .google.cloud.datacatalog.v1beta1.SearchCatalogRequest.Scope scope = 6 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getScopeOrBuilder in interface SearchCatalogRequestOrBuilder

      • getQuery

        public String getQuery()
         Optional. The query string in search query syntax. An empty query string
 will result in all data assets (in the specified scope) that the user has
 access to. Query strings can be simple as "x" or more qualified as:

 * name:x
 * column:x
 * description:y

 Note: Query tokens need to have a minimum of 3 characters for substring
 matching to work correctly. See [Data Catalog Search
 Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
 for more information.
        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 in search query syntax. An empty query string
 will result in all data assets (in the specified scope) that the user has
 access to. Query strings can be simple as "x" or more qualified as:

 * name:x
 * column:x
 * description:y

 Note: Query tokens need to have a minimum of 3 characters for substring
 matching to work correctly. See [Data Catalog Search
 Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
 for more information.
        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 in search query syntax. An empty query string
 will result in all data assets (in the specified scope) that the user has
 access to. Query strings can be simple as "x" or more qualified as:

 * name:x
 * column:x
 * description:y

 Note: Query tokens need to have a minimum of 3 characters for substring
 matching to work correctly. See [Data Catalog Search
 Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
 for more information.
        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 in search query syntax. An empty query string
 will result in all data assets (in the specified scope) that the user has
 access to. Query strings can be simple as "x" or more qualified as:

 * name:x
 * column:x
 * description:y

 Note: Query tokens need to have a minimum of 3 characters for substring
 matching to work correctly. See [Data Catalog Search
 Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
 for more information.
        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 in search query syntax. An empty query string
 will result in all data assets (in the specified scope) that the user has
 access to. Query strings can be simple as "x" or more qualified as:

 * name:x
 * column:x
 * description:y

 Note: Query tokens need to have a minimum of 3 characters for substring
 matching to work correctly. See [Data Catalog Search
 Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
 for more information.
        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()
         Number of results in the search page. If <=0 then defaults to 10. Max limit
 for page_size is 1000. Throws an invalid argument for page_size > 1000.
        int32 page_size = 2;
        Specified by:
        getPageSize in interface SearchCatalogRequestOrBuilder
        Returns:
        The pageSize.

      • setPageSize

        public SearchCatalogRequest.Builder setPageSize​(int value)
         Number of results in the search page. If <=0 then defaults to 10. Max limit
 for page_size is 1000. Throws an invalid argument for page_size > 1000.
        int32 page_size = 2;
        Parameters:
        value - The pageSize to set.
        Returns:
        This builder for chaining.

      • clearPageSize

        public SearchCatalogRequest.Builder clearPageSize()
         Number of results in the search page. If <=0 then defaults to 10. Max limit
 for page_size is 1000. Throws an invalid argument for page_size > 1000.
        int32 page_size = 2;
        Returns:
        This builder for chaining.

      • getPageToken

        public String getPageToken()
         Optional. Pagination token returned in an earlier
 [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1beta1.SearchCatalogResponse.next_page_token],
 which indicates that this is a continuation of a prior
 [SearchCatalogRequest][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog]
 call, and that the system should return the next page of data. If empty,
 the first page is returned.
        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 returned in an earlier
 [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1beta1.SearchCatalogResponse.next_page_token],
 which indicates that this is a continuation of a prior
 [SearchCatalogRequest][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog]
 call, and that the system should return the next page of data. If empty,
 the first page is returned.
        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 returned in an earlier
 [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1beta1.SearchCatalogResponse.next_page_token],
 which indicates that this is a continuation of a prior
 [SearchCatalogRequest][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog]
 call, and that the system should return the next page of data. If empty,
 the first page is returned.
        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 returned in an earlier
 [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1beta1.SearchCatalogResponse.next_page_token],
 which indicates that this is a continuation of a prior
 [SearchCatalogRequest][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog]
 call, and that the system should return the next page of data. If empty,
 the first page is returned.
        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 returned in an earlier
 [SearchCatalogResponse.next_page_token][google.cloud.datacatalog.v1beta1.SearchCatalogResponse.next_page_token],
 which indicates that this is a continuation of a prior
 [SearchCatalogRequest][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog]
 call, and that the system should return the next page of data. If empty,
 the first page is returned.
        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 ordering of results, currently supported case-sensitive
 choices are:

   * `relevance`, only supports descending
   * `last_modified_timestamp [asc|desc]`, defaults to descending if not
     specified
   * `default` that can only be descending

 If not specified, defaults to `relevance` descending.
        string order_by = 5;
        Specified by:
        getOrderBy in interface SearchCatalogRequestOrBuilder
        Returns:
        The orderBy.

      • getOrderByBytes

        public com.google.protobuf.ByteString getOrderByBytes()
         Specifies the ordering of results, currently supported case-sensitive
 choices are:

   * `relevance`, only supports descending
   * `last_modified_timestamp [asc|desc]`, defaults to descending if not
     specified
   * `default` that can only be descending

 If not specified, defaults to `relevance` descending.
        string order_by = 5;
        Specified by:
        getOrderByBytes in interface SearchCatalogRequestOrBuilder
        Returns:
        The bytes for orderBy.

      • setOrderBy

        public SearchCatalogRequest.Builder setOrderBy​(String value)
         Specifies the ordering of results, currently supported case-sensitive
 choices are:

   * `relevance`, only supports descending
   * `last_modified_timestamp [asc|desc]`, defaults to descending if not
     specified
   * `default` that can only be descending

 If not specified, defaults to `relevance` descending.
        string order_by = 5;
        Parameters:
        value - The orderBy to set.
        Returns:
        This builder for chaining.

      • clearOrderBy

        public SearchCatalogRequest.Builder clearOrderBy()
         Specifies the ordering of results, currently supported case-sensitive
 choices are:

   * `relevance`, only supports descending
   * `last_modified_timestamp [asc|desc]`, defaults to descending if not
     specified
   * `default` that can only be descending

 If not specified, defaults to `relevance` descending.
        string order_by = 5;
        Returns:
        This builder for chaining.

      • setOrderByBytes

        public SearchCatalogRequest.Builder setOrderByBytes​(com.google.protobuf.ByteString value)
         Specifies the ordering of results, currently supported case-sensitive
 choices are:

   * `relevance`, only supports descending
   * `last_modified_timestamp [asc|desc]`, defaults to descending if not
     specified
   * `default` that can only be descending

 If not specified, defaults to `relevance` descending.
        string order_by = 5;
        Parameters:
        value - The bytes for orderBy to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final SearchCatalogRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>

      • mergeUnknownFields

        public final SearchCatalogRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchCatalogRequest.Builder>