Google Cloud Logging v2 API - Class LogName (4.2.0)

public sealed class LogName : IResourceName, IEquatable<LogName>

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

Resource name for the Log resource.

Inheritance

object > LogName

Implements

IResourceName, IEquatable LogName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Logging.V2

Assembly

Google.Cloud.Logging.V2.dll

Constructors

LogName(string, string)

public LogName(string projectId, string logId)

Constructs a new instance of a LogName class from the component parts of pattern projects/{project}/logs/{log}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`logId`	`string` The `Log` ID. Must not be `null` or empty.

Properties

BillingAccountId

public string BillingAccountId { get; }

The BillingAccount ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

FolderId

public string FolderId { get; }

The Folder ID. May be null, depending on which resource name is contained by this instance.

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`

LogId

public string LogId { get; }

The Log ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

OrganizationId

public string OrganizationId { get; }

The Organization ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

ProjectId

public string ProjectId { get; }

The Project ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type	Description
`string`

Type

public LogName.ResourceNameType Type { get; }

The LogName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`LogNameResourceNameType`

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 projectId, string logId)

Formats the IDs into the string representation of this LogName with pattern projects/{project}/logs/{log}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`logId`	`string` The `Log` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this LogName with pattern `projects/{project}/logs/{log}`.

FormatBillingAccountLog(string, string)

public static string FormatBillingAccountLog(string billingAccountId, string logId)

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

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

Returns
Type	Description
`string`	The string representation of this LogName with pattern `billingAccounts/{billing_account}/logs/{log}`.

FormatFolderLog(string, string)

public static string FormatFolderLog(string folderId, string logId)

Formats the IDs into the string representation of this LogName with pattern folders/{folder}/logs/{log}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`logId`	`string` The `Log` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this LogName with pattern `folders/{folder}/logs/{log}`.

FormatOrganizationLog(string, string)

public static string FormatOrganizationLog(string organizationId, string logId)

Formats the IDs into the string representation of this LogName with pattern organizations/{organization}/logs/{log}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`logId`	`string` The `Log` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this LogName with pattern `organizations/{organization}/logs/{log}`.

FormatProjectLog(string, string)

public static string FormatProjectLog(string projectId, string logId)

Formats the IDs into the string representation of this LogName with pattern projects/{project}/logs/{log}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`logId`	`string` The `Log` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this LogName with pattern `projects/{project}/logs/{log}`.

FromBillingAccountLog(string, string)

public static LogName FromBillingAccountLog(string billingAccountId, string logId)

Creates a LogName with the pattern billingAccounts/{billing_account}/logs/{log}.

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

Returns
Type	Description
`LogName`	A new instance of LogName constructed from the provided ids.

FromFolderLog(string, string)

public static LogName FromFolderLog(string folderId, string logId)

Creates a LogName with the pattern folders/{folder}/logs/{log}.

Parameters
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.
`logId`	`string` The `Log` ID. Must not be `null` or empty.

Returns
Type	Description
`LogName`	A new instance of LogName constructed from the provided ids.

FromOrganizationLog(string, string)

public static LogName FromOrganizationLog(string organizationId, string logId)

Creates a LogName with the pattern organizations/{organization}/logs/{log}.

Parameters
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.
`logId`	`string` The `Log` ID. Must not be `null` or empty.

Returns
Type	Description
`LogName`	A new instance of LogName constructed from the provided ids.

FromProjectLog(string, string)

public static LogName FromProjectLog(string projectId, string logId)

Creates a LogName with the pattern projects/{project}/logs/{log}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`logId`	`string` The `Log` ID. Must not be `null` or empty.

Returns
Type	Description
`LogName`	A new instance of LogName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static LogName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a LogName containing an unparsed resource name.

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

Returns
Type	Description
`LogName`	A new instance of LogName 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 LogName Parse(string logName)

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

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

Returns
Type	Description
`LogName`	The parsed LogName if successful.

Remarks

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

projects/{project}/logs/{log}
organizations/{organization}/logs/{log}
folders/{folder}/logs/{log}
billingAccounts/{billing_account}/logs/{log}

Parse(string, bool)

public static LogName Parse(string logName, bool allowUnparsed)

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

Parameters
Name	Description
`logName`	`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
`LogName`	The parsed LogName if successful.

Remarks

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

projects/{project}/logs/{log}
organizations/{organization}/logs/{log}
folders/{folder}/logs/{log}
billingAccounts/{billing_account}/logs/{log}

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

public static bool TryParse(string logName, out LogName result)

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

Parameters
Name	Description
`logName`	`string` The resource name in string form. Must not be `null`.
`result`	`LogName` When this method returns, the parsed LogName, 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:

projects/{project}/logs/{log}
organizations/{organization}/logs/{log}
folders/{folder}/logs/{log}
billingAccounts/{billing_account}/logs/{log}

TryParse(string, bool, out LogName)

public static bool TryParse(string logName, bool allowUnparsed, out LogName result)

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

Parameters
Name	Description
`logName`	`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`	`LogName` When this method returns, the parsed LogName, 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:

projects/{project}/logs/{log}
organizations/{organization}/logs/{log}
folders/{folder}/logs/{log}
billingAccounts/{billing_account}/logs/{log}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(LogName, LogName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`LogName` The first resource name to compare, or null.
`b`	`LogName` The second resource name to compare, or null.

Returns
Type	Description
`bool`	true if the value of `a` is the same as the value of `b`; otherwise, false.

operator !=(LogName, LogName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`LogName` The first resource name to compare, or null.
`b`	`LogName` The second resource name to compare, or null.

Returns
Type	Description
`bool`	true if the value of `a` is different from the value of `b`; otherwise, false.