Class PageName

public sealed class PageName : IResourceName, IEquatable<PageName>

Resource name for the Page resource.

Inheritance

Object > PageName

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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

agentIdString

The Agent ID. Must not be null or empty.

flowIdString

The Flow ID. Must not be null or empty.

pageIdString

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
TypeDescription
String

FlowId

public string FlowId { get; }

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

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
Boolean

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
String

PageId

public string PageId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

Type

public PageName.ResourceNameType Type { get; }

The PageName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
PageName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

agentIdString

The Agent ID. Must not be null or empty.

flowIdString

The Flow ID. Must not be null or empty.

pageIdString

The Page ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

agentIdString

The Agent ID. Must not be null or empty.

flowIdString

The Flow ID. Must not be null or empty.

pageIdString

The Page ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

agentIdString

The Agent ID. Must not be null or empty.

flowIdString

The Flow ID. Must not be null or empty.

pageIdString

The Page ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
PageName

A new instance of PageName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static PageName Parse(string pageName)

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

Parameter
NameDescription
pageNameString

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

Returns
TypeDescription
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, Boolean)

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
NameDescription
pageNameString

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

allowUnparsedBoolean

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
TypeDescription
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
TypeDescription
String

The string representation of the resource name.

Overrides

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
NameDescription
pageNameString

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

resultPageName

When this method returns, the parsed PageName, or null if parsing failed.

Returns
TypeDescription
Boolean

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, Boolean, 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
NameDescription
pageNameString

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

allowUnparsedBoolean

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.

resultPageName

When this method returns, the parsed PageName, or null if parsing failed.

Returns
TypeDescription
Boolean

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

Equality(PageName, PageName)

public static bool operator ==(PageName a, PageName b)
Parameters
NameDescription
aPageName
bPageName
Returns
TypeDescription
Boolean

Inequality(PageName, PageName)

public static bool operator !=(PageName a, PageName b)
Parameters
NameDescription
aPageName
bPageName
Returns
TypeDescription
Boolean