Video Stitcher v1 API - Class VodSessionName (1.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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

vodSessionIdString

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

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

Type

public VodSessionName.ResourceNameType Type { get; }

The VodSessionName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
VodSessionName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

VodSessionId

public string VodSessionId { get; }

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

Property Value
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

vodSessionIdString

The VodSession ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

vodSessionIdString

The VodSession ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

vodSessionIdString

The VodSession ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
VodSessionName

A new instance of VodSessionName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static VodSessionName Parse(string vodSessionName)

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

Parameter
NameDescription
vodSessionNameString

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

Returns
TypeDescription
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, Boolean)

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

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

allowUnparsedBoolean

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
TypeDescription
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
TypeDescription
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
NameDescription
vodSessionNameString

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

resultVodSessionName

When this method returns, the parsed VodSessionName, or null if parsing failed.

Returns
TypeDescription
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}/vodSessions/{vod_session}

TryParse(String, Boolean, 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
NameDescription
vodSessionNameString

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

allowUnparsedBoolean

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.

resultVodSessionName

When this method returns, the parsed VodSessionName, or null if parsing failed.

Returns
TypeDescription
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}/vodSessions/{vod_session}
Or may be in any format if allowUnparsed is true.

Operators

Equality(VodSessionName, VodSessionName)

public static bool operator ==(VodSessionName a, VodSessionName b)
Parameters
NameDescription
aVodSessionName
bVodSessionName
Returns
TypeDescription
Boolean

Inequality(VodSessionName, VodSessionName)

public static bool operator !=(VodSessionName a, VodSessionName b)
Parameters
NameDescription
aVodSessionName
bVodSessionName
Returns
TypeDescription
Boolean