Video Stitcher v1 API - Class VodConfigName (3.3.0)

public sealed class VodConfigName : IResourceName, IEquatable<VodConfigName>

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

Resource name for the VodConfig resource.

Inheritance

object > VodConfigName

Namespace

Google.Cloud.Video.Stitcher.V1

Assembly

Google.Cloud.Video.Stitcher.V1.dll

Constructors

VodConfigName(string, string, string)

public VodConfigName(string projectId, string locationId, string vodConfigId)

Constructs a new instance of a VodConfigName class from the component parts of pattern projects/{project}/locations/{location}/vodConfigs/{vod_config}

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.
vodConfigId string

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

The VodConfigName.ResourceNameType of the contained resource name.

Property Value
Type Description
VodConfigNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

VodConfigId

public string VodConfigId { get; }

The VodConfig 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 vodConfigId)

Formats the IDs into the string representation of this VodConfigName with pattern projects/{project}/locations/{location}/vodConfigs/{vod_config}.

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.
vodConfigId string

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

The string representation of this VodConfigName with pattern projects/{project}/locations/{location}/vodConfigs/{vod_config}.

FormatProjectLocationVodConfig(string, string, string)

public static string FormatProjectLocationVodConfig(string projectId, string locationId, string vodConfigId)

Formats the IDs into the string representation of this VodConfigName with pattern projects/{project}/locations/{location}/vodConfigs/{vod_config}.

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.
vodConfigId string

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

The string representation of this VodConfigName with pattern projects/{project}/locations/{location}/vodConfigs/{vod_config}.

FromProjectLocationVodConfig(string, string, string)

public static VodConfigName FromProjectLocationVodConfig(string projectId, string locationId, string vodConfigId)

Creates a VodConfigName with the pattern projects/{project}/locations/{location}/vodConfigs/{vod_config}.

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.
vodConfigId string

The VodConfig ID. Must not be null or empty.
Returns
Type Description
VodConfigName

A new instance of VodConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static VodConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a VodConfigName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
vodConfigName string

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

The parsed VodConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/vodConfigs/{vod_config}

Parse(string, bool)

public static VodConfigName Parse(string vodConfigName, bool allowUnparsed)

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

Parameters
Name Description
vodConfigName 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
VodConfigName

The parsed VodConfigName if successful.
Remarks

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

  • projects/{project}/locations/{location}/vodConfigs/{vod_config}
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 VodConfigName)

public static bool TryParse(string vodConfigName, out VodConfigName result)

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

Parameters
Name Description
vodConfigName string

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

When this method returns, the parsed VodConfigName, 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}/vodConfigs/{vod_config}

TryParse(string, bool, out VodConfigName)

public static bool TryParse(string vodConfigName, bool allowUnparsed, out VodConfigName result)

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

Parameters
Name Description
vodConfigName 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 VodConfigName

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

Operators

operator ==(VodConfigName, VodConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a VodConfigName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a VodConfigName

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

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.