Game Services v1 API - Class GameServerDeploymentName (2.2.0)

public sealed class GameServerDeploymentName : IResourceName, IEquatable<GameServerDeploymentName>

Reference documentation and code samples for the Game Services v1 API class GameServerDeploymentName.

Resource name for the GameServerDeployment resource.

Inheritance

object > GameServerDeploymentName

Namespace

Google.Cloud.Gaming.V1

Assembly

Google.Cloud.Gaming.V1.dll

Constructors

GameServerDeploymentName(string, string, string)

public GameServerDeploymentName(string projectId, string locationId, string deploymentId)

Constructs a new instance of a GameServerDeploymentName class from the component parts of pattern projects/{project}/locations/{location}/gameServerDeployments/{deployment}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

deploymentIdstring

The Deployment ID. Must not be null or empty.

Properties

DeploymentId

public string DeploymentId { get; }

The Deployment 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
bool

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

Type

public GameServerDeploymentName.ResourceNameType Type { get; }

The GameServerDeploymentName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
GameServerDeploymentNameResourceNameType

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)

public static string Format(string projectId, string locationId, string deploymentId)

Formats the IDs into the string representation of this GameServerDeploymentName with pattern projects/{project}/locations/{location}/gameServerDeployments/{deployment}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

deploymentIdstring

The Deployment ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this GameServerDeploymentName with pattern projects/{project}/locations/{location}/gameServerDeployments/{deployment}.

FormatProjectLocationDeployment(string, string, string)

public static string FormatProjectLocationDeployment(string projectId, string locationId, string deploymentId)

Formats the IDs into the string representation of this GameServerDeploymentName with pattern projects/{project}/locations/{location}/gameServerDeployments/{deployment}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

deploymentIdstring

The Deployment ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this GameServerDeploymentName with pattern projects/{project}/locations/{location}/gameServerDeployments/{deployment}.

FromProjectLocationDeployment(string, string, string)

public static GameServerDeploymentName FromProjectLocationDeployment(string projectId, string locationId, string deploymentId)

Creates a GameServerDeploymentName with the pattern projects/{project}/locations/{location}/gameServerDeployments/{deployment}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

deploymentIdstring

The Deployment ID. Must not be null or empty.

Returns
TypeDescription
GameServerDeploymentName

A new instance of GameServerDeploymentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static GameServerDeploymentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a GameServerDeploymentName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
GameServerDeploymentName

A new instance of GameServerDeploymentName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static GameServerDeploymentName Parse(string gameServerDeploymentName)

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

Parameter
NameDescription
gameServerDeploymentNamestring

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

Returns
TypeDescription
GameServerDeploymentName

The parsed GameServerDeploymentName if successful.

Remarks

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

  • projects/{project}/locations/{location}/gameServerDeployments/{deployment}

Parse(string, bool)

public static GameServerDeploymentName Parse(string gameServerDeploymentName, bool allowUnparsed)

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

Parameters
NameDescription
gameServerDeploymentNamestring

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

allowUnparsedbool

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
GameServerDeploymentName

The parsed GameServerDeploymentName if successful.

Remarks

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

  • projects/{project}/locations/{location}/gameServerDeployments/{deployment}
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 GameServerDeploymentName)

public static bool TryParse(string gameServerDeploymentName, out GameServerDeploymentName result)

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

Parameters
NameDescription
gameServerDeploymentNamestring

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

resultGameServerDeploymentName

When this method returns, the parsed GameServerDeploymentName, or null if parsing failed.

Returns
TypeDescription
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}/gameServerDeployments/{deployment}

TryParse(string, bool, out GameServerDeploymentName)

public static bool TryParse(string gameServerDeploymentName, bool allowUnparsed, out GameServerDeploymentName result)

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

Parameters
NameDescription
gameServerDeploymentNamestring

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

allowUnparsedbool

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.

resultGameServerDeploymentName

When this method returns, the parsed GameServerDeploymentName, or null if parsing failed.

Returns
TypeDescription
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}/gameServerDeployments/{deployment}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(GameServerDeploymentName, GameServerDeploymentName)

public static bool operator ==(GameServerDeploymentName a, GameServerDeploymentName b)
Parameters
NameDescription
aGameServerDeploymentName
bGameServerDeploymentName
Returns
TypeDescription
bool

operator !=(GameServerDeploymentName, GameServerDeploymentName)

public static bool operator !=(GameServerDeploymentName a, GameServerDeploymentName b)
Parameters
NameDescription
aGameServerDeploymentName
bGameServerDeploymentName
Returns
TypeDescription
bool