Discovery Engine v1 API - Class SitemapName (1.10.0) 

public sealed class SitemapName : IResourceName, IEquatable<SitemapName>

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

Resource name for the Sitemap resource.

Inheritance

object > SitemapName

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

SitemapName(string, string, string, string)

public SitemapName(string projectId, string locationId, string dataStoreId, string sitemapId)

Constructs a new instance of a SitemapName class from the component parts of pattern projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}

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.
sitemapId string

The Sitemap 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

SitemapId

public string SitemapId { get; }

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

Property Value
Type Description
string

Type

public SitemapName.ResourceNameType Type { get; }

The SitemapName.ResourceNameType of the contained resource name.

Property Value
Type Description
SitemapNameResourceNameType

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 sitemapId)

Formats the IDs into the string representation of this SitemapName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}.

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.
sitemapId string

The Sitemap ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this SitemapName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}.

FormatProjectLocationCollectionDataStoreSitemap(string, string, string, string, string)

public static string FormatProjectLocationCollectionDataStoreSitemap(string projectId, string locationId, string collectionId, string dataStoreId, string sitemapId)

Formats the IDs into the string representation of this SitemapName with pattern projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap} .

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.
sitemapId string

The Sitemap ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this SitemapName with pattern projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap} .

FormatProjectLocationDataStoreSitemap(string, string, string, string)

public static string FormatProjectLocationDataStoreSitemap(string projectId, string locationId, string dataStoreId, string sitemapId)

Formats the IDs into the string representation of this SitemapName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}.

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.
sitemapId string

The Sitemap ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this SitemapName with pattern projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}.

FromProjectLocationCollectionDataStoreSitemap(string, string, string, string, string)

public static SitemapName FromProjectLocationCollectionDataStoreSitemap(string projectId, string locationId, string collectionId, string dataStoreId, string sitemapId)

Creates a SitemapName with the pattern projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap} .

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.
sitemapId string

The Sitemap ID. Must not be null or empty.
Returns
Type Description
SitemapName

A new instance of SitemapName constructed from the provided ids.

FromProjectLocationDataStoreSitemap(string, string, string, string)

public static SitemapName FromProjectLocationDataStoreSitemap(string projectId, string locationId, string dataStoreId, string sitemapId)

Creates a SitemapName with the pattern projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}.

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.
sitemapId string

The Sitemap ID. Must not be null or empty.
Returns
Type Description
SitemapName

A new instance of SitemapName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static SitemapName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SitemapName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
SitemapName

A new instance of SitemapName 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 SitemapName Parse(string sitemapName)

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

Parameter
Name Description
sitemapName string

The resource name in string form. Must not be null.
Returns
Type Description
SitemapName

The parsed SitemapName 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/sitemaps/{sitemap}
  • projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}

Parse(string, bool)

public static SitemapName Parse(string sitemapName, bool allowUnparsed)

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

Parameters
Name Description
sitemapName 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
SitemapName

The parsed SitemapName 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/sitemaps/{sitemap}
  • projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}
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 SitemapName)

public static bool TryParse(string sitemapName, out SitemapName result)

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

Parameters
Name Description
sitemapName string

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

When this method returns, the parsed SitemapName, 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/sitemaps/{sitemap}
  • projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}

TryParse(string, bool, out SitemapName)

public static bool TryParse(string sitemapName, bool allowUnparsed, out SitemapName result)

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

Parameters
Name Description
sitemapName 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 SitemapName

When this method returns, the parsed SitemapName, 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/sitemaps/{sitemap}
  • projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(SitemapName, SitemapName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a SitemapName

The first resource name to compare, or null.
b SitemapName

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 !=(SitemapName, SitemapName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a SitemapName

The first resource name to compare, or null.
b SitemapName

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.