Class VersionName (2.1.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class VersionName : IResourceName, IEquatable<VersionName>

Resource name for the Version resource.

Inheritance

Object > VersionName

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

VersionName(String, String, String, String, String)

public VersionName(string projectId, string locationId, string agentId, string flowId, string versionId)

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

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.

versionIdString

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

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

The VersionName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
VersionName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

VersionId

public string VersionId { get; }

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

Property Value
TypeDescription
String

Methods

Format(String, String, String, String, String)

public static string Format(string projectId, string locationId, string agentId, string flowId, string versionId)

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

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.

versionIdString

The Version ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this VersionName with pattern projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/versions/{version}.

FormatProjectLocationAgentFlowVersion(String, String, String, String, String)

public static string FormatProjectLocationAgentFlowVersion(string projectId, string locationId, string agentId, string flowId, string versionId)

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

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.

versionIdString

The Version ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this VersionName with pattern projects/{project}/locations/{location}/agents/{agent}/flows/{flow}/versions/{version}.

FromProjectLocationAgentFlowVersion(String, String, String, String, String)

public static VersionName FromProjectLocationAgentFlowVersion(string projectId, string locationId, string agentId, string flowId, string versionId)

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

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.

versionIdString

The Version ID. Must not be null or empty.

Returns
TypeDescription
VersionName

A new instance of VersionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static VersionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a VersionName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
VersionName

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

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

Parameter
NameDescription
versionNameString

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

Returns
TypeDescription
VersionName

The parsed VersionName 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}/versions/{version}

Parse(String, Boolean)

public static VersionName Parse(string versionName, bool allowUnparsed)

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

Parameters
NameDescription
versionNameString

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
VersionName

The parsed VersionName 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}/versions/{version}
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 VersionName)

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

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

Parameters
NameDescription
versionNameString

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

resultVersionName

When this method returns, the parsed VersionName, 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}/versions/{version}

TryParse(String, Boolean, out VersionName)

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

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

Parameters
NameDescription
versionNameString

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.

resultVersionName

When this method returns, the parsed VersionName, 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}/versions/{version}
Or may be in any format if allowUnparsed is true.

Operators

Equality(VersionName, VersionName)

public static bool operator ==(VersionName a, VersionName b)
Parameters
NameDescription
aVersionName
bVersionName
Returns
TypeDescription
Boolean

Inequality(VersionName, VersionName)

public static bool operator !=(VersionName a, VersionName b)
Parameters
NameDescription
aVersionName
bVersionName
Returns
TypeDescription
Boolean