Video Stitcher v1 API - Class LiveConfigName (3.1.0)

public sealed class LiveConfigName : IResourceName, IEquatable<LiveConfigName>

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

Resource name for the LiveConfig resource.

Inheritance

object > LiveConfigName

Namespace

Google.Cloud.Video.Stitcher.V1

Assembly

Google.Cloud.Video.Stitcher.V1.dll

Constructors

LiveConfigName(string, string, string)

public LiveConfigName(string projectId, string locationId, string liveConfigId)

Constructs a new instance of a LiveConfigName class from the component parts of pattern projects/{project}/locations/{location}/liveConfigs/{live_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.

liveConfigId string

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

LiveConfigId

public string LiveConfigId { get; }

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

Property Value
Type Description
string

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

The LiveConfigName.ResourceNameType of the contained resource name.

Property Value
Type Description
LiveConfigNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type Description
UnparsedResourceName

Methods

Format(string, string, string)

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

Formats the IDs into the string representation of this LiveConfigName with pattern projects/{project}/locations/{location}/liveConfigs/{live_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.

liveConfigId string

The LiveConfig ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this LiveConfigName with pattern projects/{project}/locations/{location}/liveConfigs/{live_config}.

FormatProjectLocationLiveConfig(string, string, string)

public static string FormatProjectLocationLiveConfig(string projectId, string locationId, string liveConfigId)

Formats the IDs into the string representation of this LiveConfigName with pattern projects/{project}/locations/{location}/liveConfigs/{live_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.

liveConfigId string

The LiveConfig ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this LiveConfigName with pattern projects/{project}/locations/{location}/liveConfigs/{live_config}.

FromProjectLocationLiveConfig(string, string, string)

public static LiveConfigName FromProjectLocationLiveConfig(string projectId, string locationId, string liveConfigId)

Creates a LiveConfigName with the pattern projects/{project}/locations/{location}/liveConfigs/{live_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.

liveConfigId string

The LiveConfig ID. Must not be null or empty.

Returns
Type Description
LiveConfigName

A new instance of LiveConfigName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static LiveConfigName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a LiveConfigName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
LiveConfigName

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

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

Parameter
Name Description
liveConfigName string

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

Returns
Type Description
LiveConfigName

The parsed LiveConfigName if successful.

Remarks

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

  • projects/{project}/locations/{location}/liveConfigs/{live_config}

Parse(string, bool)

public static LiveConfigName Parse(string liveConfigName, bool allowUnparsed)

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

Parameters
Name Description
liveConfigName 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
LiveConfigName

The parsed LiveConfigName if successful.

Remarks

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

  • projects/{project}/locations/{location}/liveConfigs/{live_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 LiveConfigName)

public static bool TryParse(string liveConfigName, out LiveConfigName result)

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

Parameters
Name Description
liveConfigName string

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

result LiveConfigName

When this method returns, the parsed LiveConfigName, 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}/liveConfigs/{live_config}

TryParse(string, bool, out LiveConfigName)

public static bool TryParse(string liveConfigName, bool allowUnparsed, out LiveConfigName result)

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

Parameters
Name Description
liveConfigName 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 LiveConfigName

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

Operators

operator ==(LiveConfigName, LiveConfigName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a LiveConfigName

The first resource name to compare, or null.

b LiveConfigName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a LiveConfigName

The first resource name to compare, or null.

b LiveConfigName

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.