Google Cloud for Games v1beta API - Class GameServerDeploymentName (2.0.0-beta02)

Version 2.0.0-beta02

• 2.0.0-beta03 (latest)
• 2.0.0-beta02
• 1.0.0-beta09

public sealed class GameServerDeploymentName : IResourceName, IEquatable<GameServerDeploymentName>

Reference documentation and code samples for the Google Cloud for Games v1beta API class GameServerDeploymentName.

Resource name for the GameServerDeployment resource.

Inheritance

Object > GameServerDeploymentName

Implements

IResourceName, IEquatable<GameServerDeploymentName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Gaming.V1Beta

Assembly

Google.Cloud.Gaming.V1Beta.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
Name	Description
projectId	String The Project ID. Must not be null or empty.
locationId	String The Location ID. Must not be null or empty.
deploymentId	String 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
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

Type

public GameServerDeploymentName.ResourceNameType Type { get; }

The GameServerDeploymentName.ResourceNameType of the contained resource name.

Property Value
Type	Description
GameServerDeploymentName.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)

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
Name	Description
projectId	String The Project ID. Must not be null or empty.
locationId	String The Location ID. Must not be null or empty.
deploymentId	String The Deployment ID. Must not be null or empty.

Returns
Type	Description
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
Name	Description
projectId	String The Project ID. Must not be null or empty.
locationId	String The Location ID. Must not be null or empty.
deploymentId	String The Deployment ID. Must not be null or empty.

Returns
Type	Description
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
Name	Description
projectId	String The Project ID. Must not be null or empty.
locationId	String The Location ID. Must not be null or empty.
deploymentId	String The Deployment ID. Must not be null or empty.

Returns
Type	Description
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
Name	Description
unparsedResourceName	UnparsedResourceName The unparsed resource name. Must not be null.

Returns
Type	Description
GameServerDeploymentName	A new instance of GameServerDeploymentName 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 GameServerDeploymentName Parse(string gameServerDeploymentName)

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

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

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

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
Name	Description
gameServerDeploymentName	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
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
Type	Description
String	The string representation of the resource name.

Overrides

Object.ToString()

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
Name	Description
gameServerDeploymentName	String The resource name in string form. Must not be null.
result	GameServerDeploymentName When this method returns, the parsed GameServerDeploymentName, 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}/gameServerDeployments/{deployment}

TryParse(String, Boolean, 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
Name	Description
gameServerDeploymentName	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	GameServerDeploymentName When this method returns, the parsed GameServerDeploymentName, 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}/gameServerDeployments/{deployment}

Or may be in any format if allowUnparsed is true.

Operators

Equality(GameServerDeploymentName, GameServerDeploymentName)

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

Parameters
Name	Description
a	GameServerDeploymentName
b	GameServerDeploymentName

Returns
Type	Description
Boolean

Inequality(GameServerDeploymentName, GameServerDeploymentName)

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

Parameters
Name	Description
a	GameServerDeploymentName
b	GameServerDeploymentName

Returns
Type	Description
Boolean