Google Cloud Logging v2 API - Class BillingAccountLocationName (4.3.0)

public sealed class BillingAccountLocationName : IResourceName, IEquatable<BillingAccountLocationName>

Reference documentation and code samples for the Google Cloud Logging v2 API class BillingAccountLocationName.

Resource name for the BillingAccountLocation resource.

Inheritance

object > BillingAccountLocationName

Namespace

Google.Cloud.Logging.V2

Assembly

Google.Cloud.Logging.V2.dll

Constructors

BillingAccountLocationName(string, string)

public BillingAccountLocationName(string billingAccountId, string locationId)

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

Parameters
NameDescription
billingAccountIdstring

The BillingAccount ID. Must not be null or empty.

locationIdstring

The Location 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
bool

LocationId

public string LocationId { get; }

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

Property Value
TypeDescription
string

Type

public BillingAccountLocationName.ResourceNameType Type { get; }

The BillingAccountLocationName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
BillingAccountLocationNameResourceNameType

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

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

Parameters
NameDescription
billingAccountIdstring

The BillingAccount ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this BillingAccountLocationName with pattern billingAccounts/{billing_account}/locations/{location}.

FormatBillingAccountLocation(string, string)

public static string FormatBillingAccountLocation(string billingAccountId, string locationId)

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

Parameters
NameDescription
billingAccountIdstring

The BillingAccount ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this BillingAccountLocationName with pattern billingAccounts/{billing_account}/locations/{location}.

FromBillingAccountLocation(string, string)

public static BillingAccountLocationName FromBillingAccountLocation(string billingAccountId, string locationId)

Creates a BillingAccountLocationName with the pattern billingAccounts/{billing_account}/locations/{location}.

Parameters
NameDescription
billingAccountIdstring

The BillingAccount ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

Returns
TypeDescription
BillingAccountLocationName

A new instance of BillingAccountLocationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static BillingAccountLocationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a BillingAccountLocationName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
BillingAccountLocationName

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

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

Parameter
NameDescription
billingAccountLocationNamestring

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

Returns
TypeDescription
BillingAccountLocationName

The parsed BillingAccountLocationName if successful.

Remarks

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

  • billingAccounts/{billing_account}/locations/{location}

Parse(string, bool)

public static BillingAccountLocationName Parse(string billingAccountLocationName, bool allowUnparsed)

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

Parameters
NameDescription
billingAccountLocationNamestring

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
BillingAccountLocationName

The parsed BillingAccountLocationName if successful.

Remarks

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

  • billingAccounts/{billing_account}/locations/{location}
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 BillingAccountLocationName)

public static bool TryParse(string billingAccountLocationName, out BillingAccountLocationName result)

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

Parameters
NameDescription
billingAccountLocationNamestring

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

resultBillingAccountLocationName

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

  • billingAccounts/{billing_account}/locations/{location}

TryParse(string, bool, out BillingAccountLocationName)

public static bool TryParse(string billingAccountLocationName, bool allowUnparsed, out BillingAccountLocationName result)

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

Parameters
NameDescription
billingAccountLocationNamestring

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.

resultBillingAccountLocationName

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

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

Operators

operator ==(BillingAccountLocationName, BillingAccountLocationName)

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

Determines whether two specified resource names have the same value.

Parameters
NameDescription
aBillingAccountLocationName

The first resource name to compare, or null.

bBillingAccountLocationName

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

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

Determines whether two specified resource names have different values.

Parameters
NameDescription
aBillingAccountLocationName

The first resource name to compare, or null.

bBillingAccountLocationName

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.