BigQuery Reservation v1 API - Class BiReservationName (2.11.0) 

public sealed class BiReservationName : IResourceName, IEquatable<BiReservationName>

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

Resource name for the BiReservation resource.

Inheritance

object > BiReservationName

Namespace

Google.Cloud.BigQuery.Reservation.V1

Assembly

Google.Cloud.BigQuery.Reservation.V1.dll

Constructors

BiReservationName(string, string)

public BiReservationName(string projectId, string locationId)

Constructs a new instance of a BiReservationName class from the component parts of pattern projects/{project}/locations/{location}/biReservation

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.

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

Type

public BiReservationName.ResourceNameType Type { get; }

The BiReservationName.ResourceNameType of the contained resource name.

Property Value
Type Description
BiReservationNameResourceNameType

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)

public static string Format(string projectId, string locationId)

Formats the IDs into the string representation of this BiReservationName with pattern projects/{project}/locations/{location}/biReservation.

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.
Returns
Type Description
string

The string representation of this BiReservationName with pattern projects/{project}/locations/{location}/biReservation.

FormatProjectLocation(string, string)

public static string FormatProjectLocation(string projectId, string locationId)

Formats the IDs into the string representation of this BiReservationName with pattern projects/{project}/locations/{location}/biReservation.

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.
Returns
Type Description
string

The string representation of this BiReservationName with pattern projects/{project}/locations/{location}/biReservation.

FromProjectLocation(string, string)

public static BiReservationName FromProjectLocation(string projectId, string locationId)

Creates a BiReservationName with the pattern projects/{project}/locations/{location}/biReservation.

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.
Returns
Type Description
BiReservationName

A new instance of BiReservationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static BiReservationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BiReservationName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
biReservationName string

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

The parsed BiReservationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/biReservation

Parse(string, bool)

public static BiReservationName Parse(string biReservationName, bool allowUnparsed)

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

Parameters
Name Description
biReservationName 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
BiReservationName

The parsed BiReservationName if successful.
Remarks

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

  • projects/{project}/locations/{location}/biReservation
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 BiReservationName)

public static bool TryParse(string biReservationName, out BiReservationName result)

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

Parameters
Name Description
biReservationName string

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

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

TryParse(string, bool, out BiReservationName)

public static bool TryParse(string biReservationName, bool allowUnparsed, out BiReservationName result)

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

Parameters
Name Description
biReservationName 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 BiReservationName

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

Operators

operator ==(BiReservationName, BiReservationName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a BiReservationName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a BiReservationName

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

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.