Game Services v1 API - Class GameServerConfigName (2.1.0)

public sealed class GameServerConfigName : IResourceName, IEquatable<GameServerConfigName>

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

Resource name for the GameServerConfig resource.

Inheritance

Object > GameServerConfigName

Implements

IResourceName, IEquatable<GameServerConfigName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Gaming.V1

Assembly

Google.Cloud.Gaming.V1.dll

Constructors

GameServerConfigName(String, String, String, String)

public GameServerConfigName(string projectId, string locationId, string deploymentId, string configId)

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

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.
`configId`	`String` The `Config` ID. Must not be `null` or empty.

Properties

ConfigId

public string ConfigId { get; }

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

Property Value
Type	Description
`String`

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 GameServerConfigName.ResourceNameType Type { get; }

The GameServerConfigName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`GameServerConfigName.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 deploymentId, string configId)

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

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.
`configId`	`String` The `Config` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this GameServerConfigName with pattern `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`.

FormatProjectLocationDeploymentConfig(String, String, String, String)

public static string FormatProjectLocationDeploymentConfig(string projectId, string locationId, string deploymentId, string configId)

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

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.
`configId`	`String` The `Config` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this GameServerConfigName with pattern `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`.

FromProjectLocationDeploymentConfig(String, String, String, String)

public static GameServerConfigName FromProjectLocationDeploymentConfig(string projectId, string locationId, string deploymentId, string configId)

Creates a GameServerConfigName with the pattern projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}.

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.
`configId`	`String` The `Config` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static GameServerConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a GameServerConfigName containing an unparsed resource name.

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

Returns
Type	Description
`GameServerConfigName`	A new instance of GameServerConfigName 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 GameServerConfigName Parse(string gameServerConfigName)

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

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

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

Remarks

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

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}

Parse(String, Boolean)

public static GameServerConfigName Parse(string gameServerConfigName, bool allowUnparsed)

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

Parameters
Name	Description
`gameServerConfigName`	`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
`GameServerConfigName`	The parsed GameServerConfigName if successful.

Remarks

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

projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}

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

public static bool TryParse(string gameServerConfigName, out GameServerConfigName result)

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

Parameters
Name	Description
`gameServerConfigName`	`String` The resource name in string form. Must not be `null`.
`result`	`GameServerConfigName` When this method returns, the parsed GameServerConfigName, 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}/configs/{config}

TryParse(String, Boolean, out GameServerConfigName)

public static bool TryParse(string gameServerConfigName, bool allowUnparsed, out GameServerConfigName result)

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

Parameters
Name	Description
`gameServerConfigName`	`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`	`GameServerConfigName` When this method returns, the parsed GameServerConfigName, 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}/configs/{config}

Or may be in any format if allowUnparsed is true.

Operators

Equality(GameServerConfigName, GameServerConfigName)

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

Parameters
Name	Description
`a`	`GameServerConfigName`
`b`	`GameServerConfigName`

Returns
Type	Description
`Boolean`

Inequality(GameServerConfigName, GameServerConfigName)

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

Parameters
Name	Description
`a`	`GameServerConfigName`
`b`	`GameServerConfigName`

Returns
Type	Description
`Boolean`