Struct googapis::google::cloud::datacatalog::v1beta1::SearchCatalogRequest

pub struct SearchCatalogRequest {
    pub scope: Option<Scope>,
    pub query: String,
    pub page_size: i32,
    pub page_token: String,
    pub order_by: String,
}

Request message for [SearchCatalog][google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog].

Fields

scope: Option<Scope>

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.

query: String

Required. The query string in search query syntax. The query must be non-empty.

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 for more information.

page_size: i32

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.

page_token: String

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.

order_by: String

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

If not specified, defaults to relevance descending.

Trait Implementations

impl Clone for SearchCatalogRequest

fn clone(&self) -> SearchCatalogRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchCatalogRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SearchCatalogRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for SearchCatalogRequest

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<SearchCatalogRequest> for SearchCatalogRequest

fn eq(&self, other: &SearchCatalogRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SearchCatalogRequest) -> bool

This method tests for !=.

impl StructuralPartialEq for SearchCatalogRequest