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

public sealed class ReservationBlockName : IResourceName, IEquatable<ReservationBlockName>

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

Resource name for the ReservationBlock resource.

Inheritance

object > ReservationBlockName

Namespace

Google.Cloud.HypercomputeCluster.V1Beta

Assembly

Google.Cloud.HypercomputeCluster.V1Beta.dll

Constructors

ReservationBlockName(string, string, string, string)

public ReservationBlockName(string projectId, string zoneId, string reservationId, string reservationBlockId)

Constructs a new instance of a ReservationBlockName class from the component parts of pattern projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservation_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.

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

Type

public ReservationBlockName.ResourceNameType Type { get; }

The ReservationBlockName.ResourceNameType of the contained resource name.

Property Value
Type Description
ReservationBlockNameResourceNameType

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)

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

Formats the IDs into the string representation of this ReservationBlockName with pattern projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservation_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.
Returns
Type Description
string

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

FormatProjectZoneReservationReservationBlock(string, string, string, string)

public static string FormatProjectZoneReservationReservationBlock(string projectId, string zoneId, string reservationId, string reservationBlockId)

Formats the IDs into the string representation of this ReservationBlockName with pattern projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservation_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.
Returns
Type Description
string

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

FromProjectZoneReservationReservationBlock(string, string, string, string)

public static ReservationBlockName FromProjectZoneReservationReservationBlock(string projectId, string zoneId, string reservationId, string reservationBlockId)

Creates a ReservationBlockName with the pattern projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservation_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.
Returns
Type Description
ReservationBlockName

A new instance of ReservationBlockName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ReservationBlockName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ReservationBlockName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
reservationBlockName string

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

The parsed ReservationBlockName 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}

Parse(string, bool)

public static ReservationBlockName Parse(string reservationBlockName, bool allowUnparsed)

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

Parameters
Name Description
reservationBlockName 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
ReservationBlockName

The parsed ReservationBlockName 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}
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 ReservationBlockName)

public static bool TryParse(string reservationBlockName, out ReservationBlockName result)

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

Parameters
Name Description
reservationBlockName string

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

When this method returns, the parsed ReservationBlockName, 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}

TryParse(string, bool, out ReservationBlockName)

public static bool TryParse(string reservationBlockName, bool allowUnparsed, out ReservationBlockName result)

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

Parameters
Name Description
reservationBlockName 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 ReservationBlockName

When this method returns, the parsed ReservationBlockName, 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}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ReservationBlockName, ReservationBlockName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ReservationBlockName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ReservationBlockName

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

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.