Live Stream v1 API - Class PoolName (1.3.0)

public sealed class PoolName : IResourceName, IEquatable<PoolName>

Reference documentation and code samples for the Live Stream v1 API class PoolName.

Resource name for the Pool resource.

Inheritance

object > PoolName

Implements

IResourceName, IEquatable PoolName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Video.LiveStream.V1

Assembly

Google.Cloud.Video.LiveStream.V1.dll

Constructors

PoolName(string, string, string)

public PoolName(string projectId, string locationId, string poolId)

Constructs a new instance of a PoolName class from the component parts of pattern projects/{project}/locations/{location}/pools/{pool}

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.
`poolId`	`string` The `Pool` ID. Must not be `null` or empty.

Properties

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`

PoolId

public string PoolId { get; }

The Pool 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 PoolName.ResourceNameType Type { get; }

The PoolName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`PoolNameResourceNameType`

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

Formats the IDs into the string representation of this PoolName with pattern projects/{project}/locations/{location}/pools/{pool}.

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.
`poolId`	`string` The `Pool` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this PoolName with pattern `projects/{project}/locations/{location}/pools/{pool}`.

FormatProjectLocationPool(string, string, string)

public static string FormatProjectLocationPool(string projectId, string locationId, string poolId)

Formats the IDs into the string representation of this PoolName with pattern projects/{project}/locations/{location}/pools/{pool}.

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.
`poolId`	`string` The `Pool` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this PoolName with pattern `projects/{project}/locations/{location}/pools/{pool}`.

FromProjectLocationPool(string, string, string)

public static PoolName FromProjectLocationPool(string projectId, string locationId, string poolId)

Creates a PoolName with the pattern projects/{project}/locations/{location}/pools/{pool} .

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.
`poolId`	`string` The `Pool` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static PoolName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PoolName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/pools/{pool}

Parse(string, bool)

public static PoolName Parse(string poolName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/pools/{pool}

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

public static bool TryParse(string poolName, out PoolName result)

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

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

TryParse(string, bool, out PoolName)

public static bool TryParse(string poolName, bool allowUnparsed, out PoolName result)

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

Parameters
Name	Description
`poolName`	`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`	`PoolName` When this method returns, the parsed PoolName, 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}/pools/{pool}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(PoolName, PoolName)

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

Parameters
Name	Description
`a`	`PoolName`
`b`	`PoolName`

Returns
Type	Description
`bool`

operator !=(PoolName, PoolName)

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

Parameters
Name	Description
`a`	`PoolName`
`b`	`PoolName`

Returns
Type	Description
`bool`