Live Stream v1 API - Class DvrSessionName (1.9.0) 

public sealed class DvrSessionName : IResourceName, IEquatable<DvrSessionName>

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

Resource name for the DvrSession resource.

Inheritance

object > DvrSessionName

Namespace

Google.Cloud.Video.LiveStream.V1

Assembly

Google.Cloud.Video.LiveStream.V1.dll

Constructors

DvrSessionName(string, string, string, string)

public DvrSessionName(string projectId, string locationId, string channelId, string dvrSessionId)

Constructs a new instance of a DvrSessionName class from the component parts of pattern projects/{project}/locations/{location}/channels/{channel}/dvrSessions/{dvr_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.
channelId string

The Channel ID. Must not be null or empty.
dvrSessionId string

The DvrSession ID. Must not be null or empty.

Properties

ChannelId

public string ChannelId { get; }

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

Property Value
Type Description
string

DvrSessionId

public string DvrSessionId { get; }

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

The DvrSessionName.ResourceNameType of the contained resource name.

Property Value
Type Description
DvrSessionNameResourceNameType

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

public static string Format(string projectId, string locationId, string channelId, string dvrSessionId)

Formats the IDs into the string representation of this DvrSessionName with pattern projects/{project}/locations/{location}/channels/{channel}/dvrSessions/{dvr_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.
channelId string

The Channel ID. Must not be null or empty.
dvrSessionId string

The DvrSession ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this DvrSessionName with pattern projects/{project}/locations/{location}/channels/{channel}/dvrSessions/{dvr_session}.

FormatProjectLocationChannelDvrSession(string, string, string, string)

public static string FormatProjectLocationChannelDvrSession(string projectId, string locationId, string channelId, string dvrSessionId)

Formats the IDs into the string representation of this DvrSessionName with pattern projects/{project}/locations/{location}/channels/{channel}/dvrSessions/{dvr_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.
channelId string

The Channel ID. Must not be null or empty.
dvrSessionId string

The DvrSession ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this DvrSessionName with pattern projects/{project}/locations/{location}/channels/{channel}/dvrSessions/{dvr_session}.

FromProjectLocationChannelDvrSession(string, string, string, string)

public static DvrSessionName FromProjectLocationChannelDvrSession(string projectId, string locationId, string channelId, string dvrSessionId)

Creates a DvrSessionName with the pattern projects/{project}/locations/{location}/channels/{channel}/dvrSessions/{dvr_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.
channelId string

The Channel ID. Must not be null or empty.
dvrSessionId string

The DvrSession ID. Must not be null or empty.
Returns
Type Description
DvrSessionName

A new instance of DvrSessionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static DvrSessionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a DvrSessionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
DvrSessionName

A new instance of DvrSessionName 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 DvrSessionName Parse(string dvrSessionName)

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

Parameter
Name Description
dvrSessionName string

The resource name in string form. Must not be null.
Returns
Type Description
DvrSessionName

The parsed DvrSessionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/channels/{channel}/dvrSessions/{dvr_session}

Parse(string, bool)

public static DvrSessionName Parse(string dvrSessionName, bool allowUnparsed)

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

Parameters
Name Description
dvrSessionName 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
DvrSessionName

The parsed DvrSessionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/channels/{channel}/dvrSessions/{dvr_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 DvrSessionName)

public static bool TryParse(string dvrSessionName, out DvrSessionName result)

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

Parameters
Name Description
dvrSessionName string

The resource name in string form. Must not be null.
result DvrSessionName

When this method returns, the parsed DvrSessionName, 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}/channels/{channel}/dvrSessions/{dvr_session}

TryParse(string, bool, out DvrSessionName)

public static bool TryParse(string dvrSessionName, bool allowUnparsed, out DvrSessionName result)

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

Parameters
Name Description
dvrSessionName 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 DvrSessionName

When this method returns, the parsed DvrSessionName, 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}/channels/{channel}/dvrSessions/{dvr_session}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(DvrSessionName, DvrSessionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a DvrSessionName

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

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 !=(DvrSessionName, DvrSessionName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a DvrSessionName

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

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.