Discovery Engine v1 API - Class RankingConfigName (1.6.0)

public sealed class RankingConfigName : IResourceName, IEquatable<RankingConfigName>

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

Resource name for the RankingConfig resource.

Inheritance

object > RankingConfigName

Implements

IResourceName, IEquatable RankingConfigName

Inherited Members

object.GetType()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

RankingConfigName(string, string, string)

public RankingConfigName(string projectId, string locationId, string rankingConfigId)

Constructs a new instance of a RankingConfigName class from the component parts of pattern projects/{project}/locations/{location}/rankingConfigs/{ranking_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.
`rankingConfigId`	`string` The `RankingConfig` ID. Must not be `null` or empty.

Properties

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

RankingConfigId

public string RankingConfigId { get; }

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

Property Value
Type	Description
`string`

Type

public RankingConfigName.ResourceNameType Type { get; }

The RankingConfigName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`RankingConfigNameResourceNameType`

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

Formats the IDs into the string representation of this RankingConfigName with pattern projects/{project}/locations/{location}/rankingConfigs/{ranking_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.
`rankingConfigId`	`string` The `RankingConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this RankingConfigName with pattern `projects/{project}/locations/{location}/rankingConfigs/{ranking_config}`.

FormatProjectLocationRankingConfig(string, string, string)

public static string FormatProjectLocationRankingConfig(string projectId, string locationId, string rankingConfigId)

Formats the IDs into the string representation of this RankingConfigName with pattern projects/{project}/locations/{location}/rankingConfigs/{ranking_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.
`rankingConfigId`	`string` The `RankingConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this RankingConfigName with pattern `projects/{project}/locations/{location}/rankingConfigs/{ranking_config}`.

FromProjectLocationRankingConfig(string, string, string)

public static RankingConfigName FromProjectLocationRankingConfig(string projectId, string locationId, string rankingConfigId)

Creates a RankingConfigName with the pattern projects/{project}/locations/{location}/rankingConfigs/{ranking_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.
`rankingConfigId`	`string` The `RankingConfig` ID. Must not be `null` or empty.

Returns
Type	Description
`RankingConfigName`	A new instance of RankingConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static RankingConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a RankingConfigName containing an unparsed resource name.

Parameter
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

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

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static RankingConfigName Parse(string rankingConfigName)

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

Parameter
Name	Description
`rankingConfigName`	`string` The resource name in string form. Must not be `null`.

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

Remarks

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

projects/{project}/locations/{location}/rankingConfigs/{ranking_config}

Parse(string, bool)

public static RankingConfigName Parse(string rankingConfigName, bool allowUnparsed)

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

Parameters
Name	Description
`rankingConfigName`	`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
`RankingConfigName`	The parsed RankingConfigName if successful.

Remarks

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

projects/{project}/locations/{location}/rankingConfigs/{ranking_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 RankingConfigName)

public static bool TryParse(string rankingConfigName, out RankingConfigName result)

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

Parameters
Name	Description
`rankingConfigName`	`string` The resource name in string form. Must not be `null`.
`result`	`RankingConfigName` When this method returns, the parsed RankingConfigName, 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}/rankingConfigs/{ranking_config}

TryParse(string, bool, out RankingConfigName)

public static bool TryParse(string rankingConfigName, bool allowUnparsed, out RankingConfigName result)

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

Parameters
Name	Description
`rankingConfigName`	`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`	`RankingConfigName` When this method returns, the parsed RankingConfigName, 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}/rankingConfigs/{ranking_config}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(RankingConfigName, RankingConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`RankingConfigName` The first resource name to compare, or null.
`b`	`RankingConfigName` 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 !=(RankingConfigName, RankingConfigName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`RankingConfigName` The first resource name to compare, or null.
`b`	`RankingConfigName` 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.