Struct google_api_proto::google::cloud::discoveryengine::v1::TargetSite

pub struct TargetSite {
    pub name: String,
    pub provided_uri_pattern: String,
    pub type: i32,
    pub exact_match: bool,
    pub generated_uri_pattern: String,
    pub site_verification_info: Option<SiteVerificationInfo>,
    pub indexing_status: i32,
    pub update_time: Option<Timestamp>,
    pub failure_reason: Option<FailureReason>,
}

A target site for the SiteSearchEngine.

Fields

name: String

Output only. The fully qualified resource name of the target site. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site} The target_site_id is system-generated.

provided_uri_pattern: String

Required. Input only. The user provided URI pattern from which the generated_uri_pattern is generated.

type: i32

The type of the target site, e.g., whether the site is to be included or excluded.

exact_match: bool

Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.

generated_uri_pattern: String

Output only. This is system-generated based on the provided_uri_pattern.

site_verification_info: Option<SiteVerificationInfo>

Output only. Site ownership and validity verification status.

indexing_status: i32

Output only. Indexing status.

update_time: Option<Timestamp>

Output only. The target site’s last updated time.

failure_reason: Option<FailureReason>

Output only. Failure reason.

Implementations

impl TargetSite

pub fn type(&self) -> Type

Returns the enum value of type, or the default if the field is set to an invalid enum value.

pub fn set_type(&mut self, value: Type)

Sets type to the provided enum value.

pub fn indexing_status(&self) -> IndexingStatus

Returns the enum value of indexing_status, or the default if the field is set to an invalid enum value.

pub fn set_indexing_status(&mut self, value: IndexingStatus)

Sets indexing_status to the provided enum value.

Trait Implementations

impl Clone for TargetSite

fn clone(&self) -> TargetSite

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TargetSite

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

Formats the value using the given formatter.

impl Default for TargetSite

fn default() -> Self

Returns the “default value” for a type.

impl Message for TargetSite

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

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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

where B: Buf, Self: Default,

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

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

where B: Buf, Self: Sized,

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, Self: Sized,

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

impl PartialEq for TargetSite

fn eq(&self, other: &TargetSite) -> 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 TargetSite