Dialogflow v3 API - Class PageName (2.21.0)

public sealed class PageName : IResourceName, IEquatable<PageName>

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

Resource name for the Page resource.

Inheritance

object > PageName

Implements

IResourceName, IEquatable PageName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

PageName(string, string, string, string, string)

public PageName(string projectId, string locationId, string agentId, string flowId, string pageId)

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

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.
`pageId`	`string` The `Page` 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`

PageId

public string PageId { get; }

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

The PageName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`PageNameResourceNameType`

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

public static string Format(string projectId, string locationId, string agentId, string flowId, string pageId)

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

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

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

FormatProjectLocationAgentFlowPage(string, string, string, string, string)

public static string FormatProjectLocationAgentFlowPage(string projectId, string locationId, string agentId, string flowId, string pageId)

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

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

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

FromProjectLocationAgentFlowPage(string, string, string, string, string)

public static PageName FromProjectLocationAgentFlowPage(string projectId, string locationId, string agentId, string flowId, string pageId)

Creates a PageName with the pattern projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/pages/{page}.

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

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

FromUnparsed(UnparsedResourceName)

public static PageName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a PageName containing an unparsed resource name.

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

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

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

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

Returns
Type	Description
`PageName`	The parsed PageName 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}/pages/{page}

Parse(string, bool)

public static PageName Parse(string pageName, bool allowUnparsed)

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

Parameters
Name	Description
`pageName`	`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
`PageName`	The parsed PageName 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}/pages/{page}

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

public static bool TryParse(string pageName, out PageName result)

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

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

TryParse(string, bool, out PageName)

public static bool TryParse(string pageName, bool allowUnparsed, out PageName result)

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

Parameters
Name	Description
`pageName`	`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`	`PageName` When this method returns, the parsed PageName, 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}/pages/{page}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(PageName, PageName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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