Class GameServerClusterName

public sealed class GameServerClusterName : IResourceName, IEquatable<GameServerClusterName>

Resource name for the GameServerCluster resource.

Inheritance

Object > GameServerClusterName

Namespace

Google.Cloud.Gaming.V1Beta

Assembly

Google.Cloud.Gaming.V1Beta.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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

realmIdString

The Realm ID. Must not be null or empty.

clusterIdString

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

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

RealmId

public string RealmId { get; }

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

Property Value
TypeDescription
String

Type

public GameServerClusterName.ResourceNameType Type { get; }

The GameServerClusterName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
GameServerClusterName.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)

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

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

realmIdString

The Realm ID. Must not be null or empty.

clusterIdString

The Cluster ID. Must not be null or empty.

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

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

realmIdString

The Realm ID. Must not be null or empty.

clusterIdString

The Cluster ID. Must not be null or empty.

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

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

realmIdString

The Realm ID. Must not be null or empty.

clusterIdString

The Cluster ID. Must not be null or empty.

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

The unparsed resource name. Must not be null.

Returns
TypeDescription
GameServerClusterName

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

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

Parameter
NameDescription
gameServerClusterNameString

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

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

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

The string representation of the resource name.

Overrides

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

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

resultGameServerClusterName

When this method returns, the parsed GameServerClusterName, 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}/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
NameDescription
gameServerClusterNameString

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.

resultGameServerClusterName

When this method returns, the parsed GameServerClusterName, 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}/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
NameDescription
aGameServerClusterName
bGameServerClusterName
Returns
TypeDescription
Boolean

Inequality(GameServerClusterName, GameServerClusterName)

public static bool operator !=(GameServerClusterName a, GameServerClusterName b)
Parameters
NameDescription
aGameServerClusterName
bGameServerClusterName
Returns
TypeDescription
Boolean