Cloud Billing Budget v1beta1 API - Class BudgetName (2.0.0-beta05) 

public sealed class BudgetName : IResourceName, IEquatable<BudgetName>

Reference documentation and code samples for the Cloud Billing Budget v1beta1 API class BudgetName.

Resource name for the Budget resource.

Inheritance

object > BudgetName

Namespace

Google.Cloud.Billing.Budgets.V1Beta1

Assembly

Google.Cloud.Billing.Budgets.V1Beta1.dll

Constructors

BudgetName(string, string)

public BudgetName(string billingAccountId, string budgetId)

Constructs a new instance of a BudgetName class from the component parts of pattern billingAccounts/{billing_account}/budgets/{budget}

Parameters
Name Description
billingAccountId string

The BillingAccount ID. Must not be null or empty.
budgetId string

The Budget ID. Must not be null or empty.

Properties

BillingAccountId

public string BillingAccountId { get; }

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

Property Value
Type Description
string

BudgetId

public string BudgetId { get; }

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

Type

public BudgetName.ResourceNameType Type { get; }

The BudgetName.ResourceNameType of the contained resource name.

Property Value
Type Description
BudgetNameResourceNameType

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

Formats the IDs into the string representation of this BudgetName with pattern billingAccounts/{billing_account}/budgets/{budget}.

Parameters
Name Description
billingAccountId string

The BillingAccount ID. Must not be null or empty.
budgetId string

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

The string representation of this BudgetName with pattern billingAccounts/{billing_account}/budgets/{budget}.

FormatBillingAccountBudget(string, string)

public static string FormatBillingAccountBudget(string billingAccountId, string budgetId)

Formats the IDs into the string representation of this BudgetName with pattern billingAccounts/{billing_account}/budgets/{budget}.

Parameters
Name Description
billingAccountId string

The BillingAccount ID. Must not be null or empty.
budgetId string

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

The string representation of this BudgetName with pattern billingAccounts/{billing_account}/budgets/{budget}.

FromBillingAccountBudget(string, string)

public static BudgetName FromBillingAccountBudget(string billingAccountId, string budgetId)

Creates a BudgetName with the pattern billingAccounts/{billing_account}/budgets/{budget} .

Parameters
Name Description
billingAccountId string

The BillingAccount ID. Must not be null or empty.
budgetId string

The Budget ID. Must not be null or empty.
Returns
Type Description
BudgetName

A new instance of BudgetName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static BudgetName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BudgetName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

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

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

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

Parameter
Name Description
budgetName string

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

The parsed BudgetName if successful.
Remarks

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

  • billingAccounts/{billing_account}/budgets/{budget}

Parse(string, bool)

public static BudgetName Parse(string budgetName, bool allowUnparsed)

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

Parameters
Name Description
budgetName 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
BudgetName

The parsed BudgetName if successful.
Remarks

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

  • billingAccounts/{billing_account}/budgets/{budget}
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 BudgetName)

public static bool TryParse(string budgetName, out BudgetName result)

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

Parameters
Name Description
budgetName string

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

When this method returns, the parsed BudgetName, 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:

  • billingAccounts/{billing_account}/budgets/{budget}

TryParse(string, bool, out BudgetName)

public static bool TryParse(string budgetName, bool allowUnparsed, out BudgetName result)

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

Parameters
Name Description
budgetName 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 BudgetName

When this method returns, the parsed BudgetName, 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:

  • billingAccounts/{billing_account}/budgets/{budget}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(BudgetName, BudgetName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a BudgetName

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

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a BudgetName

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

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.