Cluster Director v1beta API - Class ReservationSubBlockName (1.0.0-beta01)

public sealed class ReservationSubBlockName : IResourceName, IEquatable<ReservationSubBlockName>

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

Resource name for the ReservationSubBlock resource.

Inheritance

object > ReservationSubBlockName

Namespace

Google.Cloud.HypercomputeCluster.V1Beta

Assembly

Google.Cloud.HypercomputeCluster.V1Beta.dll

Constructors

ReservationSubBlockName(string, string, string, string, string)

public ReservationSubBlockName(string projectId, string zoneId, string reservationId, string reservationBlockId, string reservationSubBlockId)

Constructs a new instance of a ReservationSubBlockName class from the component parts of pattern projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservation_block}/reservationSubBlocks/{reservation_sub_block}

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.

reservationId string

The Reservation ID. Must not be null or empty.

reservationBlockId string

The ReservationBlock ID. Must not be null or empty.

reservationSubBlockId string

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

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

ReservationBlockId

public string ReservationBlockId { get; }

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

Property Value
Type Description
string

ReservationId

public string ReservationId { get; }

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

Property Value
Type Description
string

ReservationSubBlockId

public string ReservationSubBlockId { get; }

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

Property Value
Type Description
string

Type

public ReservationSubBlockName.ResourceNameType Type { get; }

The ReservationSubBlockName.ResourceNameType of the contained resource name.

Property Value
Type Description
ReservationSubBlockNameResourceNameType

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. Will not be null, unless this instance contains an unparsed resource name.

Property Value
Type Description
string

Methods

Format(string, string, string, string, string)

public static string Format(string projectId, string zoneId, string reservationId, string reservationBlockId, string reservationSubBlockId)

Formats the IDs into the string representation of this ReservationSubBlockName with pattern projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservation_block}/reservationSubBlocks/{reservation_sub_block} .

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.

reservationId string

The Reservation ID. Must not be null or empty.

reservationBlockId string

The ReservationBlock ID. Must not be null or empty.

reservationSubBlockId string

The ReservationSubBlock ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ReservationSubBlockName with pattern projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservation_block}/reservationSubBlocks/{reservation_sub_block} .

FormatProjectZoneReservationReservationBlockReservationSubBlock(string, string, string, string, string)

public static string FormatProjectZoneReservationReservationBlockReservationSubBlock(string projectId, string zoneId, string reservationId, string reservationBlockId, string reservationSubBlockId)

Formats the IDs into the string representation of this ReservationSubBlockName with pattern projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservation_block}/reservationSubBlocks/{reservation_sub_block} .

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.

reservationId string

The Reservation ID. Must not be null or empty.

reservationBlockId string

The ReservationBlock ID. Must not be null or empty.

reservationSubBlockId string

The ReservationSubBlock ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this ReservationSubBlockName with pattern projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservation_block}/reservationSubBlocks/{reservation_sub_block} .

FromProjectZoneReservationReservationBlockReservationSubBlock(string, string, string, string, string)

public static ReservationSubBlockName FromProjectZoneReservationReservationBlockReservationSubBlock(string projectId, string zoneId, string reservationId, string reservationBlockId, string reservationSubBlockId)

Creates a ReservationSubBlockName with the pattern projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservation_block}/reservationSubBlocks/{reservation_sub_block} .

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.

reservationId string

The Reservation ID. Must not be null or empty.

reservationBlockId string

The ReservationBlock ID. Must not be null or empty.

reservationSubBlockId string

The ReservationSubBlock ID. Must not be null or empty.

Returns
Type Description
ReservationSubBlockName

A new instance of ReservationSubBlockName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ReservationSubBlockName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ReservationSubBlockName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
ReservationSubBlockName

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

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

Parameter
Name Description
reservationSubBlockName string

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

Returns
Type Description
ReservationSubBlockName

The parsed ReservationSubBlockName if successful.

Remarks

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

  • projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservation_block}/reservationSubBlocks/{reservation_sub_block}

Parse(string, bool)

public static ReservationSubBlockName Parse(string reservationSubBlockName, bool allowUnparsed)

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

Parameters
Name Description
reservationSubBlockName 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
ReservationSubBlockName

The parsed ReservationSubBlockName if successful.

Remarks

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

  • projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservation_block}/reservationSubBlocks/{reservation_sub_block}
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 ReservationSubBlockName)

public static bool TryParse(string reservationSubBlockName, out ReservationSubBlockName result)

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

Parameters
Name Description
reservationSubBlockName string

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

result ReservationSubBlockName

When this method returns, the parsed ReservationSubBlockName, 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}/reservations/{reservation}/reservationBlocks/{reservation_block}/reservationSubBlocks/{reservation_sub_block}

TryParse(string, bool, out ReservationSubBlockName)

public static bool TryParse(string reservationSubBlockName, bool allowUnparsed, out ReservationSubBlockName result)

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

Parameters
Name Description
reservationSubBlockName 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 ReservationSubBlockName

When this method returns, the parsed ReservationSubBlockName, 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}/reservations/{reservation}/reservationBlocks/{reservation_block}/reservationSubBlocks/{reservation_sub_block}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ReservationSubBlockName, ReservationSubBlockName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ReservationSubBlockName

The first resource name to compare, or null.

b ReservationSubBlockName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ReservationSubBlockName

The first resource name to compare, or null.

b ReservationSubBlockName

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.