Live Stream v1 API - Class InputName (1.3.0)

public sealed class InputName : IResourceName, IEquatable<InputName>

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

Resource name for the Input resource.

Inheritance

object > InputName

Implements

IResourceName, IEquatable InputName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Video.LiveStream.V1

Assembly

Google.Cloud.Video.LiveStream.V1.dll

Constructors

InputName(string, string, string)

public InputName(string projectId, string locationId, string inputId)

Constructs a new instance of a InputName class from the component parts of pattern projects/{project}/locations/{location}/inputs/{input}

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

Properties

InputId

public string InputId { get; }

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

The InputName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`InputNameResourceNameType`

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

Formats the IDs into the string representation of this InputName with pattern projects/{project}/locations/{location}/inputs/{input}.

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

Returns
Type	Description
`string`	The string representation of this InputName with pattern `projects/{project}/locations/{location}/inputs/{input}`.

FormatProjectLocationInput(string, string, string)

public static string FormatProjectLocationInput(string projectId, string locationId, string inputId)

Formats the IDs into the string representation of this InputName with pattern projects/{project}/locations/{location}/inputs/{input}.

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

Returns
Type	Description
`string`	The string representation of this InputName with pattern `projects/{project}/locations/{location}/inputs/{input}`.

FromProjectLocationInput(string, string, string)

public static InputName FromProjectLocationInput(string projectId, string locationId, string inputId)

Creates a InputName with the pattern projects/{project}/locations/{location}/inputs/{input} .

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

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

FromUnparsed(UnparsedResourceName)

public static InputName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a InputName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/inputs/{input}

Parse(string, bool)

public static InputName Parse(string inputName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/inputs/{input}

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

public static bool TryParse(string inputName, out InputName result)

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

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

TryParse(string, bool, out InputName)

public static bool TryParse(string inputName, bool allowUnparsed, out InputName result)

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

Parameters
Name	Description
`inputName`	`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`	`InputName` When this method returns, the parsed InputName, 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}/inputs/{input}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(InputName, InputName)

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

Parameters
Name	Description
`a`	`InputName`
`b`	`InputName`

Returns
Type	Description
`bool`

operator !=(InputName, InputName)

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

Parameters
Name	Description
`a`	`InputName`
`b`	`InputName`

Returns
Type	Description
`bool`