Class PlacementName (2.0.0-beta01)

public sealed class PlacementName : IResourceName, IEquatable<PlacementName>

Resource name for the Placement resource.

Inheritance

Object > PlacementName

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

eventStoreIdString

The EventStore ID. Must not be null or empty.

placementIdString

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

EventStoreId

public string EventStoreId { get; }

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

PlacementId

public string PlacementId { get; }

The Placement 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

Type

public PlacementName.ResourceNameType Type { get; }

The PlacementName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
PlacementName.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, 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
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.

eventStoreIdString

The EventStore ID. Must not be null or empty.

placementIdString

The Placement ID. Must not be null or empty.

Returns
TypeDescription
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
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.

eventStoreIdString

The EventStore ID. Must not be null or empty.

placementIdString

The Placement ID. Must not be null or empty.

Returns
TypeDescription
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
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.

eventStoreIdString

The EventStore ID. Must not be null or empty.

placementIdString

The Placement ID. Must not be null or empty.

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

The unparsed resource name. Must not be null.

Returns
TypeDescription
PlacementName

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

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

Parameter
NameDescription
placementNameString

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

Returns
TypeDescription
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, Boolean)

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

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

The string representation of the resource name.

Overrides

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

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

resultPlacementName

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

TryParse(String, Boolean, 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
NameDescription
placementNameString

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.

resultPlacementName

When this method returns, the parsed PlacementName, 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}/eventStores/{event_store}/placements/{placement}
Or may be in any format if allowUnparsed is true.

Operators

Equality(PlacementName, PlacementName)

public static bool operator ==(PlacementName a, PlacementName b)
Parameters
NameDescription
aPlacementName
bPlacementName
Returns
TypeDescription
Boolean

Inequality(PlacementName, PlacementName)

public static bool operator !=(PlacementName a, PlacementName b)
Parameters
NameDescription
aPlacementName
bPlacementName
Returns
TypeDescription
Boolean