Recommendations AI v1beta1 API - Class PlacementName (2.0.0-beta04)

public sealed class PlacementName : IResourceName, IEquatable<PlacementName>

Reference documentation and code samples for the Recommendations AI v1beta1 API class PlacementName.

Resource name for the Placement resource.

Inheritance

object > PlacementName

Implements

IResourceName, IEquatable PlacementName

Inherited Members

object.GetType()

Namespace

Google.Cloud.RecommendationEngine.V1Beta1

Assembly

Google.Cloud.RecommendationEngine.V1Beta1.dll

Constructors

PlacementName(string, string, string, string, string)

public PlacementName(string projectId, string locationId, string catalogId, string eventStoreId, string placementId)

Constructs a new instance of a PlacementName class from the component parts of pattern projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}/placements/{placement}

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.
`eventStoreId`	`string` The `EventStore` ID. Must not be `null` or empty.
`placementId`	`string` The `Placement` 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`

EventStoreId

public string EventStoreId { get; }

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

PlacementId

public string PlacementId { get; }

The Placement 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 PlacementName.ResourceNameType Type { get; }

The PlacementName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`PlacementNameResourceNameType`

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

public static string Format(string projectId, string locationId, string catalogId, string eventStoreId, string placementId)

Formats the IDs into the string representation of this PlacementName with pattern projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}/placements/{placement} .

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.
`eventStoreId`	`string` The `EventStore` ID. Must not be `null` or empty.
`placementId`	`string` The `Placement` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this PlacementName with pattern `projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}/placements/{placement}` .

FormatProjectLocationCatalogEventStorePlacement(string, string, string, string, string)

public static string FormatProjectLocationCatalogEventStorePlacement(string projectId, string locationId, string catalogId, string eventStoreId, string placementId)

Formats the IDs into the string representation of this PlacementName with pattern projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}/placements/{placement} .

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.
`eventStoreId`	`string` The `EventStore` ID. Must not be `null` or empty.
`placementId`	`string` The `Placement` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this PlacementName with pattern `projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}/placements/{placement}` .

FromProjectLocationCatalogEventStorePlacement(string, string, string, string, string)

public static PlacementName FromProjectLocationCatalogEventStorePlacement(string projectId, string locationId, string catalogId, string eventStoreId, string placementId)

Creates a PlacementName with the pattern projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}/placements/{placement} .

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.
`eventStoreId`	`string` The `EventStore` ID. Must not be `null` or empty.
`placementId`	`string` The `Placement` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static PlacementName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PlacementName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}/placements/{placement}

Parse(string, bool)

public static PlacementName Parse(string placementName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/catalogs/{catalog}/eventStores/{event_store}/placements/{placement}

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

public static bool TryParse(string placementName, out PlacementName result)

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

Parameters
Name	Description
`placementName`	`string` The resource name in string form. Must not be `null`.
`result`	`PlacementName` When this method returns, the parsed PlacementName, 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}/eventStores/{event_store}/placements/{placement}

TryParse(string, bool, out PlacementName)

public static bool TryParse(string placementName, bool allowUnparsed, out PlacementName result)

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

Parameters
Name	Description
`placementName`	`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`	`PlacementName` When this method returns, the parsed PlacementName, 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}/eventStores/{event_store}/placements/{placement}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(PlacementName, PlacementName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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