Contact Center AI Insights v1 API - Class SettingsName (2.8.0)

Version 2.8.0

• 2.17.0 (latest)
• 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 SettingsName : IResourceName, IEquatable<SettingsName>

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

Resource name for the Settings resource.

Inheritance

object > SettingsName

Implements

IResourceName, IEquatableSettingsName

Inherited Members

object.GetType()

Namespace

Google.Cloud.ContactCenterInsights.V1

Assembly

Google.Cloud.ContactCenterInsights.V1.dll

Constructors

SettingsName(string, string)

public SettingsName(string projectId, string locationId)

Constructs a new instance of a SettingsName class from the component parts of pattern projects/{project}/locations/{location}/settings

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.

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

The SettingsName.ResourceNameType of the contained resource name.

Property Value
Type	Description
SettingsNameResourceNameType

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)

public static string Format(string projectId, string locationId)

Formats the IDs into the string representation of this SettingsName with pattern projects/{project}/locations/{location}/settings.

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.

Returns
Type	Description
string	The string representation of this SettingsName with pattern projects/{project}/locations/{location}/settings.

FormatProjectLocation(string, string)

public static string FormatProjectLocation(string projectId, string locationId)

Formats the IDs into the string representation of this SettingsName with pattern projects/{project}/locations/{location}/settings.

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.

Returns
Type	Description
string	The string representation of this SettingsName with pattern projects/{project}/locations/{location}/settings.

FromProjectLocation(string, string)

public static SettingsName FromProjectLocation(string projectId, string locationId)

Creates a SettingsName with the pattern projects/{project}/locations/{location}/settings .

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.

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

FromUnparsed(UnparsedResourceName)

public static SettingsName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SettingsName containing an unparsed resource name.

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

Returns
Type	Description
SettingsName	A new instance of SettingsName 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 SettingsName Parse(string settingsName)

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

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

Returns
Type	Description
SettingsName	The parsed SettingsName if successful.

Remarks

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

• projects/{project}/locations/{location}/settings

Parse(string, bool)

public static SettingsName Parse(string settingsName, bool allowUnparsed)

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

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

Remarks

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

• projects/{project}/locations/{location}/settings

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

public static bool TryParse(string settingsName, out SettingsName result)

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

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

TryParse(string, bool, out SettingsName)

public static bool TryParse(string settingsName, bool allowUnparsed, out SettingsName result)

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

Parameters
Name	Description
settingsName	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	SettingsName When this method returns, the parsed SettingsName, 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}/settings

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SettingsName, SettingsName)

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

Parameters
Name	Description
a	SettingsName
b	SettingsName

Returns
Type	Description
bool

operator !=(SettingsName, SettingsName)

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

Parameters
Name	Description
a	SettingsName
b	SettingsName

Returns
Type	Description
bool