Dialogflow v3 API - Class GeneratorName (2.17.0)

public sealed class GeneratorName : IResourceName, IEquatable<GeneratorName>

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

Resource name for the Generator resource.

Inheritance

object > GeneratorName

Implements

IResourceName, IEquatable GeneratorName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

GeneratorName(string, string, string, string)

public GeneratorName(string projectId, string locationId, string agentId, string generatorId)

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

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.
`generatorId`	`string` The `Generator` 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`

GeneratorId

public string GeneratorId { get; }

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

The GeneratorName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`GeneratorNameResourceNameType`

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 agentId, string generatorId)

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

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.
`generatorId`	`string` The `Generator` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this GeneratorName with pattern `projects/{project}/locations/{location}/agents/{agent}/generators/{generator}`.

FormatProjectLocationAgentGenerator(string, string, string, string)

public static string FormatProjectLocationAgentGenerator(string projectId, string locationId, string agentId, string generatorId)

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

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.
`generatorId`	`string` The `Generator` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this GeneratorName with pattern `projects/{project}/locations/{location}/agents/{agent}/generators/{generator}`.

FromProjectLocationAgentGenerator(string, string, string, string)

public static GeneratorName FromProjectLocationAgentGenerator(string projectId, string locationId, string agentId, string generatorId)

Creates a GeneratorName with the pattern projects/{project}/locations/{location}/agents/{agent}/generators/{generator}.

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.
`generatorId`	`string` The `Generator` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static GeneratorName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a GeneratorName containing an unparsed resource name.

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

Returns
Type	Description
`GeneratorName`	A new instance of GeneratorName 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 GeneratorName Parse(string generatorName)

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

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

Returns
Type	Description
`GeneratorName`	The parsed GeneratorName if successful.

Remarks

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

projects/{project}/locations/{location}/agents/{agent}/generators/{generator}

Parse(string, bool)

public static GeneratorName Parse(string generatorName, bool allowUnparsed)

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

Parameters
Name	Description
`generatorName`	`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
`GeneratorName`	The parsed GeneratorName if successful.

Remarks

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

projects/{project}/locations/{location}/agents/{agent}/generators/{generator}

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

public static bool TryParse(string generatorName, out GeneratorName result)

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

Parameters
Name	Description
`generatorName`	`string` The resource name in string form. Must not be `null`.
`result`	`GeneratorName` When this method returns, the parsed GeneratorName, 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}/generators/{generator}

TryParse(string, bool, out GeneratorName)

public static bool TryParse(string generatorName, bool allowUnparsed, out GeneratorName result)

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

Parameters
Name	Description
`generatorName`	`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`	`GeneratorName` When this method returns, the parsed GeneratorName, 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}/generators/{generator}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(GeneratorName, GeneratorName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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