Cloud Channel v1 API - Class BillingAccountName (2.10.0)

public sealed class BillingAccountName : IResourceName, IEquatable<BillingAccountName>

Reference documentation and code samples for the Cloud Channel v1 API class BillingAccountName.

Resource name for the BillingAccount resource.

Inheritance

object > BillingAccountName

Namespace

Google.Cloud.Channel.V1

Assembly

Google.Cloud.Channel.V1.dll

Constructors

BillingAccountName(string, string)

public BillingAccountName(string accountId, string billingAccountId)

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

Parameters
NameDescription
accountIdstring

The Account ID. Must not be null or empty.

billingAccountIdstring

The BillingAccount ID. Must not be null or empty.

Properties

AccountId

public string AccountId { get; }

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

Property Value
TypeDescription
string

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
bool

Type

public BillingAccountName.ResourceNameType Type { get; }

The BillingAccountName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
BillingAccountNameResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(string, string)

public static string Format(string accountId, string billingAccountId)

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

Parameters
NameDescription
accountIdstring

The Account ID. Must not be null or empty.

billingAccountIdstring

The BillingAccount ID. Must not be null or empty.

Returns
TypeDescription
string

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

FormatAccountBillingAccount(string, string)

public static string FormatAccountBillingAccount(string accountId, string billingAccountId)

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

Parameters
NameDescription
accountIdstring

The Account ID. Must not be null or empty.

billingAccountIdstring

The BillingAccount ID. Must not be null or empty.

Returns
TypeDescription
string

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

FromAccountBillingAccount(string, string)

public static BillingAccountName FromAccountBillingAccount(string accountId, string billingAccountId)

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

Parameters
NameDescription
accountIdstring

The Account ID. Must not be null or empty.

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 a hash code for this resource name.

Returns
TypeDescription
int
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:

  • accounts/{account}/billingAccounts/{billing_account}

Parse(string, bool)

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.

allowUnparsedbool

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:

  • accounts/{account}/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
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:

  • accounts/{account}/billingAccounts/{billing_account}

TryParse(string, bool, 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.

allowUnparsedbool

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
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:

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

Operators

operator ==(BillingAccountName, BillingAccountName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aBillingAccountName

The first resource name to compare, or null.

bBillingAccountName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is the same as the value of b; otherwise, false.

operator !=(BillingAccountName, BillingAccountName)

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aBillingAccountName

The first resource name to compare, or null.

bBillingAccountName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.