Struct ListTargetSitesRequest 

#[non_exhaustive]
pub struct ListTargetSitesRequest {
    pub parent: String,
    pub page_size: i32,
    pub page_token: String,
    /* private fields */
}

Available on crate feature site-search-engine-service only.

Request message for SiteSearchEngineService.ListTargetSites method.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

parent: String

Required. The parent site search engine resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

page_size: i32

Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT error is returned.

page_token: String

A page token, received from a previous ListTargetSites call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListTargetSites must match the call that provided the page token.

Implementations

impl ListTargetSitesRequest

pub fn new() -> Self

pub fn set_parent<T: Into<String>>(self, v: T) -> Self

Sets the value of parent.

Example

let x = ListTargetSitesRequest::new().set_parent("example");

pub fn set_page_size<T: Into<i32>>(self, v: T) -> Self

Sets the value of page_size.

Example

let x = ListTargetSitesRequest::new().set_page_size(42);

pub fn set_page_token<T: Into<String>>(self, v: T) -> Self

Sets the value of page_token.

Example

let x = ListTargetSitesRequest::new().set_page_token("example");

Trait Implementations

impl Clone for ListTargetSitesRequest

fn clone(&self) -> ListTargetSitesRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListTargetSitesRequest

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

Formats the value using the given formatter.

impl Default for ListTargetSitesRequest

fn default() -> ListTargetSitesRequest

Returns the “default value” for a type.

impl Message for ListTargetSitesRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ListTargetSitesRequest

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ListTargetSitesRequest