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

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

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

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

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

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, 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
Name	Description
`gameServerDeploymentName`	`string` The resource name in string form. Must not be `null`.
`allowUnparsed`	`bool` 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
`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
Name	Description
`gameServerDeploymentName`	`string` The resource name in string form. Must not be `null`.
`allowUnparsed`	`bool` 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
`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
Name	Description
`a`	`GameServerDeploymentName`
`b`	`GameServerDeploymentName`

Returns
Type	Description
`bool`

operator !=(GameServerDeploymentName, GameServerDeploymentName)

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

Parameters
Name	Description
`a`	`GameServerDeploymentName`
`b`	`GameServerDeploymentName`

Returns
Type	Description
`bool`