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

public sealed class InstanceGroupManagerName : IResourceName, IEquatable<InstanceGroupManagerName>

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

Resource name for the InstanceGroupManager resource.

Inheritance

object > InstanceGroupManagerName

Namespace

Google.Cloud.HypercomputeCluster.V1Beta

Assembly

Google.Cloud.HypercomputeCluster.V1Beta.dll

Constructors

InstanceGroupManagerName(string, string, string)

public InstanceGroupManagerName(string projectId, string zoneId, string instanceGroupManagerId)

Constructs a new instance of a InstanceGroupManagerName class from the component parts of pattern projects/{project}/zones/{zone}/instanceGroupManagers/{instance_group_manager}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

zoneId string

The Zone ID. Must not be null or empty.

instanceGroupManagerId string

The InstanceGroupManager ID. Must not be null or empty.

Properties

InstanceGroupManagerId

public string InstanceGroupManagerId { get; }

The InstanceGroupManager ID. May be null, depending on which resource name is contained by this instance.

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. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

RegionId

public string RegionId { get; }

The Region ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

Type

public InstanceGroupManagerName.ResourceNameType Type { get; }

The InstanceGroupManagerName.ResourceNameType of the contained resource name.

Property Value
Type Description
InstanceGroupManagerNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
Type Description
UnparsedResourceName

ZoneId

public string ZoneId { get; }

The Zone ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

Methods

Format(string, string, string)

public static string Format(string projectId, string zoneId, string instanceGroupManagerId)

Formats the IDs into the string representation of this InstanceGroupManagerName with pattern projects/{project}/zones/{zone}/instanceGroupManagers/{instance_group_manager}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

zoneId string

The Zone ID. Must not be null or empty.

instanceGroupManagerId string

The InstanceGroupManager ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this InstanceGroupManagerName with pattern projects/{project}/zones/{zone}/instanceGroupManagers/{instance_group_manager}.

FormatProjectRegionInstanceGroupManager(string, string, string)

public static string FormatProjectRegionInstanceGroupManager(string projectId, string regionId, string instanceGroupManagerId)

Formats the IDs into the string representation of this InstanceGroupManagerName with pattern projects/{project}/regions/{region}/instanceGroupManagers/{instance_group_manager}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

regionId string

The Region ID. Must not be null or empty.

instanceGroupManagerId string

The InstanceGroupManager ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this InstanceGroupManagerName with pattern projects/{project}/regions/{region}/instanceGroupManagers/{instance_group_manager}.

FormatProjectZoneInstanceGroupManager(string, string, string)

public static string FormatProjectZoneInstanceGroupManager(string projectId, string zoneId, string instanceGroupManagerId)

Formats the IDs into the string representation of this InstanceGroupManagerName with pattern projects/{project}/zones/{zone}/instanceGroupManagers/{instance_group_manager}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

zoneId string

The Zone ID. Must not be null or empty.

instanceGroupManagerId string

The InstanceGroupManager ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this InstanceGroupManagerName with pattern projects/{project}/zones/{zone}/instanceGroupManagers/{instance_group_manager}.

FromProjectRegionInstanceGroupManager(string, string, string)

public static InstanceGroupManagerName FromProjectRegionInstanceGroupManager(string projectId, string regionId, string instanceGroupManagerId)

Creates a InstanceGroupManagerName with the pattern projects/{project}/regions/{region}/instanceGroupManagers/{instance_group_manager}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

regionId string

The Region ID. Must not be null or empty.

instanceGroupManagerId string

The InstanceGroupManager ID. Must not be null or empty.

Returns
Type Description
InstanceGroupManagerName

A new instance of InstanceGroupManagerName constructed from the provided ids.

FromProjectZoneInstanceGroupManager(string, string, string)

public static InstanceGroupManagerName FromProjectZoneInstanceGroupManager(string projectId, string zoneId, string instanceGroupManagerId)

Creates a InstanceGroupManagerName with the pattern projects/{project}/zones/{zone}/instanceGroupManagers/{instance_group_manager}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.

zoneId string

The Zone ID. Must not be null or empty.

instanceGroupManagerId string

The InstanceGroupManager ID. Must not be null or empty.

Returns
Type Description
InstanceGroupManagerName

A new instance of InstanceGroupManagerName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static InstanceGroupManagerName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a InstanceGroupManagerName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
InstanceGroupManagerName

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

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

Parameter
Name Description
instanceGroupManagerName string

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

Returns
Type Description
InstanceGroupManagerName

The parsed InstanceGroupManagerName if successful.

Remarks

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

  • projects/{project}/zones/{zone}/instanceGroupManagers/{instance_group_manager}
  • projects/{project}/regions/{region}/instanceGroupManagers/{instance_group_manager}

Parse(string, bool)

public static InstanceGroupManagerName Parse(string instanceGroupManagerName, bool allowUnparsed)

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

Parameters
Name Description
instanceGroupManagerName 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
InstanceGroupManagerName

The parsed InstanceGroupManagerName if successful.

Remarks

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

  • projects/{project}/zones/{zone}/instanceGroupManagers/{instance_group_manager}
  • projects/{project}/regions/{region}/instanceGroupManagers/{instance_group_manager}

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

public static bool TryParse(string instanceGroupManagerName, out InstanceGroupManagerName result)

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

Parameters
Name Description
instanceGroupManagerName string

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

result InstanceGroupManagerName

When this method returns, the parsed InstanceGroupManagerName, 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}/zones/{zone}/instanceGroupManagers/{instance_group_manager}
  • projects/{project}/regions/{region}/instanceGroupManagers/{instance_group_manager}

TryParse(string, bool, out InstanceGroupManagerName)

public static bool TryParse(string instanceGroupManagerName, bool allowUnparsed, out InstanceGroupManagerName result)

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

Parameters
Name Description
instanceGroupManagerName 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 InstanceGroupManagerName

When this method returns, the parsed InstanceGroupManagerName, 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}/zones/{zone}/instanceGroupManagers/{instance_group_manager}
  • projects/{project}/regions/{region}/instanceGroupManagers/{instance_group_manager}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(InstanceGroupManagerName, InstanceGroupManagerName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a InstanceGroupManagerName

The first resource name to compare, or null.

b InstanceGroupManagerName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a InstanceGroupManagerName

The first resource name to compare, or null.

b InstanceGroupManagerName

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.