Live Stream v1 API - Class ClipName (1.9.0) 

public sealed class ClipName : IResourceName, IEquatable<ClipName>

Reference documentation and code samples for the Live Stream v1 API class ClipName.

Resource name for the Clip resource.

Inheritance

object > ClipName

Namespace

Google.Cloud.Video.LiveStream.V1

Assembly

Google.Cloud.Video.LiveStream.V1.dll

Constructors

ClipName(string, string, string, string)

public ClipName(string projectId, string locationId, string channelId, string clipId)

Constructs a new instance of a ClipName class from the component parts of pattern projects/{project}/locations/{location}/channels/{channel}/clips/{clip}

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

The Channel ID. Must not be null or empty.
clipId string

The Clip ID. Must not be null or empty.

Properties

ChannelId

public string ChannelId { get; }

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

Property Value
Type Description
string

ClipId

public string ClipId { get; }

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

Property Value
Type Description
string

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

The ClipName.ResourceNameType of the contained resource name.

Property Value
Type Description
ClipNameResourceNameType

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

public static string Format(string projectId, string locationId, string channelId, string clipId)

Formats the IDs into the string representation of this ClipName with pattern projects/{project}/locations/{location}/channels/{channel}/clips/{clip}.

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

The Channel ID. Must not be null or empty.
clipId string

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

The string representation of this ClipName with pattern projects/{project}/locations/{location}/channels/{channel}/clips/{clip}.

FormatProjectLocationChannelClip(string, string, string, string)

public static string FormatProjectLocationChannelClip(string projectId, string locationId, string channelId, string clipId)

Formats the IDs into the string representation of this ClipName with pattern projects/{project}/locations/{location}/channels/{channel}/clips/{clip}.

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

The Channel ID. Must not be null or empty.
clipId string

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

The string representation of this ClipName with pattern projects/{project}/locations/{location}/channels/{channel}/clips/{clip}.

FromProjectLocationChannelClip(string, string, string, string)

public static ClipName FromProjectLocationChannelClip(string projectId, string locationId, string channelId, string clipId)

Creates a ClipName with the pattern projects/{project}/locations/{location}/channels/{channel}/clips/{clip}.

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

The Channel ID. Must not be null or empty.
clipId string

The Clip ID. Must not be null or empty.
Returns
Type Description
ClipName

A new instance of ClipName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ClipName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ClipName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
clipName string

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

The parsed ClipName if successful.
Remarks

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

  • projects/{project}/locations/{location}/channels/{channel}/clips/{clip}

Parse(string, bool)

public static ClipName Parse(string clipName, bool allowUnparsed)

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

Parameters
Name Description
clipName 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
ClipName

The parsed ClipName if successful.
Remarks

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

  • projects/{project}/locations/{location}/channels/{channel}/clips/{clip}
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 ClipName)

public static bool TryParse(string clipName, out ClipName result)

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

Parameters
Name Description
clipName string

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

When this method returns, the parsed ClipName, 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}/channels/{channel}/clips/{clip}

TryParse(string, bool, out ClipName)

public static bool TryParse(string clipName, bool allowUnparsed, out ClipName result)

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

Parameters
Name Description
clipName 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 ClipName

When this method returns, the parsed ClipName, 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}/channels/{channel}/clips/{clip}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ClipName, ClipName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ClipName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ClipName

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

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.