BigQuery Reservation v1 API - Class CapacityCommitmentName (2.10.0) 

public sealed class CapacityCommitmentName : IResourceName, IEquatable<CapacityCommitmentName>

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

Resource name for the CapacityCommitment resource.

Inheritance

object > CapacityCommitmentName

Namespace

Google.Cloud.BigQuery.Reservation.V1

Assembly

Google.Cloud.BigQuery.Reservation.V1.dll

Constructors

CapacityCommitmentName(string, string, string)

public CapacityCommitmentName(string projectId, string locationId, string capacityCommitmentId)

Constructs a new instance of a CapacityCommitmentName class from the component parts of pattern projects/{project}/locations/{location}/capacityCommitments/{capacity_commitment}

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

The CapacityCommitment ID. Must not be null or empty.

Properties

CapacityCommitmentId

public string CapacityCommitmentId { get; }

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

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. 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 CapacityCommitmentName.ResourceNameType Type { get; }

The CapacityCommitmentName.ResourceNameType of the contained resource name.

Property Value
Type Description
CapacityCommitmentNameResourceNameType

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

Formats the IDs into the string representation of this CapacityCommitmentName with pattern projects/{project}/locations/{location}/capacityCommitments/{capacity_commitment}.

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

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

The string representation of this CapacityCommitmentName with pattern projects/{project}/locations/{location}/capacityCommitments/{capacity_commitment}.

FormatProjectLocationCapacityCommitment(string, string, string)

public static string FormatProjectLocationCapacityCommitment(string projectId, string locationId, string capacityCommitmentId)

Formats the IDs into the string representation of this CapacityCommitmentName with pattern projects/{project}/locations/{location}/capacityCommitments/{capacity_commitment}.

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

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

The string representation of this CapacityCommitmentName with pattern projects/{project}/locations/{location}/capacityCommitments/{capacity_commitment}.

FromProjectLocationCapacityCommitment(string, string, string)

public static CapacityCommitmentName FromProjectLocationCapacityCommitment(string projectId, string locationId, string capacityCommitmentId)

Creates a CapacityCommitmentName with the pattern projects/{project}/locations/{location}/capacityCommitments/{capacity_commitment}.

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

The CapacityCommitment ID. Must not be null or empty.
Returns
Type Description
CapacityCommitmentName

A new instance of CapacityCommitmentName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CapacityCommitmentName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CapacityCommitmentName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
capacityCommitmentName string

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

The parsed CapacityCommitmentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/capacityCommitments/{capacity_commitment}

Parse(string, bool)

public static CapacityCommitmentName Parse(string capacityCommitmentName, bool allowUnparsed)

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

Parameters
Name Description
capacityCommitmentName 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
CapacityCommitmentName

The parsed CapacityCommitmentName if successful.
Remarks

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

  • projects/{project}/locations/{location}/capacityCommitments/{capacity_commitment}
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 CapacityCommitmentName)

public static bool TryParse(string capacityCommitmentName, out CapacityCommitmentName result)

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

Parameters
Name Description
capacityCommitmentName string

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

When this method returns, the parsed CapacityCommitmentName, 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}/capacityCommitments/{capacity_commitment}

TryParse(string, bool, out CapacityCommitmentName)

public static bool TryParse(string capacityCommitmentName, bool allowUnparsed, out CapacityCommitmentName result)

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

Parameters
Name Description
capacityCommitmentName 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 CapacityCommitmentName

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

Operators

operator ==(CapacityCommitmentName, CapacityCommitmentName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a CapacityCommitmentName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a CapacityCommitmentName

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

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.