Live Stream v1 API - Class EventName (1.9.0) 

public sealed class EventName : IResourceName, IEquatable<EventName>

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

Resource name for the Event resource.

Inheritance

object > EventName

Namespace

Google.Cloud.Video.LiveStream.V1

Assembly

Google.Cloud.Video.LiveStream.V1.dll

Constructors

EventName(string, string, string, string)

public EventName(string projectId, string locationId, string channelId, string eventId)

Constructs a new instance of a EventName class from the component parts of pattern projects/{project}/locations/{location}/channels/{channel}/events/{event}

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

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

EventId

public string EventId { get; }

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

The EventName.ResourceNameType of the contained resource name.

Property Value
Type Description
EventNameResourceNameType

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 eventId)

Formats the IDs into the string representation of this EventName with pattern projects/{project}/locations/{location}/channels/{channel}/events/{event}.

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

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

The string representation of this EventName with pattern projects/{project}/locations/{location}/channels/{channel}/events/{event}.

FormatProjectLocationChannelEvent(string, string, string, string)

public static string FormatProjectLocationChannelEvent(string projectId, string locationId, string channelId, string eventId)

Formats the IDs into the string representation of this EventName with pattern projects/{project}/locations/{location}/channels/{channel}/events/{event}.

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

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

The string representation of this EventName with pattern projects/{project}/locations/{location}/channels/{channel}/events/{event}.

FromProjectLocationChannelEvent(string, string, string, string)

public static EventName FromProjectLocationChannelEvent(string projectId, string locationId, string channelId, string eventId)

Creates a EventName with the pattern projects/{project}/locations/{location}/channels/{channel}/events/{event}.

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

The Event ID. Must not be null or empty.
Returns
Type Description
EventName

A new instance of EventName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static EventName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a EventName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
eventName string

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

The parsed EventName if successful.
Remarks

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

  • projects/{project}/locations/{location}/channels/{channel}/events/{event}

Parse(string, bool)

public static EventName Parse(string eventName, bool allowUnparsed)

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

Parameters
Name Description
eventName 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
EventName

The parsed EventName if successful.
Remarks

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

  • projects/{project}/locations/{location}/channels/{channel}/events/{event}
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 EventName)

public static bool TryParse(string eventName, out EventName result)

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

Parameters
Name Description
eventName string

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

When this method returns, the parsed EventName, 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}/events/{event}

TryParse(string, bool, out EventName)

public static bool TryParse(string eventName, bool allowUnparsed, out EventName result)

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

Parameters
Name Description
eventName 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 EventName

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

Operators

operator ==(EventName, EventName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a EventName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a EventName

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

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.