Google Cloud Logging v2 API - Class BillingAccountLocationName (4.1.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

Implements

IResourceName, IEquatable BillingAccountLocationName

Inherited Members

object.GetType()

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
Name	Description
`billingAccountId`	`string` The `BillingAccount` ID. Must not be `null` or empty.
`locationId`	`string` 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
Type	Description
`string`

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
Type	Description
`bool`

LocationId

public string LocationId { get; }

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

Property Value
Type	Description
`string`

Type

public BillingAccountLocationName.ResourceNameType Type { get; }

The BillingAccountLocationName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`BillingAccountLocationNameResourceNameType`

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 locationId)

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

Parameters
Name	Description
`billingAccountId`	`string` The `BillingAccount` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`billingAccountId`	`string` The `BillingAccount` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`billingAccountId`	`string` The `BillingAccount` ID. Must not be `null` or empty.
`locationId`	`string` The `Location` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

Returns
Type	Description
`BillingAccountLocationName`	A new instance of BillingAccountLocationName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static BillingAccountLocationName Parse(string billingAccountLocationName)

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

Parameter
Name	Description
`billingAccountLocationName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`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
Name	Description
`billingAccountLocationName`	`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
`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
Type	Description
`string`	The string representation of the resource name.

Overrides

object.ToString()

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
Name	Description
`billingAccountLocationName`	`string` The resource name in string form. Must not be `null`.
`result`	`BillingAccountLocationName` When this method returns, the parsed BillingAccountLocationName, 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}/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
Name	Description
`billingAccountLocationName`	`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`	`BillingAccountLocationName` When this method returns, the parsed BillingAccountLocationName, 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}/locations/{location}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(BillingAccountLocationName, BillingAccountLocationName)

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

Parameters
Name	Description
`a`	`BillingAccountLocationName`
`b`	`BillingAccountLocationName`

Returns
Type	Description
`bool`

operator !=(BillingAccountLocationName, BillingAccountLocationName)

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

Parameters
Name	Description
`a`	`BillingAccountLocationName`
`b`	`BillingAccountLocationName`

Returns
Type	Description
`bool`