Capacity Planner v1beta API - Class ReservationName (1.0.0-beta02) 

public sealed class ReservationName : IResourceName, IEquatable<ReservationName>

Reference documentation and code samples for the Capacity Planner v1beta API class ReservationName.

Resource name for the Reservation resource.

Inheritance

object > ReservationName

Namespace

Google.Cloud.CapacityPlanner.V1Beta

Assembly

Google.Cloud.CapacityPlanner.V1Beta.dll

Constructors

ReservationName(string, string, string)

public ReservationName(string projectId, string locationId, string reservationId)

Constructs a new instance of a ReservationName class from the component parts of pattern projects/{project}/locations/{location}/reservations/{reservation}

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
reservationId string

The Reservation ID. Must not be null or empty.

Properties

FolderId

public string FolderId { get; }

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

LocationId

public string LocationId { get; }

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

Property Value
Type Description
string

OrganizationId

public string OrganizationId { get; }

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

Property Value
Type Description
string

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

ReservationId

public string ReservationId { get; }

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

Property Value
Type Description
string

Type

public ReservationName.ResourceNameType Type { get; }

The ReservationName.ResourceNameType of the contained resource name.

Property Value
Type Description
ReservationNameResourceNameType

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, string)

public static string Format(string projectId, string locationId, string reservationId)

Formats the IDs into the string representation of this ReservationName with pattern projects/{project}/locations/{location}/reservations/{reservation}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
reservationId string

The Reservation ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ReservationName with pattern projects/{project}/locations/{location}/reservations/{reservation}.

FormatFolderLocationReservation(string, string, string)

public static string FormatFolderLocationReservation(string folderId, string locationId, string reservationId)

Formats the IDs into the string representation of this ReservationName with pattern folders/{folder}/locations/{location}/reservations/{reservation}.

Parameters
Name Description
folderId string

The Folder ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
reservationId string

The Reservation ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ReservationName with pattern folders/{folder}/locations/{location}/reservations/{reservation}.

FormatOrganizationLocationReservation(string, string, string)

public static string FormatOrganizationLocationReservation(string organizationId, string locationId, string reservationId)

Formats the IDs into the string representation of this ReservationName with pattern organizations/{organization}/locations/{location}/reservations/{reservation}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
reservationId string

The Reservation ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ReservationName with pattern organizations/{organization}/locations/{location}/reservations/{reservation}.

FormatProjectLocationReservation(string, string, string)

public static string FormatProjectLocationReservation(string projectId, string locationId, string reservationId)

Formats the IDs into the string representation of this ReservationName with pattern projects/{project}/locations/{location}/reservations/{reservation}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
reservationId string

The Reservation ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this ReservationName with pattern projects/{project}/locations/{location}/reservations/{reservation}.

FromFolderLocationReservation(string, string, string)

public static ReservationName FromFolderLocationReservation(string folderId, string locationId, string reservationId)

Creates a ReservationName with the pattern folders/{folder}/locations/{location}/reservations/{reservation}.

Parameters
Name Description
folderId string

The Folder ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
reservationId string

The Reservation ID. Must not be null or empty.
Returns
Type Description
ReservationName

A new instance of ReservationName constructed from the provided ids.

FromOrganizationLocationReservation(string, string, string)

public static ReservationName FromOrganizationLocationReservation(string organizationId, string locationId, string reservationId)

Creates a ReservationName with the pattern organizations/{organization}/locations/{location}/reservations/{reservation}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
reservationId string

The Reservation ID. Must not be null or empty.
Returns
Type Description
ReservationName

A new instance of ReservationName constructed from the provided ids.

FromProjectLocationReservation(string, string, string)

public static ReservationName FromProjectLocationReservation(string projectId, string locationId, string reservationId)

Creates a ReservationName with the pattern projects/{project}/locations/{location}/reservations/{reservation}.

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
locationId string

The Location ID. Must not be null or empty.
reservationId string

The Reservation ID. Must not be null or empty.
Returns
Type Description
ReservationName

A new instance of ReservationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ReservationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ReservationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
reservationName string

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

The parsed ReservationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/reservations/{reservation}
  • organizations/{organization}/locations/{location}/reservations/{reservation}
  • folders/{folder}/locations/{location}/reservations/{reservation}

Parse(string, bool)

public static ReservationName Parse(string reservationName, bool allowUnparsed)

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

Parameters
Name Description
reservationName 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
ReservationName

The parsed ReservationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/reservations/{reservation}
  • organizations/{organization}/locations/{location}/reservations/{reservation}
  • folders/{folder}/locations/{location}/reservations/{reservation}
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 ReservationName)

public static bool TryParse(string reservationName, out ReservationName result)

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

Parameters
Name Description
reservationName string

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

When this method returns, the parsed ReservationName, 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}/locations/{location}/reservations/{reservation}
  • organizations/{organization}/locations/{location}/reservations/{reservation}
  • folders/{folder}/locations/{location}/reservations/{reservation}

TryParse(string, bool, out ReservationName)

public static bool TryParse(string reservationName, bool allowUnparsed, out ReservationName result)

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

Parameters
Name Description
reservationName 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 ReservationName

When this method returns, the parsed ReservationName, 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}/locations/{location}/reservations/{reservation}
  • organizations/{organization}/locations/{location}/reservations/{reservation}
  • folders/{folder}/locations/{location}/reservations/{reservation}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(ReservationName, ReservationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ReservationName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ReservationName

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

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.