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

public sealed class GameServerDeploymentRolloutName : IResourceName, IEquatable<GameServerDeploymentRolloutName>

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

Resource name for the GameServerDeploymentRollout resource.

Inheritance

object > GameServerDeploymentRolloutName

Implements

IResourceName, IEquatable GameServerDeploymentRolloutName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Gaming.V1Beta

Assembly

Google.Cloud.Gaming.V1Beta.dll

Constructors

GameServerDeploymentRolloutName(string, string, string)

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

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

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

The GameServerDeploymentRolloutName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`GameServerDeploymentRolloutNameResourceNameType`

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 GameServerDeploymentRolloutName with pattern projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout.

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 GameServerDeploymentRolloutName with pattern `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`.

FormatProjectLocationDeployment(string, string, string)

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

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

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 GameServerDeploymentRolloutName with pattern `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`.

FromProjectLocationDeployment(string, string, string)

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

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

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
`GameServerDeploymentRolloutName`	A new instance of GameServerDeploymentRolloutName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static GameServerDeploymentRolloutName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a GameServerDeploymentRolloutName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

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

Parse(string, bool)

public static GameServerDeploymentRolloutName Parse(string gameServerDeploymentRolloutName, bool allowUnparsed)

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

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

Remarks

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

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

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

public static bool TryParse(string gameServerDeploymentRolloutName, out GameServerDeploymentRolloutName result)

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

Parameters
Name	Description
`gameServerDeploymentRolloutName`	`string` The resource name in string form. Must not be `null`.
`result`	`GameServerDeploymentRolloutName` When this method returns, the parsed GameServerDeploymentRolloutName, 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}/rollout

TryParse(string, bool, out GameServerDeploymentRolloutName)

public static bool TryParse(string gameServerDeploymentRolloutName, bool allowUnparsed, out GameServerDeploymentRolloutName result)

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

Parameters
Name	Description
`gameServerDeploymentRolloutName`	`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`	`GameServerDeploymentRolloutName` When this method returns, the parsed GameServerDeploymentRolloutName, 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}/rollout

Or may be in any format if allowUnparsed is true.

Operators

operator ==(GameServerDeploymentRolloutName, GameServerDeploymentRolloutName)

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

Parameters
Name	Description
`a`	`GameServerDeploymentRolloutName`
`b`	`GameServerDeploymentRolloutName`

Returns
Type	Description
`bool`

operator !=(GameServerDeploymentRolloutName, GameServerDeploymentRolloutName)

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

Parameters
Name	Description
`a`	`GameServerDeploymentRolloutName`
`b`	`GameServerDeploymentRolloutName`

Returns
Type	Description
`bool`