public sealed class SiteSearchEngineName : IResourceName, IEquatable<SiteSearchEngineName>
Reference documentation and code samples for the Discovery Engine v1 API class SiteSearchEngineName.
Resource name for the SiteSearchEngine
resource.
Inherited Members
Namespace
Google.Cloud.DiscoveryEngine.V1Assembly
Google.Cloud.DiscoveryEngine.V1.dll
Constructors
SiteSearchEngineName(string, string, string)
public SiteSearchEngineName(string projectId, string locationId, string dataStoreId)
Constructs a new instance of a SiteSearchEngineName class from the component parts of pattern
projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
dataStoreId |
string The |
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 |
Type
public SiteSearchEngineName.ResourceNameType Type { get; }
The SiteSearchEngineName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
SiteSearchEngineNameResourceNameType |
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)
public static string Format(string projectId, string locationId, string dataStoreId)
Formats the IDs into the string representation of this SiteSearchEngineName with pattern
projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
dataStoreId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this SiteSearchEngineName with pattern
|
FormatProjectLocationCollectionDataStore(string, string, string, string)
public static string FormatProjectLocationCollectionDataStore(string projectId, string locationId, string collectionId, string dataStoreId)
Formats the IDs into the string representation of this SiteSearchEngineName with pattern
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
collectionId |
string The |
dataStoreId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this SiteSearchEngineName with pattern
|
FormatProjectLocationDataStore(string, string, string)
public static string FormatProjectLocationDataStore(string projectId, string locationId, string dataStoreId)
Formats the IDs into the string representation of this SiteSearchEngineName with pattern
projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
dataStoreId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this SiteSearchEngineName with pattern
|
FromProjectLocationCollectionDataStore(string, string, string, string)
public static SiteSearchEngineName FromProjectLocationCollectionDataStore(string projectId, string locationId, string collectionId, string dataStoreId)
Creates a SiteSearchEngineName with the pattern
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
collectionId |
string The |
dataStoreId |
string The |
Returns | |
---|---|
Type | Description |
SiteSearchEngineName |
A new instance of SiteSearchEngineName constructed from the provided ids. |
FromProjectLocationDataStore(string, string, string)
public static SiteSearchEngineName FromProjectLocationDataStore(string projectId, string locationId, string dataStoreId)
Creates a SiteSearchEngineName with the pattern
projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
dataStoreId |
string The |
Returns | |
---|---|
Type | Description |
SiteSearchEngineName |
A new instance of SiteSearchEngineName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static SiteSearchEngineName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a SiteSearchEngineName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName |
UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
SiteSearchEngineName |
A new instance of SiteSearchEngineName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static SiteSearchEngineName Parse(string siteSearchEngineName)
Parses the given resource name string into a new SiteSearchEngineName instance.
Parameter | |
---|---|
Name | Description |
siteSearchEngineName |
string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
SiteSearchEngineName |
The parsed SiteSearchEngineName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine
Parse(string, bool)
public static SiteSearchEngineName Parse(string siteSearchEngineName, bool allowUnparsed)
Parses the given resource name string into a new SiteSearchEngineName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
siteSearchEngineName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
Returns | |
---|---|
Type | Description |
SiteSearchEngineName |
The parsed SiteSearchEngineName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine
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. |
TryParse(string, out SiteSearchEngineName)
public static bool TryParse(string siteSearchEngineName, out SiteSearchEngineName result)
Tries to parse the given resource name string into a new SiteSearchEngineName instance.
Parameters | |
---|---|
Name | Description |
siteSearchEngineName |
string The resource name in string form. Must not be |
result |
SiteSearchEngineName When this method returns, the parsed SiteSearchEngineName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine
TryParse(string, bool, out SiteSearchEngineName)
public static bool TryParse(string siteSearchEngineName, bool allowUnparsed, out SiteSearchEngineName result)
Tries to parse the given resource name string into a new SiteSearchEngineName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
siteSearchEngineName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
result |
SiteSearchEngineName When this method returns, the parsed SiteSearchEngineName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine
allowUnparsed
is true
.
Operators
operator ==(SiteSearchEngineName, SiteSearchEngineName)
public static bool operator ==(SiteSearchEngineName a, SiteSearchEngineName b)
Determines whether two specified resource names have the same value.
Parameters | |
---|---|
Name | Description |
a |
SiteSearchEngineName The first resource name to compare, or null. |
b |
SiteSearchEngineName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |
operator !=(SiteSearchEngineName, SiteSearchEngineName)
public static bool operator !=(SiteSearchEngineName a, SiteSearchEngineName b)
Determines whether two specified resource names have different values.
Parameters | |
---|---|
Name | Description |
a |
SiteSearchEngineName The first resource name to compare, or null. |
b |
SiteSearchEngineName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |