Video Stitcher v1 API - Class VodAdTagDetailName (3.1.0)

public sealed class VodAdTagDetailName : IResourceName, IEquatable<VodAdTagDetailName>

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

Resource name for the VodAdTagDetail resource.

Inheritance

object > VodAdTagDetailName

Namespace

Google.Cloud.Video.Stitcher.V1

Assembly

Google.Cloud.Video.Stitcher.V1.dll

Constructors

VodAdTagDetailName(string, string, string, string)

public VodAdTagDetailName(string projectId, string locationId, string vodSessionId, string vodAdTagDetailId)

Constructs a new instance of a VodAdTagDetailName class from the component parts of pattern projects/{project}/locations/{location}/vodSessions/{vod_session}/vodAdTagDetails/{vod_ad_tag_detail}

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.

vodAdTagDetailIdstring

The VodAdTagDetail 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
bool

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

The VodAdTagDetailName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
VodAdTagDetailNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

VodAdTagDetailId

public string VodAdTagDetailId { get; }

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

Property Value
TypeDescription
string

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

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

Formats the IDs into the string representation of this VodAdTagDetailName with pattern projects/{project}/locations/{location}/vodSessions/{vod_session}/vodAdTagDetails/{vod_ad_tag_detail} .

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.

vodAdTagDetailIdstring

The VodAdTagDetail ID. Must not be null or empty.

Returns
TypeDescription
string

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

FormatProjectLocationVodSessionVodAdTagDetail(string, string, string, string)

public static string FormatProjectLocationVodSessionVodAdTagDetail(string projectId, string locationId, string vodSessionId, string vodAdTagDetailId)

Formats the IDs into the string representation of this VodAdTagDetailName with pattern projects/{project}/locations/{location}/vodSessions/{vod_session}/vodAdTagDetails/{vod_ad_tag_detail} .

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.

vodAdTagDetailIdstring

The VodAdTagDetail ID. Must not be null or empty.

Returns
TypeDescription
string

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

FromProjectLocationVodSessionVodAdTagDetail(string, string, string, string)

public static VodAdTagDetailName FromProjectLocationVodSessionVodAdTagDetail(string projectId, string locationId, string vodSessionId, string vodAdTagDetailId)

Creates a VodAdTagDetailName with the pattern projects/{project}/locations/{location}/vodSessions/{vod_session}/vodAdTagDetails/{vod_ad_tag_detail} .

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.

vodAdTagDetailIdstring

The VodAdTagDetail ID. Must not be null or empty.

Returns
TypeDescription
VodAdTagDetailName

A new instance of VodAdTagDetailName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static VodAdTagDetailName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a VodAdTagDetailName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
VodAdTagDetailName

A new instance of VodAdTagDetailName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static VodAdTagDetailName Parse(string vodAdTagDetailName)

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

Parameter
NameDescription
vodAdTagDetailNamestring

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

Returns
TypeDescription
VodAdTagDetailName

The parsed VodAdTagDetailName if successful.

Remarks

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

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

Parse(string, bool)

public static VodAdTagDetailName Parse(string vodAdTagDetailName, bool allowUnparsed)

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

Parameters
NameDescription
vodAdTagDetailNamestring

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

allowUnparsedbool

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
VodAdTagDetailName

The parsed VodAdTagDetailName if successful.

Remarks

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

  • projects/{project}/locations/{location}/vodSessions/{vod_session}/vodAdTagDetails/{vod_ad_tag_detail}
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 VodAdTagDetailName)

public static bool TryParse(string vodAdTagDetailName, out VodAdTagDetailName result)

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

Parameters
NameDescription
vodAdTagDetailNamestring

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

resultVodAdTagDetailName

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

Returns
TypeDescription
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}/vodAdTagDetails/{vod_ad_tag_detail}

TryParse(string, bool, out VodAdTagDetailName)

public static bool TryParse(string vodAdTagDetailName, bool allowUnparsed, out VodAdTagDetailName result)

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

Parameters
NameDescription
vodAdTagDetailNamestring

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

allowUnparsedbool

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.

resultVodAdTagDetailName

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

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

Operators

operator ==(VodAdTagDetailName, VodAdTagDetailName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aVodAdTagDetailName

The first resource name to compare, or null.

bVodAdTagDetailName

The second resource name to compare, or null.

Returns
TypeDescription
bool

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

operator !=(VodAdTagDetailName, VodAdTagDetailName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aVodAdTagDetailName

The first resource name to compare, or null.

bVodAdTagDetailName

The second resource name to compare, or null.

Returns
TypeDescription
bool

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