public sealed class ServingConfigName : IResourceName, IEquatable<ServingConfigName>
Reference documentation and code samples for the Discovery Engine v1beta API class ServingConfigName.
Resource name for the ServingConfig
resource.
Namespace
Google.Cloud.DiscoveryEngine.V1BetaAssembly
Google.Cloud.DiscoveryEngine.V1Beta.dll
Constructors
ServingConfigName(string, string, string, string)
public ServingConfigName(string projectId, string locationId, string dataStoreId, string servingConfigId)
Constructs a new instance of a ServingConfigName class from the component parts of pattern
projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
dataStoreId |
string The |
servingConfigId |
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 |
EngineId
public string EngineId { get; }
The Engine
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 |
ServingConfigId
public string ServingConfigId { get; }
The ServingConfig
ID. May be null
, depending on which resource name is contained by this
instance.
Property Value | |
---|---|
Type | Description |
string |
Type
public ServingConfigName.ResourceNameType Type { get; }
The ServingConfigName.ResourceNameType of the contained resource name.
Property Value | |
---|---|
Type | Description |
ServingConfigNameResourceNameType |
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 servingConfigId)
Formats the IDs into the string representation of this ServingConfigName with pattern
projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
dataStoreId |
string The |
servingConfigId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this ServingConfigName with pattern
|
FormatProjectLocationCollectionDataStoreServingConfig(string, string, string, string, string)
public static string FormatProjectLocationCollectionDataStoreServingConfig(string projectId, string locationId, string collectionId, string dataStoreId, string servingConfigId)
Formats the IDs into the string representation of this ServingConfigName with pattern
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
collectionId |
string The |
dataStoreId |
string The |
servingConfigId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this ServingConfigName with pattern
|
FormatProjectLocationCollectionEngineServingConfig(string, string, string, string, string)
public static string FormatProjectLocationCollectionEngineServingConfig(string projectId, string locationId, string collectionId, string engineId, string servingConfigId)
Formats the IDs into the string representation of this ServingConfigName with pattern
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
collectionId |
string The |
engineId |
string The |
servingConfigId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this ServingConfigName with pattern
|
FormatProjectLocationDataStoreServingConfig(string, string, string, string)
public static string FormatProjectLocationDataStoreServingConfig(string projectId, string locationId, string dataStoreId, string servingConfigId)
Formats the IDs into the string representation of this ServingConfigName with pattern
projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
dataStoreId |
string The |
servingConfigId |
string The |
Returns | |
---|---|
Type | Description |
string |
The string representation of this ServingConfigName with pattern
|
FromProjectLocationCollectionDataStoreServingConfig(string, string, string, string, string)
public static ServingConfigName FromProjectLocationCollectionDataStoreServingConfig(string projectId, string locationId, string collectionId, string dataStoreId, string servingConfigId)
Creates a ServingConfigName with the pattern
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
collectionId |
string The |
dataStoreId |
string The |
servingConfigId |
string The |
Returns | |
---|---|
Type | Description |
ServingConfigName |
A new instance of ServingConfigName constructed from the provided ids. |
FromProjectLocationCollectionEngineServingConfig(string, string, string, string, string)
public static ServingConfigName FromProjectLocationCollectionEngineServingConfig(string projectId, string locationId, string collectionId, string engineId, string servingConfigId)
Creates a ServingConfigName with the pattern
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
collectionId |
string The |
engineId |
string The |
servingConfigId |
string The |
Returns | |
---|---|
Type | Description |
ServingConfigName |
A new instance of ServingConfigName constructed from the provided ids. |
FromProjectLocationDataStoreServingConfig(string, string, string, string)
public static ServingConfigName FromProjectLocationDataStoreServingConfig(string projectId, string locationId, string dataStoreId, string servingConfigId)
Creates a ServingConfigName with the pattern
projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}
.
Parameters | |
---|---|
Name | Description |
projectId |
string The |
locationId |
string The |
dataStoreId |
string The |
servingConfigId |
string The |
Returns | |
---|---|
Type | Description |
ServingConfigName |
A new instance of ServingConfigName constructed from the provided ids. |
FromUnparsed(UnparsedResourceName)
public static ServingConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)
Creates a ServingConfigName containing an unparsed resource name.
Parameter | |
---|---|
Name | Description |
unparsedResourceName |
UnparsedResourceName The unparsed resource name. Must not be |
Returns | |
---|---|
Type | Description |
ServingConfigName |
A new instance of ServingConfigName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
Parse(string)
public static ServingConfigName Parse(string servingConfigName)
Parses the given resource name string into a new ServingConfigName instance.
Parameter | |
---|---|
Name | Description |
servingConfigName |
string The resource name in string form. Must not be |
Returns | |
---|---|
Type | Description |
ServingConfigName |
The parsed ServingConfigName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}
Parse(string, bool)
public static ServingConfigName Parse(string servingConfigName, bool allowUnparsed)
Parses the given resource name string into a new ServingConfigName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
servingConfigName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
Returns | |
---|---|
Type | Description |
ServingConfigName |
The parsed ServingConfigName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}
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 ServingConfigName)
public static bool TryParse(string servingConfigName, out ServingConfigName result)
Tries to parse the given resource name string into a new ServingConfigName instance.
Parameters | |
---|---|
Name | Description |
servingConfigName |
string The resource name in string form. Must not be |
result |
ServingConfigName When this method returns, the parsed ServingConfigName, 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}/servingConfigs/{serving_config}
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}
TryParse(string, bool, out ServingConfigName)
public static bool TryParse(string servingConfigName, bool allowUnparsed, out ServingConfigName result)
Tries to parse the given resource name string into a new ServingConfigName instance; optionally allowing an unparseable resource name.
Parameters | |
---|---|
Name | Description |
servingConfigName |
string The resource name in string form. Must not be |
allowUnparsed |
bool If |
result |
ServingConfigName When this method returns, the parsed ServingConfigName, 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}/servingConfigs/{serving_config}
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}
projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}
allowUnparsed
is true
.
Operators
operator ==(ServingConfigName, ServingConfigName)
public static bool operator ==(ServingConfigName a, ServingConfigName b)
Determines whether two specified resource names have the same value.
Parameters | |
---|---|
Name | Description |
a |
ServingConfigName The first resource name to compare, or null. |
b |
ServingConfigName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |
operator !=(ServingConfigName, ServingConfigName)
public static bool operator !=(ServingConfigName a, ServingConfigName b)
Determines whether two specified resource names have different values.
Parameters | |
---|---|
Name | Description |
a |
ServingConfigName The first resource name to compare, or null. |
b |
ServingConfigName The second resource name to compare, or null. |
Returns | |
---|---|
Type | Description |
bool |
true if the value of |