Class GameServerConfigName (2.0.0-beta01)

public sealed class GameServerConfigName : IResourceName, IEquatable<GameServerConfigName>

Resource name for the GameServerConfig resource.

Inheritance

Object > GameServerConfigName

Namespace

Google.Cloud.Gaming.V1Beta

Assembly

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

configIdString

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

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

Type

public GameServerConfigName.ResourceNameType Type { get; }

The GameServerConfigName.ResourceNameType of the contained resource name.

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

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

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.

configIdString

The Config ID. Must not be null or empty.

Returns
TypeDescription
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
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.

configIdString

The Config ID. Must not be null or empty.

Returns
TypeDescription
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
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.

configIdString

The Config ID. Must not be null or empty.

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

The unparsed resource name. Must not be null.

Returns
TypeDescription
GameServerConfigName

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

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

Parameter
NameDescription
gameServerConfigNameString

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

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

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

The string representation of the resource name.

Overrides

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

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

resultGameServerConfigName

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

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.

resultGameServerConfigName

When this method returns, the parsed GameServerConfigName, 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}/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
NameDescription
aGameServerConfigName
bGameServerConfigName
Returns
TypeDescription
Boolean

Inequality(GameServerConfigName, GameServerConfigName)

public static bool operator !=(GameServerConfigName a, GameServerConfigName b)
Parameters
NameDescription
aGameServerConfigName
bGameServerConfigName
Returns
TypeDescription
Boolean