Discovery Engine v1 API - Class TargetSiteName (1.0.0-beta05)

public sealed class TargetSiteName : IResourceName, IEquatable<TargetSiteName>

Reference documentation and code samples for the Discovery Engine v1 API class TargetSiteName.

Resource name for the TargetSite resource.

Inheritance

object > TargetSiteName

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

TargetSiteName(string, string, string, string)

public TargetSiteName(string projectId, string locationId, string dataStoreId, string targetSiteId)

Constructs a new instance of a TargetSiteName class from the component parts of pattern projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

dataStoreId string

The DataStore ID. Must not be null or empty.

targetSiteId string

The TargetSite ID. Must not be null or empty.

Properties

CollectionId

public string CollectionId { get; }

The Collection ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

DataStoreId

public string DataStoreId { get; }

The DataStore ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
Type Description
bool

LocationId

public string LocationId { get; }

The Location ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

TargetSiteId

public string TargetSiteId { get; }

The TargetSite ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

Type

public TargetSiteName.ResourceNameType Type { get; }

The TargetSiteName.ResourceNameType of the contained resource name.

Property Value
Type Description
TargetSiteNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

Methods

Format(string, string, string, string)

public static string Format(string projectId, string locationId, string dataStoreId, string targetSiteId)

Formats the IDs into the string representation of this TargetSiteName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

dataStoreId string

The DataStore ID. Must not be null or empty.

targetSiteId string

The TargetSite ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this TargetSiteName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site} .

FormatProjectLocationCollectionDataStoreTargetSite(string, string, string, string, string)

public static string FormatProjectLocationCollectionDataStoreTargetSite(string projectId, string locationId, string collectionId, string dataStoreId, string targetSiteId)

Formats the IDs into the string representation of this TargetSiteName with pattern projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

collectionId string

The Collection ID. Must not be null or empty.

dataStoreId string

The DataStore ID. Must not be null or empty.

targetSiteId string

The TargetSite ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this TargetSiteName with pattern projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site} .

FormatProjectLocationDataStoreTargetSite(string, string, string, string)

public static string FormatProjectLocationDataStoreTargetSite(string projectId, string locationId, string dataStoreId, string targetSiteId)

Formats the IDs into the string representation of this TargetSiteName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

dataStoreId string

The DataStore ID. Must not be null or empty.

targetSiteId string

The TargetSite ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this TargetSiteName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site} .

FromProjectLocationCollectionDataStoreTargetSite(string, string, string, string, string)

public static TargetSiteName FromProjectLocationCollectionDataStoreTargetSite(string projectId, string locationId, string collectionId, string dataStoreId, string targetSiteId)

Creates a TargetSiteName with the pattern projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

collectionId string

The Collection ID. Must not be null or empty.

dataStoreId string

The DataStore ID. Must not be null or empty.

targetSiteId string

The TargetSite ID. Must not be null or empty.

Returns
Type Description
TargetSiteName

A new instance of TargetSiteName constructed from the provided ids.

FromProjectLocationDataStoreTargetSite(string, string, string, string)

public static TargetSiteName FromProjectLocationDataStoreTargetSite(string projectId, string locationId, string dataStoreId, string targetSiteId)

Creates a TargetSiteName with the pattern projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site} .

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

dataStoreId string

The DataStore ID. Must not be null or empty.

targetSiteId string

The TargetSite ID. Must not be null or empty.

Returns
Type Description
TargetSiteName

A new instance of TargetSiteName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TargetSiteName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TargetSiteName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
TargetSiteName

A new instance of TargetSiteName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static TargetSiteName Parse(string targetSiteName)

Parses the given resource name string into a new TargetSiteName instance.

Parameter
Name Description
targetSiteName string

The resource name in string form. Must not be null.

Returns
Type Description
TargetSiteName

The parsed TargetSiteName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}
  • projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}

Parse(string, bool)

public static TargetSiteName Parse(string targetSiteName, bool allowUnparsed)

Parses the given resource name string into a new TargetSiteName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
targetSiteName string

The resource name in string form. Must not be null.

allowUnparsed bool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

Returns
Type Description
TargetSiteName

The parsed TargetSiteName if successful.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}
  • projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}
Or may be in any format if allowUnparsed is true.

ToString()

public override string ToString()

The string representation of the resource name.

Returns
Type Description
string

The string representation of the resource name.

Overrides

TryParse(string, out TargetSiteName)

public static bool TryParse(string targetSiteName, out TargetSiteName result)

Tries to parse the given resource name string into a new TargetSiteName instance.

Parameters
Name Description
targetSiteName string

The resource name in string form. Must not be null.

result TargetSiteName

When this method returns, the parsed TargetSiteName, or null if parsing failed.

Returns
Type Description
bool

true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}
  • projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}

TryParse(string, bool, out TargetSiteName)

public static bool TryParse(string targetSiteName, bool allowUnparsed, out TargetSiteName result)

Tries to parse the given resource name string into a new TargetSiteName instance; optionally allowing an unparseable resource name.

Parameters
Name Description
targetSiteName string

The resource name in string form. Must not be null.

allowUnparsed bool

If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an ArgumentException if an unparseable resource name is specified.

result TargetSiteName

When this method returns, the parsed TargetSiteName, or null if parsing failed.

Returns
Type Description
bool

true if the name was parsed successfully; false otherwise.

Remarks

To parse successfully, the resource name must be formatted as one of the following:

  • projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}
  • projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(TargetSiteName, TargetSiteName)

public static bool operator ==(TargetSiteName a, TargetSiteName b)

Determines whether two specified resource names have the same value.

Parameters
Name Description
a TargetSiteName

The first resource name to compare, or null.

b TargetSiteName

The second resource name to compare, or null.

Returns
Type Description
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(TargetSiteName, TargetSiteName)

public static bool operator !=(TargetSiteName a, TargetSiteName b)

Determines whether two specified resource names have different values.

Parameters
Name Description
a TargetSiteName

The first resource name to compare, or null.

b TargetSiteName

The second resource name to compare, or null.

Returns
Type Description
bool

true if the value of a is different from the value of b; otherwise, false.