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

public sealed class ToolsetName : IResourceName, IEquatable<ToolsetName>

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

Resource name for the Toolset resource.

Inheritance

object > ToolsetName

Namespace

Google.Cloud.Ces.V1

Assembly

Google.Cloud.Ces.V1.dll

Constructors

ToolsetName(string, string, string, string)

public ToolsetName(string projectId, string locationId, string appId, string toolsetId)

Constructs a new instance of a ToolsetName class from the component parts of pattern projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}

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

The App ID. Must not be null or empty.
toolsetId string

The Toolset ID. Must not be null or empty.

Properties

AppId

public string AppId { get; }

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

ToolsetId

public string ToolsetId { get; }

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

Property Value
Type Description
string

Type

public ToolsetName.ResourceNameType Type { get; }

The ToolsetName.ResourceNameType of the contained resource name.

Property Value
Type Description
ToolsetNameResourceNameType

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 appId, string toolsetId)

Formats the IDs into the string representation of this ToolsetName with pattern projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}.

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

The App ID. Must not be null or empty.
toolsetId string

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

The string representation of this ToolsetName with pattern projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}.

FormatProjectLocationAppToolset(string, string, string, string)

public static string FormatProjectLocationAppToolset(string projectId, string locationId, string appId, string toolsetId)

Formats the IDs into the string representation of this ToolsetName with pattern projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}.

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

The App ID. Must not be null or empty.
toolsetId string

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

The string representation of this ToolsetName with pattern projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}.

FromProjectLocationAppToolset(string, string, string, string)

public static ToolsetName FromProjectLocationAppToolset(string projectId, string locationId, string appId, string toolsetId)

Creates a ToolsetName with the pattern projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}.

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

The App ID. Must not be null or empty.
toolsetId string

The Toolset ID. Must not be null or empty.
Returns
Type Description
ToolsetName

A new instance of ToolsetName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ToolsetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ToolsetName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
toolsetName string

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

The parsed ToolsetName if successful.
Remarks

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

  • projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}

Parse(string, bool)

public static ToolsetName Parse(string toolsetName, bool allowUnparsed)

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

Parameters
Name Description
toolsetName 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
ToolsetName

The parsed ToolsetName if successful.
Remarks

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

  • projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
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 ToolsetName)

public static bool TryParse(string toolsetName, out ToolsetName result)

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

Parameters
Name Description
toolsetName string

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

When this method returns, the parsed ToolsetName, 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}/apps/{app}/toolsets/{toolset}

TryParse(string, bool, out ToolsetName)

public static bool TryParse(string toolsetName, bool allowUnparsed, out ToolsetName result)

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

Parameters
Name Description
toolsetName 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 ToolsetName

When this method returns, the parsed ToolsetName, 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}/apps/{app}/toolsets/{toolset}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ToolsetName, ToolsetName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ToolsetName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ToolsetName

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

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.