Video Stitcher v1 API - Class LiveSessionName (3.3.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

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
bool

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
LiveSessionNameResourceNameType

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

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, bool)

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

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
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}/liveSessions/{live_session}

TryParse(string, bool, 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 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 LiveSessionName

When this method returns, the parsed LiveSessionName, 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}/liveSessions/{live_session}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(LiveSessionName, LiveSessionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a LiveSessionName

The first resource name to compare, or null.
b LiveSessionName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(LiveSessionName, LiveSessionName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a LiveSessionName

The first resource name to compare, or null.
b LiveSessionName

The second resource name to compare, or null.
Returns
Type Description
bool

true if the value of a is different from the value of b; otherwise, false.