Struct google_api_proto::google::cloud::datacatalog::v1::search_catalog_request::Scope

pub struct Scope {
    pub include_org_ids: Vec<String>,
    pub include_project_ids: Vec<String>,
    pub include_gcp_public_datasets: bool,
    pub restricted_locations: Vec<String>,
    pub starred_only: bool,
    pub include_public_tag_templates: bool,
}

The criteria that select the subspace used for query matching.

Fields

include_org_ids: Vec<String>

The list of organization IDs to search within.

To find your organization ID, follow the steps from [Creating and managing organizations] (/resource-manager/docs/creating-managing-organization).

include_project_ids: Vec<String>

The list of project IDs to search within.

For more information on the distinction between project names, IDs, and numbers, see Projects.

include_gcp_public_datasets: bool

If true, include Google Cloud public datasets in search results. By default, they are excluded.

See Google Cloud Public Datasets for more information.

restricted_locations: Vec<String>

Optional. The list of locations to search within. If empty, all locations are searched.

Returns an error if any location in the list isn’t one of the Supported regions.

If a location is unreachable, its name is returned in the SearchCatalogResponse.unreachable field. To get additional information on the error, repeat the search request and set the location name as the value of this parameter.

starred_only: bool

Optional. If true, search only among starred entries.

By default, all results are returned, starred or not.

include_public_tag_templates: bool

👎Deprecated

Optional. This field is deprecated. The search mechanism for public and private tag templates is the same.

Trait Implementations

impl Clone for Scope

fn clone(&self) -> Scope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Scope

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

Formats the value using the given formatter.

impl Default for Scope

fn default() -> Self

Returns the “default value” for a type.

impl Message for Scope

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(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

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

where Self: Sized,

Encodes the message to a newly allocated buffer.

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

where Self: Sized,

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

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

where Self: Sized,

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

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

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

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

where Self: Sized,

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

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

where Self: Sized,

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

impl PartialEq for Scope

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Scope