Gemini Enterprise for Customer Experience v1 API - Class OmnichannelName (1.0.0-beta01) 

public sealed class OmnichannelName : IResourceName, IEquatable<OmnichannelName>

Reference documentation and code samples for the Gemini Enterprise for Customer Experience v1 API class OmnichannelName.

Resource name for the Omnichannel resource.

Inheritance

object > OmnichannelName

Namespace

Google.Cloud.Ces.V1

Assembly

Google.Cloud.Ces.V1.dll

Constructors

OmnichannelName(string, string, string)

public OmnichannelName(string projectId, string locationId, string omnichannelId)

Constructs a new instance of a OmnichannelName class from the component parts of pattern projects/{project}/locations/{location}/omnichannels/{omnichannel}

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

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

OmnichannelId

public string OmnichannelId { get; }

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

The OmnichannelName.ResourceNameType of the contained resource name.

Property Value
Type Description
OmnichannelNameResourceNameType

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)

public static string Format(string projectId, string locationId, string omnichannelId)

Formats the IDs into the string representation of this OmnichannelName with pattern projects/{project}/locations/{location}/omnichannels/{omnichannel}.

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

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

The string representation of this OmnichannelName with pattern projects/{project}/locations/{location}/omnichannels/{omnichannel}.

FormatProjectLocationOmnichannel(string, string, string)

public static string FormatProjectLocationOmnichannel(string projectId, string locationId, string omnichannelId)

Formats the IDs into the string representation of this OmnichannelName with pattern projects/{project}/locations/{location}/omnichannels/{omnichannel}.

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

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

The string representation of this OmnichannelName with pattern projects/{project}/locations/{location}/omnichannels/{omnichannel}.

FromProjectLocationOmnichannel(string, string, string)

public static OmnichannelName FromProjectLocationOmnichannel(string projectId, string locationId, string omnichannelId)

Creates a OmnichannelName with the pattern projects/{project}/locations/{location}/omnichannels/{omnichannel}.

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

The Omnichannel ID. Must not be null or empty.
Returns
Type Description
OmnichannelName

A new instance of OmnichannelName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static OmnichannelName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a OmnichannelName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
omnichannelName string

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

The parsed OmnichannelName if successful.
Remarks

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

  • projects/{project}/locations/{location}/omnichannels/{omnichannel}

Parse(string, bool)

public static OmnichannelName Parse(string omnichannelName, bool allowUnparsed)

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

Parameters
Name Description
omnichannelName 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
OmnichannelName

The parsed OmnichannelName if successful.
Remarks

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

  • projects/{project}/locations/{location}/omnichannels/{omnichannel}
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 OmnichannelName)

public static bool TryParse(string omnichannelName, out OmnichannelName result)

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

Parameters
Name Description
omnichannelName string

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

When this method returns, the parsed OmnichannelName, 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}/omnichannels/{omnichannel}

TryParse(string, bool, out OmnichannelName)

public static bool TryParse(string omnichannelName, bool allowUnparsed, out OmnichannelName result)

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

Parameters
Name Description
omnichannelName 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 OmnichannelName

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

Operators

operator ==(OmnichannelName, OmnichannelName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a OmnichannelName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a OmnichannelName

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

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.