Dialogflow v3 API - Class FlowValidationResultName (2.9.0)

public sealed class FlowValidationResultName : IResourceName, IEquatable<FlowValidationResultName>

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

Resource name for the FlowValidationResult resource.

Inheritance

object > FlowValidationResultName

Implements

IResourceName, IEquatable FlowValidationResultName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

FlowValidationResultName(string, string, string, string)

public FlowValidationResultName(string projectId, string locationId, string agentId, string flowId)

Constructs a new instance of a FlowValidationResultName class from the component parts of pattern projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/validationResult

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.
`flowId`	`string` The `Flow` 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`

FlowId

public string FlowId { get; }

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

The FlowValidationResultName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`FlowValidationResultNameResourceNameType`

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

Formats the IDs into the string representation of this FlowValidationResultName with pattern projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/validationResult.

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

Returns
Type	Description
`string`	The string representation of this FlowValidationResultName with pattern `projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/validationResult`.

FormatProjectLocationAgentFlow(string, string, string, string)

public static string FormatProjectLocationAgentFlow(string projectId, string locationId, string agentId, string flowId)

Formats the IDs into the string representation of this FlowValidationResultName with pattern projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/validationResult.

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

Returns
Type	Description
`string`	The string representation of this FlowValidationResultName with pattern `projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/validationResult`.

FromProjectLocationAgentFlow(string, string, string, string)

public static FlowValidationResultName FromProjectLocationAgentFlow(string projectId, string locationId, string agentId, string flowId)

Creates a FlowValidationResultName with the pattern projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/validationResult.

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

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

FromUnparsed(UnparsedResourceName)

public static FlowValidationResultName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a FlowValidationResultName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/validationResult

Parse(string, bool)

public static FlowValidationResultName Parse(string flowValidationResultName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/validationResult

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

public static bool TryParse(string flowValidationResultName, out FlowValidationResultName result)

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

Parameters
Name	Description
`flowValidationResultName`	`string` The resource name in string form. Must not be `null`.
`result`	`FlowValidationResultName` When this method returns, the parsed FlowValidationResultName, 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}/flows/{flow}/validationResult

TryParse(string, bool, out FlowValidationResultName)

public static bool TryParse(string flowValidationResultName, bool allowUnparsed, out FlowValidationResultName result)

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

Parameters
Name	Description
`flowValidationResultName`	`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`	`FlowValidationResultName` When this method returns, the parsed FlowValidationResultName, 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}/flows/{flow}/validationResult

Or may be in any format if allowUnparsed is true.

Operators

operator ==(FlowValidationResultName, FlowValidationResultName)

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

Parameters
Name	Description
`a`	`FlowValidationResultName`
`b`	`FlowValidationResultName`

Returns
Type	Description
`bool`

operator !=(FlowValidationResultName, FlowValidationResultName)

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

Parameters
Name	Description
`a`	`FlowValidationResultName`
`b`	`FlowValidationResultName`

Returns
Type	Description
`bool`