Console
    Start free

    Google Cloud Discovery Engine V1 Client - Class TargetSite (1.9.1)

    Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class TargetSite.

    A target site for the SiteSearchEngine.

    Generated from protobuf message google.cloud.discoveryengine.v1.TargetSite

    Namespace

    Google \ Cloud \ DiscoveryEngine \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ 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
    int

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

    ↳ exact_match
    bool

    Immutable. 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.

    ↳ root_domain_uri
    string

    Output only. Root domain of the provided_uri_pattern.

    ↳ site_verification_info
    SiteVerificationInfo

    Output only. Site ownership and validity verification status.

    ↳ indexing_status
    int

    Output only. Indexing status.

    ↳ update_time
    Google\Protobuf\Timestamp

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

    ↳ failure_reason
    TargetSite\FailureReason

    Output only. Failure reason.

    getName

    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.

    Returns
    Type
    Description
    string

    setName

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getProvidedUriPattern

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

    Returns
    Type
    Description
    string

    setProvidedUriPattern

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getType

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

    Returns
    Type
    Description
    int
    Enum of type Type .

    setType

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

    Parameter
    Name
    Description
    var
    int

    Enum of type Type .

    Returns
    Type
    Description
    $this

    getExactMatch

    Immutable. 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.

    Returns
    Type
    Description
    bool

    setExactMatch

    Immutable. 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.

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getGeneratedUriPattern

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

    Returns
    Type
    Description
    string

    setGeneratedUriPattern

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getRootDomainUri

    Output only. Root domain of the provided_uri_pattern.

    Returns
    Type
    Description
    string

    setRootDomainUri

    Output only. Root domain of the provided_uri_pattern.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getSiteVerificationInfo

    Output only. Site ownership and validity verification status.

    Returns
    Type
    Description
    SiteVerificationInfo |null

    hasSiteVerificationInfo

    clearSiteVerificationInfo

    setSiteVerificationInfo

    Output only. Site ownership and validity verification status.

    Parameter
    Name
    Description
    var
    SiteVerificationInfo
    Returns
    Type
    Description
    $this

    getIndexingStatus

    Output only. Indexing status.

    Returns
    Type
    Description
    int
    Enum of type IndexingStatus .

    setIndexingStatus

    Output only. Indexing status.

    Parameter
    Name
    Description
    var
    int

    Enum of type IndexingStatus .

    Returns
    Type
    Description
    $this

    getUpdateTime

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

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasUpdateTime

    clearUpdateTime

    setUpdateTime

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

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getFailureReason

    Output only. Failure reason.

    Returns
    Type
    Description
    TargetSite\FailureReason |null

    hasFailureReason

    clearFailureReason

    setFailureReason

    Output only. Failure reason.

    Parameter
    Name
    Description
    var
    TargetSite\FailureReason
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: