Class ModelName (2.1.0)

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

Resource name for the Model resource.

Inheritance

Object > ModelName

Namespace

Google.Cloud.Dialogflow.Cx.V3

Assembly

Google.Cloud.Dialogflow.Cx.V3.dll

Constructors

ModelName(String, String, String)

public ModelName(string projectId, string locationId, string modelId)

Constructs a new instance of a ModelName class from the component parts of pattern projects/{project}/locations/{location}/models/{model}

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

modelIdString

The Model ID. Must not be null or empty.

Properties

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

ModelId

public string ModelId { get; }

The Model 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 ModelName.ResourceNameType Type { get; }

The ModelName.ResourceNameType of the contained resource name.

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

public static string Format(string projectId, string locationId, string modelId)

Formats the IDs into the string representation of this ModelName with pattern projects/{project}/locations/{location}/models/{model}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

modelIdString

The Model ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ModelName with pattern projects/{project}/locations/{location}/models/{model}.

FormatProjectLocationModel(String, String, String)

public static string FormatProjectLocationModel(string projectId, string locationId, string modelId)

Formats the IDs into the string representation of this ModelName with pattern projects/{project}/locations/{location}/models/{model}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

modelIdString

The Model ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this ModelName with pattern projects/{project}/locations/{location}/models/{model}.

FromProjectLocationModel(String, String, String)

public static ModelName FromProjectLocationModel(string projectId, string locationId, string modelId)

Creates a ModelName with the pattern projects/{project}/locations/{location}/models/{model} .

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

locationIdString

The Location ID. Must not be null or empty.

modelIdString

The Model ID. Must not be null or empty.

Returns
TypeDescription
ModelName

A new instance of ModelName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ModelName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ModelName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
ModelName

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

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

Parameter
NameDescription
modelNameString

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

Returns
TypeDescription
ModelName

The parsed ModelName if successful.

Remarks

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

  • projects/{project}/locations/{location}/models/{model}

Parse(String, Boolean)

public static ModelName Parse(string modelName, bool allowUnparsed)

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

Parameters
NameDescription
modelNameString

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
ModelName

The parsed ModelName if successful.

Remarks

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

  • projects/{project}/locations/{location}/models/{model}
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 ModelName)

public static bool TryParse(string modelName, out ModelName result)

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

Parameters
NameDescription
modelNameString

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

resultModelName

When this method returns, the parsed ModelName, 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}/models/{model}

TryParse(String, Boolean, out ModelName)

public static bool TryParse(string modelName, bool allowUnparsed, out ModelName result)

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

Parameters
NameDescription
modelNameString

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.

resultModelName

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

Operators

Equality(ModelName, ModelName)

public static bool operator ==(ModelName a, ModelName b)
Parameters
NameDescription
aModelName
bModelName
Returns
TypeDescription
Boolean

Inequality(ModelName, ModelName)

public static bool operator !=(ModelName a, ModelName b)
Parameters
NameDescription
aModelName
bModelName
Returns
TypeDescription
Boolean