Contact Center AI Insights v1 API - Class ViewName (2.13.0)

Version 2.13.0

• 2.18.0 (latest)
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.1
• 2.1.0
• 2.0.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class ViewName : IResourceName, IEquatable<ViewName>

Reference documentation and code samples for the Contact Center AI Insights v1 API class ViewName.

Resource name for the View resource.

Inheritance

object > ViewName

Implements

IResourceName, IEquatableViewName

Inherited Members

object.GetType()

Namespace

Google.Cloud.ContactCenterInsights.V1

Assembly

Google.Cloud.ContactCenterInsights.V1.dll

Constructors

ViewName(string, string, string)

public ViewName(string projectId, string locationId, string viewId)

Constructs a new instance of a ViewName class from the component parts of pattern projects/{project}/locations/{location}/views/{view}

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.
viewId	string The View 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 ViewName.ResourceNameType Type { get; }

The ViewName.ResourceNameType of the contained resource name.

Property Value
Type	Description
ViewNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type	Description
UnparsedResourceName

ViewId

public string ViewId { get; }

The View 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 viewId)

Formats the IDs into the string representation of this ViewName with pattern projects/{project}/locations/{location}/views/{view}.

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.
viewId	string The View ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this ViewName with pattern projects/{project}/locations/{location}/views/{view}.

FormatProjectLocationView(string, string, string)

public static string FormatProjectLocationView(string projectId, string locationId, string viewId)

Formats the IDs into the string representation of this ViewName with pattern projects/{project}/locations/{location}/views/{view}.

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.
viewId	string The View ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this ViewName with pattern projects/{project}/locations/{location}/views/{view}.

FromProjectLocationView(string, string, string)

public static ViewName FromProjectLocationView(string projectId, string locationId, string viewId)

Creates a ViewName with the pattern projects/{project}/locations/{location}/views/{view} .

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.
viewId	string The View ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static ViewName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ViewName containing an unparsed resource name.

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

Returns
Type	Description
ViewName	A new instance of ViewName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static ViewName Parse(string viewName)

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

Parameter
Name	Description
viewName	string The resource name in string form. Must not be null.

Returns
Type	Description
ViewName	The parsed ViewName if successful.

Remarks

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

• projects/{project}/locations/{location}/views/{view}

Parse(string, bool)

public static ViewName Parse(string viewName, bool allowUnparsed)

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

Parameters
Name	Description
viewName	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
ViewName	The parsed ViewName if successful.

Remarks

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

• projects/{project}/locations/{location}/views/{view}

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

object.ToString()

TryParse(string, out ViewName)

public static bool TryParse(string viewName, out ViewName result)

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

Parameters
Name	Description
viewName	string The resource name in string form. Must not be null.
result	ViewName When this method returns, the parsed ViewName, 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}/views/{view}

TryParse(string, bool, out ViewName)

public static bool TryParse(string viewName, bool allowUnparsed, out ViewName result)

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

Parameters
Name	Description
viewName	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	ViewName When this method returns, the parsed ViewName, 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}/views/{view}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ViewName, ViewName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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