Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class GameServerClusterName (2.0.0)

public sealed class GameServerClusterName : IResourceName, IEquatable<GameServerClusterName>

Resource name for the GameServerCluster resource.

Inheritance

Object > GameServerClusterName

Implements

IResourceName, IEquatable<GameServerClusterName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Gaming.V1

Assembly

Google.Cloud.Gaming.V1.dll

Constructors

GameServerClusterName(String, String, String, String)

public GameServerClusterName(string projectId, string locationId, string realmId, string clusterId)

Constructs a new instance of a GameServerClusterName class from the component parts of pattern projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}

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.
`realmId`	`String` The `Realm` ID. Must not be `null` or empty.
`clusterId`	`String` The `Cluster` ID. Must not be `null` or empty.

Properties

ClusterId

public string ClusterId { get; }

The Cluster 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
`Boolean`

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`

RealmId

public string RealmId { get; }

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

Property Value
Type	Description
`String`

Type

public GameServerClusterName.ResourceNameType Type { get; }

The GameServerClusterName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`GameServerClusterName.ResourceNameType`

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

Formats the IDs into the string representation of this GameServerClusterName with pattern projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}.

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.
`realmId`	`String` The `Realm` ID. Must not be `null` or empty.
`clusterId`	`String` The `Cluster` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this GameServerClusterName with pattern `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.

FormatProjectLocationRealmCluster(String, String, String, String)

public static string FormatProjectLocationRealmCluster(string projectId, string locationId, string realmId, string clusterId)

Formats the IDs into the string representation of this GameServerClusterName with pattern projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}.

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.
`realmId`	`String` The `Realm` ID. Must not be `null` or empty.
`clusterId`	`String` The `Cluster` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this GameServerClusterName with pattern `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.

FromProjectLocationRealmCluster(String, String, String, String)

public static GameServerClusterName FromProjectLocationRealmCluster(string projectId, string locationId, string realmId, string clusterId)

Creates a GameServerClusterName with the pattern projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}.

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.
`realmId`	`String` The `Realm` ID. Must not be `null` or empty.
`clusterId`	`String` The `Cluster` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static GameServerClusterName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a GameServerClusterName containing an unparsed resource name.

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

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

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static GameServerClusterName Parse(string gameServerClusterName)

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

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

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

Remarks

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

projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}

Parse(String, Boolean)

public static GameServerClusterName Parse(string gameServerClusterName, bool allowUnparsed)

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

Parameters
Name	Description
`gameServerClusterName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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
`GameServerClusterName`	The parsed GameServerClusterName if successful.

Remarks

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

projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}

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

public static bool TryParse(string gameServerClusterName, out GameServerClusterName result)

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

Parameters
Name	Description
`gameServerClusterName`	`String` The resource name in string form. Must not be `null`.
`result`	`GameServerClusterName` When this method returns, the parsed GameServerClusterName, or `null` if parsing failed.

Returns
Type	Description
`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}/realms/{realm}/gameServerClusters/{cluster}

TryParse(String, Boolean, out GameServerClusterName)

public static bool TryParse(string gameServerClusterName, bool allowUnparsed, out GameServerClusterName result)

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

Parameters
Name	Description
`gameServerClusterName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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`	`GameServerClusterName` When this method returns, the parsed GameServerClusterName, or `null` if parsing failed.

Returns
Type	Description
`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}/realms/{realm}/gameServerClusters/{cluster}

Or may be in any format if allowUnparsed is true.

Operators

Equality(GameServerClusterName, GameServerClusterName)

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

Parameters
Name	Description
`a`	`GameServerClusterName`
`b`	`GameServerClusterName`

Returns
Type	Description
`Boolean`

Inequality(GameServerClusterName, GameServerClusterName)

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

Parameters
Name	Description
`a`	`GameServerClusterName`
`b`	`GameServerClusterName`

Returns
Type	Description
`Boolean`