BigQuery Reservation v1 API - Class ReservationGroupName (2.10.0) 

public sealed class ReservationGroupName : IResourceName, IEquatable<ReservationGroupName>

Reference documentation and code samples for the BigQuery Reservation v1 API class ReservationGroupName.

Resource name for the ReservationGroup resource.

Inheritance

object > ReservationGroupName

Namespace

Google.Cloud.BigQuery.Reservation.V1

Assembly

Google.Cloud.BigQuery.Reservation.V1.dll

Constructors

ReservationGroupName(string, string, string)

public ReservationGroupName(string projectId, string locationId, string reservationGroupId)

Constructs a new instance of a ReservationGroupName class from the component parts of pattern projects/{project}/locations/{location}/reservationGroups/{reservation_group}

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.
reservationGroupId string

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

LocationId

public string LocationId { get; }

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

Property Value
Type Description
string

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

ReservationGroupId

public string ReservationGroupId { get; }

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

Property Value
Type Description
string

Type

public ReservationGroupName.ResourceNameType Type { get; }

The ReservationGroupName.ResourceNameType of the contained resource name.

Property Value
Type Description
ReservationGroupNameResourceNameType

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

Formats the IDs into the string representation of this ReservationGroupName with pattern projects/{project}/locations/{location}/reservationGroups/{reservation_group}.

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.
reservationGroupId string

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

The string representation of this ReservationGroupName with pattern projects/{project}/locations/{location}/reservationGroups/{reservation_group}.

FormatProjectLocationReservationGroup(string, string, string)

public static string FormatProjectLocationReservationGroup(string projectId, string locationId, string reservationGroupId)

Formats the IDs into the string representation of this ReservationGroupName with pattern projects/{project}/locations/{location}/reservationGroups/{reservation_group}.

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.
reservationGroupId string

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

The string representation of this ReservationGroupName with pattern projects/{project}/locations/{location}/reservationGroups/{reservation_group}.

FromProjectLocationReservationGroup(string, string, string)

public static ReservationGroupName FromProjectLocationReservationGroup(string projectId, string locationId, string reservationGroupId)

Creates a ReservationGroupName with the pattern projects/{project}/locations/{location}/reservationGroups/{reservation_group}.

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.
reservationGroupId string

The ReservationGroup ID. Must not be null or empty.
Returns
Type Description
ReservationGroupName

A new instance of ReservationGroupName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static ReservationGroupName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ReservationGroupName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
reservationGroupName string

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

The parsed ReservationGroupName if successful.
Remarks

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

  • projects/{project}/locations/{location}/reservationGroups/{reservation_group}

Parse(string, bool)

public static ReservationGroupName Parse(string reservationGroupName, bool allowUnparsed)

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

Parameters
Name Description
reservationGroupName 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
ReservationGroupName

The parsed ReservationGroupName if successful.
Remarks

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

  • projects/{project}/locations/{location}/reservationGroups/{reservation_group}
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 ReservationGroupName)

public static bool TryParse(string reservationGroupName, out ReservationGroupName result)

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

Parameters
Name Description
reservationGroupName string

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

When this method returns, the parsed ReservationGroupName, 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}/reservationGroups/{reservation_group}

TryParse(string, bool, out ReservationGroupName)

public static bool TryParse(string reservationGroupName, bool allowUnparsed, out ReservationGroupName result)

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

Parameters
Name Description
reservationGroupName 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 ReservationGroupName

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

Operators

operator ==(ReservationGroupName, ReservationGroupName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a ReservationGroupName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a ReservationGroupName

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

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.