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

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
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.

changelogIdString

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

ChangelogId

public string ChangelogId { get; }

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

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

The ChangelogName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
ChangelogName.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)

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
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.

changelogIdString

The Changelog ID. Must not be null or empty.

Returns
TypeDescription
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
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.

changelogIdString

The Changelog ID. Must not be null or empty.

Returns
TypeDescription
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
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.

changelogIdString

The Changelog ID. Must not be null or empty.

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

The unparsed resource name. Must not be null.

Returns
TypeDescription
ChangelogName

A new instance of ChangelogName 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 ChangelogName Parse(string changelogName)

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

Parameter
NameDescription
changelogNameString

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

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

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

The string representation of the resource name.

Overrides

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

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

resultChangelogName

When this method returns, the parsed ChangelogName, 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}/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
NameDescription
changelogNameString

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.

resultChangelogName

When this method returns, the parsed ChangelogName, 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}/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
NameDescription
aChangelogName
bChangelogName
Returns
TypeDescription
Boolean

Inequality(ChangelogName, ChangelogName)

public static bool operator !=(ChangelogName a, ChangelogName b)
Parameters
NameDescription
aChangelogName
bChangelogName
Returns
TypeDescription
Boolean