Class SearchCatalogRequest

  • All Implemented Interfaces:
    SearchCatalogRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class SearchCatalogRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements SearchCatalogRequestOrBuilder
     Request message for
     [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].
     
    Protobuf type google.cloud.datacatalog.v1.SearchCatalogRequest
    See Also:
    Serialized Form
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • 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
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static SearchCatalogRequest parseFrom​(ByteBuffer data)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SearchCatalogRequest parseFrom​(ByteBuffer data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SearchCatalogRequest parseFrom​(com.google.protobuf.ByteString data)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SearchCatalogRequest parseFrom​(com.google.protobuf.ByteString data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SearchCatalogRequest parseFrom​(byte[] data)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SearchCatalogRequest parseFrom​(byte[] data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • newBuilderForType

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

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

        protected SearchCatalogRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<SearchCatalogRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

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