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.
Namespace
GoogleGoogle.CloudGoogle.Cloud.BigQueryGoogle.Cloud.BigQuery.ReservationV1Assembly
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 |
locationId | string The |
capacityCommitmentId | string The |
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 |
locationId | string The |
capacityCommitmentId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this CapacityCommitmentName with pattern
|
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 |
locationId | string The |
capacityCommitmentId | string The |
Returns | |
---|---|
Type | Description |
string | The string representation of this CapacityCommitmentName with pattern
|
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 |
locationId | string The |
capacityCommitmentId | string The |
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 |
Returns | |
---|---|
Type | Description |
CapacityCommitmentName | A new instance of CapacityCommitmentName containing the provided
|
GetHashCode()
public override int GetHashCode()
Returns a hash code for this resource name.
Returns | |
---|---|
Type | Description |
int |
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 |
Returns | |
---|---|
Type | Description |
CapacityCommitmentName | The parsed CapacityCommitmentName if successful. |
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 |
allowUnparsed | bool If |
Returns | |
---|---|
Type | Description |
CapacityCommitmentName | The parsed CapacityCommitmentName if successful. |
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/capacityCommitments/{capacity_commitment}
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. |
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 |
result | CapacityCommitmentName When this method returns, the parsed CapacityCommitmentName, or |
Returns | |
---|---|
Type | Description |
bool |
|
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 |
allowUnparsed | bool If |
result | CapacityCommitmentName When this method returns, the parsed CapacityCommitmentName, or |
Returns | |
---|---|
Type | Description |
bool |
|
To parse successfully, the resource name must be formatted as one of the following:
-
projects/{project}/locations/{location}/capacityCommitments/{capacity_commitment}
allowUnparsed
is true
.
Operators
operator ==(CapacityCommitmentName, CapacityCommitmentName)
public static bool operator ==(CapacityCommitmentName a, CapacityCommitmentName b)
Parameters | |
---|---|
Name | Description |
a | CapacityCommitmentName |
b | CapacityCommitmentName |
Returns | |
---|---|
Type | Description |
bool |
operator !=(CapacityCommitmentName, CapacityCommitmentName)
public static bool operator !=(CapacityCommitmentName a, CapacityCommitmentName b)
Parameters | |
---|---|
Name | Description |
a | CapacityCommitmentName |
b | CapacityCommitmentName |
Returns | |
---|---|
Type | Description |
bool |