Dialogflow v3 API - Class ChangelogName (2.20.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()

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

The ChangelogName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ChangelogNameResourceNameType`

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
`int`

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

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`	`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
`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
`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}/changelogs/{changelog}

TryParse(string, bool, 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`	`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`	`ChangelogName` When this method returns, the parsed ChangelogName, 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}/changelogs/{changelog}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(ChangelogName, ChangelogName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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