Video Stitcher v1 API - Class VodStitchDetailName (3.2.0)

public sealed class VodStitchDetailName : IResourceName, IEquatable<VodStitchDetailName>

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

Resource name for the VodStitchDetail resource.

Inheritance

object > VodStitchDetailName

Namespace

Google.Cloud.Video.Stitcher.V1

Assembly

Google.Cloud.Video.Stitcher.V1.dll

Constructors

VodStitchDetailName(string, string, string, string)

public VodStitchDetailName(string projectId, string locationId, string vodSessionId, string vodStitchDetailId)

Constructs a new instance of a VodStitchDetailName class from the component parts of pattern projects/{project}/locations/{location}/vodSessions/{vod_session}/vodStitchDetails/{vod_stitch_detail}

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.

vodStitchDetailId string

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

The VodStitchDetailName.ResourceNameType of the contained resource name.

Property Value
Type Description
VodStitchDetailNameResourceNameType

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

VodStitchDetailId

public string VodStitchDetailId { get; }

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

Property Value
Type Description
string

Methods

Format(string, string, string, string)

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

Formats the IDs into the string representation of this VodStitchDetailName with pattern projects/{project}/locations/{location}/vodSessions/{vod_session}/vodStitchDetails/{vod_stitch_detail} .

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.

vodStitchDetailId string

The VodStitchDetail ID. Must not be null or empty.

Returns
Type Description
string

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

FormatProjectLocationVodSessionVodStitchDetail(string, string, string, string)

public static string FormatProjectLocationVodSessionVodStitchDetail(string projectId, string locationId, string vodSessionId, string vodStitchDetailId)

Formats the IDs into the string representation of this VodStitchDetailName with pattern projects/{project}/locations/{location}/vodSessions/{vod_session}/vodStitchDetails/{vod_stitch_detail} .

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.

vodStitchDetailId string

The VodStitchDetail ID. Must not be null or empty.

Returns
Type Description
string

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

FromProjectLocationVodSessionVodStitchDetail(string, string, string, string)

public static VodStitchDetailName FromProjectLocationVodSessionVodStitchDetail(string projectId, string locationId, string vodSessionId, string vodStitchDetailId)

Creates a VodStitchDetailName with the pattern projects/{project}/locations/{location}/vodSessions/{vod_session}/vodStitchDetails/{vod_stitch_detail} .

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.

vodStitchDetailId string

The VodStitchDetail ID. Must not be null or empty.

Returns
Type Description
VodStitchDetailName

A new instance of VodStitchDetailName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static VodStitchDetailName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a VodStitchDetailName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
VodStitchDetailName

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

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

Parameter
Name Description
vodStitchDetailName string

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

Returns
Type Description
VodStitchDetailName

The parsed VodStitchDetailName if successful.

Remarks

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

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

Parse(string, bool)

public static VodStitchDetailName Parse(string vodStitchDetailName, bool allowUnparsed)

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

Parameters
Name Description
vodStitchDetailName 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
VodStitchDetailName

The parsed VodStitchDetailName if successful.

Remarks

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

  • projects/{project}/locations/{location}/vodSessions/{vod_session}/vodStitchDetails/{vod_stitch_detail}
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 VodStitchDetailName)

public static bool TryParse(string vodStitchDetailName, out VodStitchDetailName result)

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

Parameters
Name Description
vodStitchDetailName string

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

result VodStitchDetailName

When this method returns, the parsed VodStitchDetailName, 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}/vodStitchDetails/{vod_stitch_detail}

TryParse(string, bool, out VodStitchDetailName)

public static bool TryParse(string vodStitchDetailName, bool allowUnparsed, out VodStitchDetailName result)

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

Parameters
Name Description
vodStitchDetailName 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 VodStitchDetailName

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

Operators

operator ==(VodStitchDetailName, VodStitchDetailName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a VodStitchDetailName

The first resource name to compare, or null.

b VodStitchDetailName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a VodStitchDetailName

The first resource name to compare, or null.

b VodStitchDetailName

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.