Vertex AI v1 API - Class TemplateName (3.50.0) 

public sealed class TemplateName : IResourceName, IEquatable<TemplateName>

Reference documentation and code samples for the Vertex AI v1 API class TemplateName.

Resource name for the Template resource.

Inheritance

object > TemplateName

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

TemplateName(string, string, string)

public TemplateName(string projectId, string locationId, string templateId)

Constructs a new instance of a TemplateName class from the component parts of pattern projects/{project}/locations/{location}/templates/{template}

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

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

TemplateId

public string TemplateId { get; }

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

Property Value
Type Description
string

Type

public TemplateName.ResourceNameType Type { get; }

The TemplateName.ResourceNameType of the contained resource name.

Property Value
Type Description
TemplateNameResourceNameType

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)

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

Formats the IDs into the string representation of this TemplateName with pattern projects/{project}/locations/{location}/templates/{template}.

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

The Template ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this TemplateName with pattern projects/{project}/locations/{location}/templates/{template}.

FormatProjectLocationTemplate(string, string, string)

public static string FormatProjectLocationTemplate(string projectId, string locationId, string templateId)

Formats the IDs into the string representation of this TemplateName with pattern projects/{project}/locations/{location}/templates/{template}.

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

The Template ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this TemplateName with pattern projects/{project}/locations/{location}/templates/{template}.

FromProjectLocationTemplate(string, string, string)

public static TemplateName FromProjectLocationTemplate(string projectId, string locationId, string templateId)

Creates a TemplateName with the pattern projects/{project}/locations/{location}/templates/{template}.

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

The Template ID. Must not be null or empty.
Returns
Type Description
TemplateName

A new instance of TemplateName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TemplateName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TemplateName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
TemplateName

A new instance of TemplateName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static TemplateName Parse(string templateName)

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

Parameter
Name Description
templateName string

The resource name in string form. Must not be null.
Returns
Type Description
TemplateName

The parsed TemplateName if successful.
Remarks

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

  • projects/{project}/locations/{location}/templates/{template}

Parse(string, bool)

public static TemplateName Parse(string templateName, bool allowUnparsed)

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

Parameters
Name Description
templateName 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
TemplateName

The parsed TemplateName if successful.
Remarks

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

  • projects/{project}/locations/{location}/templates/{template}
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

TryParse(string, out TemplateName)

public static bool TryParse(string templateName, out TemplateName result)

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

Parameters
Name Description
templateName string

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

When this method returns, the parsed TemplateName, 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}/templates/{template}

TryParse(string, bool, out TemplateName)

public static bool TryParse(string templateName, bool allowUnparsed, out TemplateName result)

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

Parameters
Name Description
templateName 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 TemplateName

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

Operators

operator ==(TemplateName, TemplateName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a TemplateName

The first resource name to compare, or null.
b TemplateName

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 !=(TemplateName, TemplateName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a TemplateName

The first resource name to compare, or null.
b TemplateName

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.