Class BillingAccountName (4.0.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class BillingAccountName : IResourceName, IEquatable<BillingAccountName>

Resource name for the 'billing account' resource which is widespread across Google Cloud Platform. While most resource names are generated on a per-API basis, many APIs use a billing account resource, and it's useful to be able to pass values from one API to another.

Inheritance

Object > BillingAccountName

Namespace

Google.Api.Gax.ResourceNames

Assembly

Google.Api.Gax.dll

Constructors

BillingAccountName(String)

public BillingAccountName(string billingAccountId)

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

Parameter
NameDescription
billingAccountIdString

The BillingAccount 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
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
Boolean

Type

public BillingAccountName.ResourceNameType Type { get; }

The BillingAccountName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
BillingAccountName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-nullif this instance contains an unparsed resource name.

Property Value
TypeDescription
UnparsedResourceName

Methods

Equals(BillingAccountName)

public bool Equals(BillingAccountName other)
Parameter
NameDescription
otherBillingAccountName
Returns
TypeDescription
Boolean

Equals(Object)

public override bool Equals(object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
Boolean
Overrides

Format(String)

public static string Format(string billingAccountId)

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

Parameter
NameDescription
billingAccountIdString

The BillingAccount ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this BillingAccountName with pattern billingAccounts/{billing_account}.

FormatBillingAccount(String)

public static string FormatBillingAccount(string billingAccountId)

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

Parameter
NameDescription
billingAccountIdString

The BillingAccount ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this BillingAccountName with pattern billingAccounts/{billing_account}.

FromBillingAccount(String)

public static BillingAccountName FromBillingAccount(string billingAccountId)

Creates a BillingAccountName with the pattern billingAccounts/{billing_account}.

Parameter
NameDescription
billingAccountIdString

The BillingAccount ID. Must not be null or empty.

Returns
TypeDescription
BillingAccountName

A new instance of BillingAccountName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static BillingAccountName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BillingAccountName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
BillingAccountName

A new instance of BillingAccountName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()
Returns
TypeDescription
Int32
Overrides

Parse(String)

public static BillingAccountName Parse(string billingAccountName)

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

Parameter
NameDescription
billingAccountNameString

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

Returns
TypeDescription
BillingAccountName

The parsed BillingAccountName if successful.

Remarks

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

  • billingAccounts/{billing_account}

Parse(String, Boolean)

public static BillingAccountName Parse(string billingAccountName, bool allowUnparsed)

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

Parameters
NameDescription
billingAccountNameString

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

allowUnparsedBoolean

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
TypeDescription
BillingAccountName

The parsed BillingAccountName if successful.

Remarks

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

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

ToString()

public override string ToString()

The string representation of the resource name.

Returns
TypeDescription
String

The string representation of the resource name.

Overrides

TryParse(String, out BillingAccountName)

public static bool TryParse(string billingAccountName, out BillingAccountName result)

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

Parameters
NameDescription
billingAccountNameString

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

resultBillingAccountName

When this method returns, the parsed BillingAccountName, or null if parsing failed.

Returns
TypeDescription
Boolean

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}

TryParse(String, Boolean, out BillingAccountName)

public static bool TryParse(string billingAccountName, bool allowUnparsed, out BillingAccountName result)

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

Parameters
NameDescription
billingAccountNameString

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

allowUnparsedBoolean

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.

resultBillingAccountName

When this method returns, the parsed BillingAccountName, or null if parsing failed.

Returns
TypeDescription
Boolean

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}
Or may be in any format if allowUnparsed is true.

Operators

Equality(BillingAccountName, BillingAccountName)

public static bool operator ==(BillingAccountName a, BillingAccountName b)
Parameters
NameDescription
aBillingAccountName
bBillingAccountName
Returns
TypeDescription
Boolean

Inequality(BillingAccountName, BillingAccountName)

public static bool operator !=(BillingAccountName a, BillingAccountName b)
Parameters
NameDescription
aBillingAccountName
bBillingAccountName
Returns
TypeDescription
Boolean