Video Stitcher v1 API - Class VodSessionName (3.1.0) 

public sealed class VodSessionName : IResourceName, IEquatable<VodSessionName>

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

Resource name for the VodSession resource.

Inheritance

object > VodSessionName

Namespace

Google.Cloud.Video.Stitcher.V1

Assembly

Google.Cloud.Video.Stitcher.V1.dll

Constructors

VodSessionName(string, string, string)

public VodSessionName(string projectId, string locationId, string vodSessionId)

Constructs a new instance of a VodSessionName class from the component parts of pattern projects/{project}/locations/{location}/vodSessions/{vod_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.
vodSessionId string

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

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

The VodSessionName.ResourceNameType of the contained resource name.

Property Value
Type Description
VodSessionNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

VodSessionId

public string VodSessionId { get; }

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

Property Value
Type Description
string

Methods

Format(string, string, string)

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

Formats the IDs into the string representation of this VodSessionName with pattern projects/{project}/locations/{location}/vodSessions/{vod_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.
vodSessionId string

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

The string representation of this VodSessionName with pattern projects/{project}/locations/{location}/vodSessions/{vod_session}.

FormatProjectLocationVodSession(string, string, string)

public static string FormatProjectLocationVodSession(string projectId, string locationId, string vodSessionId)

Formats the IDs into the string representation of this VodSessionName with pattern projects/{project}/locations/{location}/vodSessions/{vod_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.
vodSessionId string

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

The string representation of this VodSessionName with pattern projects/{project}/locations/{location}/vodSessions/{vod_session}.

FromProjectLocationVodSession(string, string, string)

public static VodSessionName FromProjectLocationVodSession(string projectId, string locationId, string vodSessionId)

Creates a VodSessionName with the pattern projects/{project}/locations/{location}/vodSessions/{vod_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.
vodSessionId string

The VodSession ID. Must not be null or empty.
Returns
Type Description
VodSessionName

A new instance of VodSessionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static VodSessionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a VodSessionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
vodSessionName string

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

The parsed VodSessionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/vodSessions/{vod_session}

Parse(string, bool)

public static VodSessionName Parse(string vodSessionName, bool allowUnparsed)

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

Parameters
Name Description
vodSessionName 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
VodSessionName

The parsed VodSessionName if successful.
Remarks

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

  • projects/{project}/locations/{location}/vodSessions/{vod_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 VodSessionName)

public static bool TryParse(string vodSessionName, out VodSessionName result)

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

Parameters
Name Description
vodSessionName string

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

When this method returns, the parsed VodSessionName, 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}/vodSessions/{vod_session}

TryParse(string, bool, out VodSessionName)

public static bool TryParse(string vodSessionName, bool allowUnparsed, out VodSessionName result)

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

Parameters
Name Description
vodSessionName 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 VodSessionName

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

Operators

operator ==(VodSessionName, VodSessionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a VodSessionName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a VodSessionName

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

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.