Cluster Director v1beta API - Class InstanceTemplateName (1.0.0-beta02)

1.0.0-beta02 (latest) 1.0.0-beta01

public sealed class InstanceTemplateName : IResourceName, IEquatable<InstanceTemplateName>

Reference documentation and code samples for the Cluster Director v1beta API class InstanceTemplateName.

Resource name for the InstanceTemplate resource.

Inheritance

object > InstanceTemplateName

Implements

IResourceName, IEquatableInstanceTemplateName

Inherited Members

object.GetType()

Namespace

Google.Cloud.HypercomputeCluster.V1Beta

Assembly

Google.Cloud.HypercomputeCluster.V1Beta.dll

Constructors

InstanceTemplateName(string, string)

public InstanceTemplateName(string projectId, string instanceTemplateId)

Constructs a new instance of a InstanceTemplateName class from the component parts of pattern projects/{project}/global/instanceTemplates/{instance_template}

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
instanceTemplateId	string The InstanceTemplate ID. Must not be null or empty.

Properties

InstanceTemplateId

public string InstanceTemplateId { get; }

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

Property Value
Type	Description
string

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type	Description
bool

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

Type

public InstanceTemplateName.ResourceNameType Type { get; }

The InstanceTemplateName.ResourceNameType of the contained resource name.

Property Value
Type	Description
InstanceTemplateNameResourceNameType

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)

public static string Format(string projectId, string instanceTemplateId)

Formats the IDs into the string representation of this InstanceTemplateName with pattern projects/{project}/global/instanceTemplates/{instance_template}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
instanceTemplateId	string The InstanceTemplate ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this InstanceTemplateName with pattern projects/{project}/global/instanceTemplates/{instance_template}.

FormatProjectInstanceTemplate(string, string)

public static string FormatProjectInstanceTemplate(string projectId, string instanceTemplateId)

Formats the IDs into the string representation of this InstanceTemplateName with pattern projects/{project}/global/instanceTemplates/{instance_template}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
instanceTemplateId	string The InstanceTemplate ID. Must not be null or empty.

Returns
Type	Description
string	The string representation of this InstanceTemplateName with pattern projects/{project}/global/instanceTemplates/{instance_template}.

FromProjectInstanceTemplate(string, string)

public static InstanceTemplateName FromProjectInstanceTemplate(string projectId, string instanceTemplateId)

Creates a InstanceTemplateName with the pattern projects/{project}/global/instanceTemplates/{instance_template}.

Parameters
Name	Description
projectId	string The Project ID. Must not be null or empty.
instanceTemplateId	string The InstanceTemplate ID. Must not be null or empty.

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

FromUnparsed(UnparsedResourceName)

public static InstanceTemplateName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a InstanceTemplateName containing an unparsed resource name.

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

Returns
Type	Description
InstanceTemplateName	A new instance of InstanceTemplateName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
int

Overrides

object.GetHashCode()

Parse(string)

public static InstanceTemplateName Parse(string instanceTemplateName)

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

Parameter
Name	Description
instanceTemplateName	string The resource name in string form. Must not be null.

Returns
Type	Description
InstanceTemplateName	The parsed InstanceTemplateName if successful.

Remarks

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

• projects/{project}/global/instanceTemplates/{instance_template}

Parse(string, bool)

public static InstanceTemplateName Parse(string instanceTemplateName, bool allowUnparsed)

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

Parameters
Name	Description
instanceTemplateName	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
InstanceTemplateName	The parsed InstanceTemplateName if successful.

Remarks

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

• projects/{project}/global/instanceTemplates/{instance_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

object.ToString()

TryParse(string, out InstanceTemplateName)

public static bool TryParse(string instanceTemplateName, out InstanceTemplateName result)

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

Parameters
Name	Description
instanceTemplateName	string The resource name in string form. Must not be null.
result	InstanceTemplateName When this method returns, the parsed InstanceTemplateName, 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}/global/instanceTemplates/{instance_template}

TryParse(string, bool, out InstanceTemplateName)

public static bool TryParse(string instanceTemplateName, bool allowUnparsed, out InstanceTemplateName result)

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

Parameters
Name	Description
instanceTemplateName	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	InstanceTemplateName When this method returns, the parsed InstanceTemplateName, 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}/global/instanceTemplates/{instance_template}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(InstanceTemplateName, InstanceTemplateName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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