Infrastructure Manager v1 API - Class TerraformVersionName (1.3.0)

public sealed class TerraformVersionName : IResourceName, IEquatable<TerraformVersionName>

Reference documentation and code samples for the Infrastructure Manager v1 API class TerraformVersionName.

Resource name for the TerraformVersion resource.

Inheritance

object > TerraformVersionName

Namespace

Google.Cloud.Config.V1

Assembly

Google.Cloud.Config.V1.dll

Constructors

TerraformVersionName(string, string, string)

public TerraformVersionName(string projectId, string locationId, string terraformVersionId)

Constructs a new instance of a TerraformVersionName class from the component parts of pattern projects/{project}/locations/{location}/terraformVersions/{terraform_version}

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

terraformVersionIdstring

The TerraformVersion 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
bool

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

TerraformVersionId

public string TerraformVersionId { get; }

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

Property Value
TypeDescription
string

Type

public TerraformVersionName.ResourceNameType Type { get; }

The TerraformVersionName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
TerraformVersionNameResourceNameType

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

Formats the IDs into the string representation of this TerraformVersionName with pattern projects/{project}/locations/{location}/terraformVersions/{terraform_version}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

terraformVersionIdstring

The TerraformVersion ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this TerraformVersionName with pattern projects/{project}/locations/{location}/terraformVersions/{terraform_version}.

FormatProjectLocationTerraformVersion(string, string, string)

public static string FormatProjectLocationTerraformVersion(string projectId, string locationId, string terraformVersionId)

Formats the IDs into the string representation of this TerraformVersionName with pattern projects/{project}/locations/{location}/terraformVersions/{terraform_version}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

terraformVersionIdstring

The TerraformVersion ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this TerraformVersionName with pattern projects/{project}/locations/{location}/terraformVersions/{terraform_version}.

FromProjectLocationTerraformVersion(string, string, string)

public static TerraformVersionName FromProjectLocationTerraformVersion(string projectId, string locationId, string terraformVersionId)

Creates a TerraformVersionName with the pattern projects/{project}/locations/{location}/terraformVersions/{terraform_version}.

Parameters
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

terraformVersionIdstring

The TerraformVersion ID. Must not be null or empty.

Returns
TypeDescription
TerraformVersionName

A new instance of TerraformVersionName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TerraformVersionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TerraformVersionName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
TerraformVersionName

A new instance of TerraformVersionName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static TerraformVersionName Parse(string terraformVersionName)

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

Parameter
NameDescription
terraformVersionNamestring

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

Returns
TypeDescription
TerraformVersionName

The parsed TerraformVersionName if successful.

Remarks

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

  • projects/{project}/locations/{location}/terraformVersions/{terraform_version}

Parse(string, bool)

public static TerraformVersionName Parse(string terraformVersionName, bool allowUnparsed)

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

Parameters
NameDescription
terraformVersionNamestring

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

allowUnparsedbool

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
TerraformVersionName

The parsed TerraformVersionName if successful.

Remarks

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

  • projects/{project}/locations/{location}/terraformVersions/{terraform_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 TerraformVersionName)

public static bool TryParse(string terraformVersionName, out TerraformVersionName result)

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

Parameters
NameDescription
terraformVersionNamestring

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

resultTerraformVersionName

When this method returns, the parsed TerraformVersionName, or null if parsing failed.

Returns
TypeDescription
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}/terraformVersions/{terraform_version}

TryParse(string, bool, out TerraformVersionName)

public static bool TryParse(string terraformVersionName, bool allowUnparsed, out TerraformVersionName result)

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

Parameters
NameDescription
terraformVersionNamestring

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

allowUnparsedbool

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.

resultTerraformVersionName

When this method returns, the parsed TerraformVersionName, or null if parsing failed.

Returns
TypeDescription
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}/terraformVersions/{terraform_version}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(TerraformVersionName, TerraformVersionName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aTerraformVersionName

The first resource name to compare, or null.

bTerraformVersionName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(TerraformVersionName, TerraformVersionName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aTerraformVersionName

The first resource name to compare, or null.

bTerraformVersionName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.