Video Stitcher v1 API - Class LiveSessionName (1.1.0)

public sealed class LiveSessionName : IResourceName, IEquatable<LiveSessionName>

Reference documentation and code samples for the Video Stitcher v1 API class LiveSessionName.

Resource name for the LiveSession resource.

Inheritance

Object > LiveSessionName

Implements

IResourceName, IEquatable<LiveSessionName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Video.Stitcher.V1

Assembly

Google.Cloud.Video.Stitcher.V1.dll

Constructors

LiveSessionName(String, String, String)

public LiveSessionName(string projectId, string locationId, string liveSessionId)

Constructs a new instance of a LiveSessionName class from the component parts of pattern projects/{project}/locations/{location}/liveSessions/{live_session}

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.
`liveSessionId`	`String` The `LiveSession` 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
`Boolean`

LiveSessionId

public string LiveSessionId { get; }

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

Property Value
Type	Description
`String`

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

The LiveSessionName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`LiveSessionName.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)

public static string Format(string projectId, string locationId, string liveSessionId)

Formats the IDs into the string representation of this LiveSessionName with pattern projects/{project}/locations/{location}/liveSessions/{live_session}.

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

Returns
Type	Description
`String`	The string representation of this LiveSessionName with pattern `projects/{project}/locations/{location}/liveSessions/{live_session}`.

FormatProjectLocationLiveSession(String, String, String)

public static string FormatProjectLocationLiveSession(string projectId, string locationId, string liveSessionId)

Formats the IDs into the string representation of this LiveSessionName with pattern projects/{project}/locations/{location}/liveSessions/{live_session}.

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

Returns
Type	Description
`String`	The string representation of this LiveSessionName with pattern `projects/{project}/locations/{location}/liveSessions/{live_session}`.

FromProjectLocationLiveSession(String, String, String)

public static LiveSessionName FromProjectLocationLiveSession(string projectId, string locationId, string liveSessionId)

Creates a LiveSessionName with the pattern projects/{project}/locations/{location}/liveSessions/{live_session}.

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

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

FromUnparsed(UnparsedResourceName)

public static LiveSessionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a LiveSessionName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/liveSessions/{live_session}

Parse(String, Boolean)

public static LiveSessionName Parse(string liveSessionName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/liveSessions/{live_session}

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

public static bool TryParse(string liveSessionName, out LiveSessionName result)

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

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

TryParse(String, Boolean, out LiveSessionName)

public static bool TryParse(string liveSessionName, bool allowUnparsed, out LiveSessionName result)

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

Parameters
Name	Description
`liveSessionName`	`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`	`LiveSessionName` When this method returns, the parsed LiveSessionName, 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}/liveSessions/{live_session}

Or may be in any format if allowUnparsed is true.

Operators

Equality(LiveSessionName, LiveSessionName)

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

Parameters
Name	Description
`a`	`LiveSessionName`
`b`	`LiveSessionName`

Returns
Type	Description
`Boolean`

Inequality(LiveSessionName, LiveSessionName)

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

Parameters
Name	Description
`a`	`LiveSessionName`
`b`	`LiveSessionName`

Returns
Type	Description
`Boolean`