Parameter Manager v1 API - Class TemplateVersionName (1.1.0) 

public sealed class TemplateVersionName : IResourceName, IEquatable<TemplateVersionName>

Reference documentation and code samples for the Parameter Manager v1 API class TemplateVersionName.

Resource name for the TemplateVersion resource.

Inheritance

object > TemplateVersionName

Namespace

Google.Cloud.ParameterManager.V1

Assembly

Google.Cloud.ParameterManager.V1.dll

Constructors

TemplateVersionName(string, string, string, string)

public TemplateVersionName(string projectId, string locationId, string templateId, string templateVersionId)

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

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

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

TemplateVersionId

public string TemplateVersionId { get; }

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

Property Value
Type Description
string

Type

public TemplateVersionName.ResourceNameType Type { get; }

The TemplateVersionName.ResourceNameType of the contained resource name.

Property Value
Type Description
TemplateVersionNameResourceNameType

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, string)

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

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

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

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

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

FormatProjectLocationTemplateTemplateVersion(string, string, string, string)

public static string FormatProjectLocationTemplateTemplateVersion(string projectId, string locationId, string templateId, string templateVersionId)

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

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

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

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

FromProjectLocationTemplateTemplateVersion(string, string, string, string)

public static TemplateVersionName FromProjectLocationTemplateTemplateVersion(string projectId, string locationId, string templateId, string templateVersionId)

Creates a TemplateVersionName with the pattern projects/{project}/locations/{location}/templates/{template}/versions/{template_version}.

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

The TemplateVersion ID. Must not be null or empty.
Returns
Type Description
TemplateVersionName

A new instance of TemplateVersionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TemplateVersionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TemplateVersionName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
templateVersionName string

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

The parsed TemplateVersionName if successful.
Remarks

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

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

Parse(string, bool)

public static TemplateVersionName Parse(string templateVersionName, bool allowUnparsed)

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

Parameters
Name Description
templateVersionName 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
TemplateVersionName

The parsed TemplateVersionName if successful.
Remarks

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

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

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 TemplateVersionName)

public static bool TryParse(string templateVersionName, out TemplateVersionName result)

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

Parameters
Name Description
templateVersionName string

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

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

TryParse(string, bool, out TemplateVersionName)

public static bool TryParse(string templateVersionName, bool allowUnparsed, out TemplateVersionName result)

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

Parameters
Name Description
templateVersionName 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 TemplateVersionName

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

Or may be in any format if allowUnparsed is true.

Operators

operator ==(TemplateVersionName, TemplateVersionName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a TemplateVersionName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a TemplateVersionName

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

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.