Class VersionName

Resource name for the Version resource.

Inheritance

object

VersionName

Implements

IResourceName

IEquatable<VersionName>

Inherited Members

object.GetType()

Namespace: Google.Cloud.Dialogflow.V2

Assembly: Google.Cloud.Dialogflow.V2.dll

Syntax

public sealed class VersionName : IResourceName, IEquatable<VersionName>

Constructors

VersionName(string, string)

Constructs a new instance of a VersionName class from the component parts of pattern projects/{project}/agent/versions/{version}

Declaration

public VersionName(string projectId, string versionId)

Parameters

Type	Name	Description
string	projectId	The Project ID. Must not be null or empty.
string	versionId	The Version ID. Must not be null or empty.

Properties

IsKnownPattern

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

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
bool

Implements

IResourceName.IsKnownPattern

LocationId

The Location ID. May be null, depending on which resource name is contained by this instance.

Declaration

public string LocationId { get; }

Property Value

Type	Description
string

ProjectId

The Project ID. May be null, depending on which resource name is contained by this instance.

Declaration

public string ProjectId { get; }

Property Value

Type	Description
string

Type

The VersionName.ResourceNameType of the contained resource name.

Declaration

public VersionName.ResourceNameType Type { get; }

Property Value

Type	Description
VersionName.ResourceNameType

UnparsedResource

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

Declaration

public UnparsedResourceName UnparsedResource { get; }

Property Value

Type	Description
UnparsedResourceName

VersionId

The Version ID. May be null, depending on which resource name is contained by this instance.

Declaration

public string VersionId { get; }

Property Value

Type	Description
string

Methods

Format(string, string)

Formats the IDs into the string representation of this VersionName with pattern projects/{project}/agent/versions/{version}.

Declaration

public static string Format(string projectId, string versionId)

Parameters

Type	Name	Description
string	projectId	The Project ID. Must not be null or empty.
string	versionId	The Version ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this VersionName with pattern projects/{project}/agent/versions/{version}.

FormatProjectLocationVersion(string, string, string)

Formats the IDs into the string representation of this VersionName with pattern projects/{project}/locations/{location}/agent/versions/{version}.

Declaration

public static string FormatProjectLocationVersion(string projectId, string locationId, string versionId)

Parameters

Type	Name	Description
string	projectId	The Project ID. Must not be null or empty.
string	locationId	The Location ID. Must not be null or empty.
string	versionId	The Version ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this VersionName with pattern projects/{project}/locations/{location}/agent/versions/{version}.

FormatProjectVersion(string, string)

Formats the IDs into the string representation of this VersionName with pattern projects/{project}/agent/versions/{version}.

Declaration

public static string FormatProjectVersion(string projectId, string versionId)

Parameters

Type	Name	Description
string	projectId	The Project ID. Must not be null or empty.
string	versionId	The Version ID. Must not be null or empty.

Returns

Type	Description
string	The string representation of this VersionName with pattern projects/{project}/agent/versions/{version}.

FromProjectLocationVersion(string, string, string)

Creates a VersionName with the pattern projects/{project}/locations/{location}/agent/versions/{version}.

Declaration

public static VersionName FromProjectLocationVersion(string projectId, string locationId, string versionId)

Parameters

Type	Name	Description
string	projectId	The Project ID. Must not be null or empty.
string	locationId	The Location ID. Must not be null or empty.
string	versionId	The Version ID. Must not be null or empty.

Returns

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

FromProjectVersion(string, string)

Creates a VersionName with the pattern projects/{project}/agent/versions/{version}.

Declaration

public static VersionName FromProjectVersion(string projectId, string versionId)

Parameters

Type	Name	Description
string	projectId	The Project ID. Must not be null or empty.
string	versionId	The Version ID. Must not be null or empty.

Returns

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

FromUnparsed(UnparsedResourceName)

Creates a VersionName containing an unparsed resource name.

Declaration

public static VersionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

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

Returns

Type	Description
VersionName	A new instance of VersionName containing the provided unparsedResourceName.

GetHashCode()

Returns a hash code for this resource name.

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

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

Declaration

public static VersionName Parse(string versionName)

Parameters

Type	Name	Description
string	versionName	The resource name in string form. Must not be null.

Returns

Type	Description
VersionName	The parsed VersionName if successful.

Remarks

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

• projects/{project}/agent/versions/{version}
• projects/{project}/locations/{location}/agent/versions/{version}

Parse(string, bool)

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

Declaration

public static VersionName Parse(string versionName, bool allowUnparsed)

Parameters

Type	Name	Description
string	versionName	The resource name in string form. Must not be null.
bool	allowUnparsed	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
VersionName	The parsed VersionName if successful.

Remarks

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

• projects/{project}/agent/versions/{version}
• projects/{project}/locations/{location}/agent/versions/{version}

Or may be in any format if allowUnparsed is true.

ToString()

The string representation of the resource name.

Declaration

public override string ToString()

Returns

Type	Description
string	The string representation of the resource name.

Overrides

object.ToString()

Implements

IResourceName.ToString()

TryParse(string, out VersionName)

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

Declaration

public static bool TryParse(string versionName, out VersionName result)

Parameters

Type	Name	Description
string	versionName	The resource name in string form. Must not be null.
VersionName	result	When this method returns, the parsed VersionName, 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}/agent/versions/{version}
• projects/{project}/locations/{location}/agent/versions/{version}

TryParse(string, bool, out VersionName)

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

Declaration

public static bool TryParse(string versionName, bool allowUnparsed, out VersionName result)

Parameters

Type	Name	Description
string	versionName	The resource name in string form. Must not be null.
bool	allowUnparsed	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.
VersionName	result	When this method returns, the parsed VersionName, 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}/agent/versions/{version}
• projects/{project}/locations/{location}/agent/versions/{version}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(VersionName, VersionName)

Determines whether two specified resource names have the same value.

Declaration

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

Parameters

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

Determines whether two specified resource names have different values.

Declaration

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

Parameters

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