Class RecordingName

Resource name for the Recording resource.

Inheritance

object

RecordingName

Implements

IResourceName

IEquatable<RecordingName>

Inherited Members

object.GetType()

Namespace: Google.Apps.Meet.V2

Assembly: Google.Apps.Meet.V2.dll

Syntax

public sealed class RecordingName : IResourceName, IEquatable<RecordingName>

Constructors

RecordingName(string, string)

Constructs a new instance of a RecordingName class from the component parts of pattern conferenceRecords/{conference_record}/recordings/{recording}

Declaration

public RecordingName(string conferenceRecordId, string recordingId)

Parameters

Type	Name	Description
string	conferenceRecordId	The ConferenceRecord ID. Must not be null or empty.
string	recordingId	The Recording ID. Must not be null or empty.

Properties

ConferenceRecordId

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

Declaration

public string ConferenceRecordId { get; }

Property Value

Type	Description
string

IsKnownPattern

Whether this instance contains a resource name with a known pattern.

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
bool

Implements

IResourceName.IsKnownPattern

RecordingId

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

Declaration

public string RecordingId { get; }

Property Value

Type	Description
string

Type

The RecordingName.ResourceNameType of the contained resource name.

Declaration

public RecordingName.ResourceNameType Type { get; }

Property Value

Type	Description
RecordingName.ResourceNameType

UnparsedResource

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

Declaration

public UnparsedResourceName UnparsedResource { get; }

Property Value

Type	Description
UnparsedResourceName

Methods

Format(string, string)

Formats the IDs into the string representation of this RecordingName with pattern conferenceRecords/{conference_record}/recordings/{recording}.

Declaration

public static string Format(string conferenceRecordId, string recordingId)

Parameters

Type	Name	Description
string	conferenceRecordId	The ConferenceRecord ID. Must not be null or empty.
string	recordingId	The Recording ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this RecordingName with pattern conferenceRecords/{conference_record}/recordings/{recording}.

FormatConferenceRecordRecording(string, string)

Formats the IDs into the string representation of this RecordingName with pattern conferenceRecords/{conference_record}/recordings/{recording}.

Declaration

public static string FormatConferenceRecordRecording(string conferenceRecordId, string recordingId)

Parameters

Type	Name	Description
string	conferenceRecordId	The ConferenceRecord ID. Must not be null or empty.
string	recordingId	The Recording ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this RecordingName with pattern conferenceRecords/{conference_record}/recordings/{recording}.

FromConferenceRecordRecording(string, string)

Creates a RecordingName with the pattern conferenceRecords/{conference_record}/recordings/{recording}.

Declaration

public static RecordingName FromConferenceRecordRecording(string conferenceRecordId, string recordingId)

Parameters

Type	Name	Description
string	conferenceRecordId	The ConferenceRecord ID. Must not be null or empty.
string	recordingId	The Recording ID. Must not be null or empty.

Returns

Type	Description
RecordingName	A new instance of RecordingName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a RecordingName containing an unparsed resource name.

Declaration

public static RecordingName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

Type	Name	Description
UnparsedResourceName	unparsedResourceName	The unparsed resource name. Must not be null.

Returns

Type	Description
RecordingName	A new instance of RecordingName containing the provided unparsedResourceName.

GetHashCode()

Returns a hash code for this resource name.

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

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

Declaration

public static RecordingName Parse(string recordingName)

Parameters

Type	Name	Description
string	recordingName	The resource name in string form. Must not be null.

Returns

Type	Description
RecordingName	The parsed RecordingName if successful.

Remarks

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

• conferenceRecords/{conference_record}/recordings/{recording}

Parse(string, bool)

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

Declaration

public static RecordingName Parse(string recordingName, bool allowUnparsed)

Parameters

Type	Name	Description
string	recordingName	The resource name in string form. Must not be null.
bool	allowUnparsed	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
RecordingName	The parsed RecordingName if successful.

Remarks

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

• conferenceRecords/{conference_record}/recordings/{recording}

Or may be in any format if allowUnparsed is true.

ToString()

The string representation of the resource name.

Declaration

public override string ToString()

Returns

Type	Description
string	The string representation of the resource name.

Overrides

object.ToString()

Implements

IResourceName.ToString()

TryParse(string, out RecordingName)

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

Declaration

public static bool TryParse(string recordingName, out RecordingName result)

Parameters

Type	Name	Description
string	recordingName	The resource name in string form. Must not be null.
RecordingName	result	When this method returns, the parsed RecordingName, 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:

• conferenceRecords/{conference_record}/recordings/{recording}

TryParse(string, bool, out RecordingName)

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

Declaration

public static bool TryParse(string recordingName, bool allowUnparsed, out RecordingName result)

Parameters

Type	Name	Description
string	recordingName	The resource name in string form. Must not be null.
bool	allowUnparsed	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.
RecordingName	result	When this method returns, the parsed RecordingName, 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:

• conferenceRecords/{conference_record}/recordings/{recording}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(RecordingName, RecordingName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

Type	Name	Description
RecordingName	a	The first resource name to compare, or null.
RecordingName	b	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 !=(RecordingName, RecordingName)

Determines whether two specified resource names have different values.

Declaration

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

Parameters

Type	Name	Description
RecordingName	a	The first resource name to compare, or null.
RecordingName	b	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.