Retail v2 API - Class ExperimentName (2.11.0)

public sealed class ExperimentName : IResourceName, IEquatable<ExperimentName>

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

Resource name for the Experiment resource.

Inheritance

object > ExperimentName

Implements

IResourceName, IEquatable ExperimentName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

ExperimentName(string, string, string, string)

public ExperimentName(string projectId, string locationId, string catalogId, string experimentId)

Constructs a new instance of a ExperimentName class from the component parts of pattern projects/{project}/locations/{location}/catalogs/{catalog}/experiments/{experiment}

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.
`experimentId`	`string` The `Experiment` 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`

ExperimentId

public string ExperimentId { get; }

The Experiment 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
`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`

Type

public ExperimentName.ResourceNameType Type { get; }

The ExperimentName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ExperimentNameResourceNameType`

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

Formats the IDs into the string representation of this ExperimentName with pattern projects/{project}/locations/{location}/catalogs/{catalog}/experiments/{experiment}.

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.
`experimentId`	`string` The `Experiment` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ExperimentName with pattern `projects/{project}/locations/{location}/catalogs/{catalog}/experiments/{experiment}`.

FormatProjectLocationCatalogExperiment(string, string, string, string)

public static string FormatProjectLocationCatalogExperiment(string projectId, string locationId, string catalogId, string experimentId)

Formats the IDs into the string representation of this ExperimentName with pattern projects/{project}/locations/{location}/catalogs/{catalog}/experiments/{experiment}.

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.
`experimentId`	`string` The `Experiment` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this ExperimentName with pattern `projects/{project}/locations/{location}/catalogs/{catalog}/experiments/{experiment}`.

FromProjectLocationCatalogExperiment(string, string, string, string)

public static ExperimentName FromProjectLocationCatalogExperiment(string projectId, string locationId, string catalogId, string experimentId)

Creates a ExperimentName with the pattern projects/{project}/locations/{location}/catalogs/{catalog}/experiments/{experiment}.

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.
`experimentId`	`string` The `Experiment` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static ExperimentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ExperimentName containing an unparsed resource name.

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

Returns
Type	Description
`ExperimentName`	A new instance of ExperimentName 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 ExperimentName Parse(string experimentName)

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

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

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

Remarks

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

projects/{project}/locations/{location}/catalogs/{catalog}/experiments/{experiment}

Parse(string, bool)

public static ExperimentName Parse(string experimentName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/catalogs/{catalog}/experiments/{experiment}

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

public static bool TryParse(string experimentName, out ExperimentName result)

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

Parameters
Name	Description
`experimentName`	`string` The resource name in string form. Must not be `null`.
`result`	`ExperimentName` When this method returns, the parsed ExperimentName, 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}/catalogs/{catalog}/experiments/{experiment}

TryParse(string, bool, out ExperimentName)

public static bool TryParse(string experimentName, bool allowUnparsed, out ExperimentName result)

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

Parameters
Name	Description
`experimentName`	`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`	`ExperimentName` When this method returns, the parsed ExperimentName, 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}/catalogs/{catalog}/experiments/{experiment}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ExperimentName, ExperimentName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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