Class LogName (4.0.0) 

public sealed class LogName : IResourceName, IEquatable<LogName>

Resource name for the Log resource.

Inheritance

Object > LogName

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
Boolean

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
LogName.ResourceNameType

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
Int32
Overrides

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, Boolean)

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 Boolean

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

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

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

TryParse(String, Boolean, 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 Boolean

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

  • 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

Equality(LogName, LogName)

public static bool operator ==(LogName a, LogName b)
Parameters
Name Description
a LogName
b LogName
Returns
Type Description
Boolean

Inequality(LogName, LogName)

public static bool operator !=(LogName a, LogName b)
Parameters
Name Description
a LogName
b LogName
Returns
Type Description
Boolean