Class 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

System.Object

BillingAccountName

Implements

IResourceName

System.IEquatable<BillingAccountName>

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Api.Gax.ResourceNames

Assembly: Google.Api.Gax.dll

Syntax

public sealed class BillingAccountName : IResourceName, IEquatable<BillingAccountName>

Constructors

BillingAccountName(String)

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

Declaration

public BillingAccountName(string billingAccountId)

Parameters

Type	Name	Description
System.String	billingAccountId	The BillingAccount ID. Must not be null or empty.

Properties

BillingAccountId

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

Declaration

public string BillingAccountId { get; }

Property Value

Type	Description
System.String

IsKnownPattern

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

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
System.Boolean

Implements

IResourceName.IsKnownPattern

Type

The BillingAccountName.ResourceNameType of the contained resource name.

Declaration

public BillingAccountName.ResourceNameType Type { get; }

Property Value

Type	Description
BillingAccountName.ResourceNameType

UnparsedResource

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

Declaration

public UnparsedResourceName UnparsedResource { get; }

Property Value

Type	Description
UnparsedResourceName

Methods

Equals(BillingAccountName)

Declaration

public bool Equals(BillingAccountName other)

Parameters

Type	Name	Description
BillingAccountName	other

Returns

Type	Description
System.Boolean

Implements

System.IEquatable<T>.Equals(T)

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

Overrides

System.Object.Equals(System.Object)

Format(String)

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

Declaration

public static string Format(string billingAccountId)

Parameters

Type	Name	Description
System.String	billingAccountId	The BillingAccount ID. Must not be null or empty.

Returns

Type	Description
System.String	The string representation of this BillingAccountName with pattern billingAccounts/{billing_account}.

FormatBillingAccount(String)

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

Declaration

public static string FormatBillingAccount(string billingAccountId)

Parameters

Type	Name	Description
System.String	billingAccountId	The BillingAccount ID. Must not be null or empty.

Returns

Type	Description
System.String	The string representation of this BillingAccountName with pattern billingAccounts/{billing_account}.

FromBillingAccount(String)

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

Declaration

public static BillingAccountName FromBillingAccount(string billingAccountId)

Parameters

Type	Name	Description
System.String	billingAccountId	The BillingAccount ID. Must not be null or empty.

Returns

Type	Description
BillingAccountName	A new instance of BillingAccountName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a BillingAccountName containing an unparsed resource name.

Declaration

public static BillingAccountName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

Type	Name	Description
UnparsedResourceName	unparsedResourceName	The unparsed resource name. Must not be null.

Returns

Type	Description
BillingAccountName	A new instance of BillingAccountName containing the provided unparsedResourceName.

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

Parse(String)

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

Declaration

public static BillingAccountName Parse(string billingAccountName)

Parameters

Type	Name	Description
System.String	billingAccountName	The resource name in string form. Must not be null.

Returns

Type	Description
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)

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

Declaration

public static BillingAccountName Parse(string billingAccountName, bool allowUnparsed)

Parameters

Type	Name	Description
System.String	billingAccountName	The resource name in string form. Must not be null.
System.Boolean	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.

Returns

Type	Description
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()

The string representation of the resource name.

Declaration

public override string ToString()

Returns

Type	Description
System.String	The string representation of the resource name.

Overrides

System.Object.ToString()

Implements

IResourceName.ToString()

TryParse(String, out BillingAccountName)

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

Declaration

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

Parameters

Type	Name	Description
System.String	billingAccountName	The resource name in string form. Must not be null.
BillingAccountName	result	When this method returns, the parsed BillingAccountName, or null if parsing failed.

Returns

Type	Description
System.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)

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

Declaration

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

Parameters

Type	Name	Description
System.String	billingAccountName	The resource name in string form. Must not be null.
System.Boolean	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.
BillingAccountName	result	When this method returns, the parsed BillingAccountName, or null if parsing failed.

Returns

Type	Description
System.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)

Declaration

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

Parameters

Type	Name	Description
BillingAccountName	a
BillingAccountName	b

Returns

Type	Description
System.Boolean

Inequality(BillingAccountName, BillingAccountName)

Declaration

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

Parameters

Type	Name	Description
BillingAccountName	a
BillingAccountName	b

Returns

Type	Description
System.Boolean