Retail v2 API - Class ServingConfigName (2.4.0)

public sealed class ServingConfigName : IResourceName, IEquatable<ServingConfigName>

Reference documentation and code samples for the Retail v2 API class ServingConfigName.

Resource name for the ServingConfig resource.

Inheritance

Object > ServingConfigName

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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

catalogIdString

The Catalog ID. Must not be null or empty.

servingConfigIdString

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
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
Boolean

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

ServingConfigId

public string ServingConfigId { get; }

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

Property Value
TypeDescription
String

Type

public ServingConfigName.ResourceNameType Type { get; }

The ServingConfigName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ServingConfigName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

catalogIdString

The Catalog ID. Must not be null or empty.

servingConfigIdString

The ServingConfig ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

catalogIdString

The Catalog ID. Must not be null or empty.

servingConfigIdString

The ServingConfig ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

catalogIdString

The Catalog ID. Must not be null or empty.

servingConfigIdString

The ServingConfig ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ServingConfigName

A new instance of ServingConfigName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static ServingConfigName Parse(string servingConfigName)

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

Parameter
NameDescription
servingConfigNameString

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

Returns
TypeDescription
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
NameDescription
servingConfigNameString

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

allowUnparsedBoolean

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
TypeDescription
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
TypeDescription
String

The string representation of the resource name.

Overrides

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
NameDescription
servingConfigNameString

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

resultServingConfigName

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

Returns
TypeDescription
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
NameDescription
servingConfigNameString

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

allowUnparsedBoolean

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.

resultServingConfigName

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

Returns
TypeDescription
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
NameDescription
aServingConfigName
bServingConfigName
Returns
TypeDescription
Boolean

Inequality(ServingConfigName, ServingConfigName)

public static bool operator !=(ServingConfigName a, ServingConfigName b)
Parameters
NameDescription
aServingConfigName
bServingConfigName
Returns
TypeDescription
Boolean