Dialogflow v3 API - Class AgentGenerativeSettingsName (2.24.0) 

public sealed class AgentGenerativeSettingsName : IResourceName, IEquatable<AgentGenerativeSettingsName>

Reference documentation and code samples for the Dialogflow v3 API class AgentGenerativeSettingsName.

Resource name for the AgentGenerativeSettings resource.

Inheritance

object > AgentGenerativeSettingsName

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

AgentGenerativeSettingsName(string, string, string)

public AgentGenerativeSettingsName(string projectId, string locationId, string agentId)

Constructs a new instance of a AgentGenerativeSettingsName class from the component parts of pattern projects/{project}/locations/{location}/agents/{agent}/generativeSettings

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

The Agent ID. Must not be null or empty.

Properties

AgentId

public string AgentId { get; }

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

Type

public AgentGenerativeSettingsName.ResourceNameType Type { get; }

The AgentGenerativeSettingsName.ResourceNameType of the contained resource name.

Property Value
Type Description
AgentGenerativeSettingsNameResourceNameType

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

Formats the IDs into the string representation of this AgentGenerativeSettingsName with pattern projects/{project}/locations/{location}/agents/{agent}/generativeSettings.

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

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

The string representation of this AgentGenerativeSettingsName with pattern projects/{project}/locations/{location}/agents/{agent}/generativeSettings.

FormatProjectLocationAgent(string, string, string)

public static string FormatProjectLocationAgent(string projectId, string locationId, string agentId)

Formats the IDs into the string representation of this AgentGenerativeSettingsName with pattern projects/{project}/locations/{location}/agents/{agent}/generativeSettings.

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

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

The string representation of this AgentGenerativeSettingsName with pattern projects/{project}/locations/{location}/agents/{agent}/generativeSettings.

FromProjectLocationAgent(string, string, string)

public static AgentGenerativeSettingsName FromProjectLocationAgent(string projectId, string locationId, string agentId)

Creates a AgentGenerativeSettingsName with the pattern projects/{project}/locations/{location}/agents/{agent}/generativeSettings.

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

The Agent ID. Must not be null or empty.
Returns
Type Description
AgentGenerativeSettingsName

A new instance of AgentGenerativeSettingsName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static AgentGenerativeSettingsName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a AgentGenerativeSettingsName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
agentGenerativeSettingsName string

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

The parsed AgentGenerativeSettingsName if successful.
Remarks

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

  • projects/{project}/locations/{location}/agents/{agent}/generativeSettings

Parse(string, bool)

public static AgentGenerativeSettingsName Parse(string agentGenerativeSettingsName, bool allowUnparsed)

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

Parameters
Name Description
agentGenerativeSettingsName 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
AgentGenerativeSettingsName

The parsed AgentGenerativeSettingsName if successful.
Remarks

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

  • projects/{project}/locations/{location}/agents/{agent}/generativeSettings
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 AgentGenerativeSettingsName)

public static bool TryParse(string agentGenerativeSettingsName, out AgentGenerativeSettingsName result)

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

Parameters
Name Description
agentGenerativeSettingsName string

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

When this method returns, the parsed AgentGenerativeSettingsName, 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}/agents/{agent}/generativeSettings

TryParse(string, bool, out AgentGenerativeSettingsName)

public static bool TryParse(string agentGenerativeSettingsName, bool allowUnparsed, out AgentGenerativeSettingsName result)

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

Parameters
Name Description
agentGenerativeSettingsName 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 AgentGenerativeSettingsName

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

Operators

operator ==(AgentGenerativeSettingsName, AgentGenerativeSettingsName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a AgentGenerativeSettingsName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a AgentGenerativeSettingsName

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

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.