Dialogflow v3 API - Class ChangelogName (2.3.0)

Version 2.3.0

• 2.20.0 (latest)
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class ChangelogName : IResourceName, IEquatable<ChangelogName>

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

Resource name for the Changelog resource.

Inheritance

Object > ChangelogName

Implements

IResourceName, IEquatable<ChangelogName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

ChangelogName(String, String, String, String)

public ChangelogName(string projectId, string locationId, string agentId, string changelogId)

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

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.
changelogId	String The Changelog 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

ChangelogId

public string ChangelogId { get; }

The Changelog 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
Boolean

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 ChangelogName.ResourceNameType Type { get; }

The ChangelogName.ResourceNameType of the contained resource name.

Property Value
Type	Description
ChangelogName.ResourceNameType

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

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

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.
changelogId	String The Changelog ID. Must not be null or empty.

Returns
Type	Description
String	The string representation of this ChangelogName with pattern projects/{project}/locations/{location}/agents/{agent}/changelogs/{changelog}.

FormatProjectLocationAgentChangelog(String, String, String, String)

public static string FormatProjectLocationAgentChangelog(string projectId, string locationId, string agentId, string changelogId)

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

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.
changelogId	String The Changelog ID. Must not be null or empty.

Returns
Type	Description
String	The string representation of this ChangelogName with pattern projects/{project}/locations/{location}/agents/{agent}/changelogs/{changelog}.

FromProjectLocationAgentChangelog(String, String, String, String)

public static ChangelogName FromProjectLocationAgentChangelog(string projectId, string locationId, string agentId, string changelogId)

Creates a ChangelogName with the pattern projects/{project}/locations/{location}/agents/{agent}/changelogs/{changelog}.

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.
changelogId	String The Changelog ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static ChangelogName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ChangelogName containing an unparsed resource name.

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

Returns
Type	Description
ChangelogName	A new instance of ChangelogName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
Int32

Overrides

Object.GetHashCode()

Parse(String)

public static ChangelogName Parse(string changelogName)

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

Parameter
Name	Description
changelogName	String The resource name in string form. Must not be null.

Returns
Type	Description
ChangelogName	The parsed ChangelogName if successful.

Remarks

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

• projects/{project}/locations/{location}/agents/{agent}/changelogs/{changelog}

Parse(String, Boolean)

public static ChangelogName Parse(string changelogName, bool allowUnparsed)

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

Parameters
Name	Description
changelogName	String The resource name in string form. Must not be null.
allowUnparsed	Boolean 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
ChangelogName	The parsed ChangelogName if successful.

Remarks

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

• projects/{project}/locations/{location}/agents/{agent}/changelogs/{changelog}

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

public static bool TryParse(string changelogName, out ChangelogName result)

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

Parameters
Name	Description
changelogName	String The resource name in string form. Must not be null.
result	ChangelogName When this method returns, the parsed ChangelogName, or null if parsing failed.

Returns
Type	Description
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}/changelogs/{changelog}

TryParse(String, Boolean, out ChangelogName)

public static bool TryParse(string changelogName, bool allowUnparsed, out ChangelogName result)

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

Parameters
Name	Description
changelogName	String The resource name in string form. Must not be null.
allowUnparsed	Boolean 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	ChangelogName When this method returns, the parsed ChangelogName, or null if parsing failed.

Returns
Type	Description
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}/changelogs/{changelog}

Or may be in any format if allowUnparsed is true.

Operators

Equality(ChangelogName, ChangelogName)

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

Parameters
Name	Description
a	ChangelogName
b	ChangelogName

Returns
Type	Description
Boolean

Inequality(ChangelogName, ChangelogName)

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

Parameters
Name	Description
a	ChangelogName
b	ChangelogName

Returns
Type	Description
Boolean