Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class ServingConfigName (2.2.0)

public sealed class ServingConfigName : IResourceName, IEquatable<ServingConfigName>

Resource name for the ServingConfig resource.

Inheritance

Object > ServingConfigName

Implements

IResourceName, IEquatable<ServingConfigName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

ServingConfigName(String, String, String, String)

public ServingConfigName(string projectId, string locationId, string catalogId, string servingConfigId)

Constructs a new instance of a ServingConfigName class from the component parts of pattern projects/{project}/locations/{location}/catalogs/{catalog}/servingConfigs/{serving_config}

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.
`catalogId`	`String` The `Catalog` ID. Must not be `null` or empty.
`servingConfigId`	`String` The `ServingConfig` ID. Must not be `null` or empty.

Properties

CatalogId

public string CatalogId { get; }

The Catalog ID. Will not be null, unless this instance contains an unparsed resource name.

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
`Boolean`

LocationId

public string LocationId { get; }

The Location ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`String`

ProjectId

public string ProjectId { get; }

The Project ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`String`

ServingConfigId

public string ServingConfigId { get; }

The ServingConfig ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type	Description
`String`

Type

public ServingConfigName.ResourceNameType Type { get; }

The ServingConfigName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ServingConfigName.ResourceNameType`

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 catalogId, string servingConfigId)

Formats the IDs into the string representation of this ServingConfigName with pattern projects/{project}/locations/{location}/catalogs/{catalog}/servingConfigs/{serving_config}.

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.
`catalogId`	`String` The `Catalog` ID. Must not be `null` or empty.
`servingConfigId`	`String` The `ServingConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this ServingConfigName with pattern `projects/{project}/locations/{location}/catalogs/{catalog}/servingConfigs/{serving_config}`.

FormatProjectLocationCatalogServingConfig(String, String, String, String)

public static string FormatProjectLocationCatalogServingConfig(string projectId, string locationId, string catalogId, string servingConfigId)

Formats the IDs into the string representation of this ServingConfigName with pattern projects/{project}/locations/{location}/catalogs/{catalog}/servingConfigs/{serving_config}.

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.
`catalogId`	`String` The `Catalog` ID. Must not be `null` or empty.
`servingConfigId`	`String` The `ServingConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this ServingConfigName with pattern `projects/{project}/locations/{location}/catalogs/{catalog}/servingConfigs/{serving_config}`.

FromProjectLocationCatalogServingConfig(String, String, String, String)

public static ServingConfigName FromProjectLocationCatalogServingConfig(string projectId, string locationId, string catalogId, string servingConfigId)

Creates a ServingConfigName with the pattern projects/{project}/locations/{location}/catalogs/{catalog}/servingConfigs/{serving_config}.

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.
`catalogId`	`String` The `Catalog` ID. Must not be `null` or empty.
`servingConfigId`	`String` The `ServingConfig` ID. Must not be `null` or empty.

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 `null`.

Returns
Type	Description
`ServingConfigName`	A new instance of ServingConfigName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

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 `null`.

Returns
Type	Description
`ServingConfigName`	The parsed ServingConfigName if successful.

Remarks

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

projects/{project}/locations/{location}/catalogs/{catalog}/servingConfigs/{serving_config}

Parse(String, Boolean)

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 `null`.
`allowUnparsed`	`Boolean` 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
`ServingConfigName`	The parsed ServingConfigName if successful.

Remarks

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

projects/{project}/locations/{location}/catalogs/{catalog}/servingConfigs/{serving_config}

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

Object.ToString()

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 `null`.
`result`	`ServingConfigName` When this method returns, the parsed ServingConfigName, or `null` if parsing failed.

Returns
Type	Description
`Boolean`	`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}/catalogs/{catalog}/servingConfigs/{serving_config}

TryParse(String, Boolean, 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 `null`.
`allowUnparsed`	`Boolean` 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`	`ServingConfigName` When this method returns, the parsed ServingConfigName, or `null` if parsing failed.

Returns
Type	Description
`Boolean`	`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}/catalogs/{catalog}/servingConfigs/{serving_config}

Or may be in any format if allowUnparsed is true.

Operators

Equality(ServingConfigName, ServingConfigName)

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

Parameters
Name	Description
`a`	`ServingConfigName`
`b`	`ServingConfigName`

Returns
Type	Description
`Boolean`

Inequality(ServingConfigName, ServingConfigName)

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

Parameters
Name	Description
`a`	`ServingConfigName`
`b`	`ServingConfigName`

Returns
Type	Description
`Boolean`