Google Cloud Logging v2 API - Class LogExclusionName (4.1.0)

public sealed class LogExclusionName : IResourceName, IEquatable<LogExclusionName>

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

Resource name for the LogExclusion resource.

Inheritance

object > LogExclusionName

Implements

IResourceName, IEquatable LogExclusionName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Logging.V2

Assembly

Google.Cloud.Logging.V2.dll

Constructors

LogExclusionName(string, string)

public LogExclusionName(string projectId, string exclusionId)

Constructs a new instance of a LogExclusionName class from the component parts of pattern projects/{project}/exclusions/{exclusion}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`exclusionId`	`string` The `Exclusion` 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`

ExclusionId

public string ExclusionId { get; }

The Exclusion 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`

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 LogExclusionName.ResourceNameType Type { get; }

The LogExclusionName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`LogExclusionNameResourceNameType`

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

Formats the IDs into the string representation of this LogExclusionName with pattern projects/{project}/exclusions/{exclusion}.

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

Returns
Type	Description
`string`	The string representation of this LogExclusionName with pattern `projects/{project}/exclusions/{exclusion}`.

FormatBillingAccountExclusion(string, string)

public static string FormatBillingAccountExclusion(string billingAccountId, string exclusionId)

Formats the IDs into the string representation of this LogExclusionName with pattern billingAccounts/{billing_account}/exclusions/{exclusion}.

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

Returns
Type	Description
`string`	The string representation of this LogExclusionName with pattern `billingAccounts/{billing_account}/exclusions/{exclusion}`.

FormatFolderExclusion(string, string)

public static string FormatFolderExclusion(string folderId, string exclusionId)

Formats the IDs into the string representation of this LogExclusionName with pattern folders/{folder}/exclusions/{exclusion}.

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

Returns
Type	Description
`string`	The string representation of this LogExclusionName with pattern `folders/{folder}/exclusions/{exclusion}`.

FormatOrganizationExclusion(string, string)

public static string FormatOrganizationExclusion(string organizationId, string exclusionId)

Formats the IDs into the string representation of this LogExclusionName with pattern organizations/{organization}/exclusions/{exclusion}.

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

Returns
Type	Description
`string`	The string representation of this LogExclusionName with pattern `organizations/{organization}/exclusions/{exclusion}`.

FormatProjectExclusion(string, string)

public static string FormatProjectExclusion(string projectId, string exclusionId)

Formats the IDs into the string representation of this LogExclusionName with pattern projects/{project}/exclusions/{exclusion}.

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

Returns
Type	Description
`string`	The string representation of this LogExclusionName with pattern `projects/{project}/exclusions/{exclusion}`.

FromBillingAccountExclusion(string, string)

public static LogExclusionName FromBillingAccountExclusion(string billingAccountId, string exclusionId)

Creates a LogExclusionName with the pattern billingAccounts/{billing_account}/exclusions/{exclusion}.

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

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

FromFolderExclusion(string, string)

public static LogExclusionName FromFolderExclusion(string folderId, string exclusionId)

Creates a LogExclusionName with the pattern folders/{folder}/exclusions/{exclusion}.

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

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

FromOrganizationExclusion(string, string)

public static LogExclusionName FromOrganizationExclusion(string organizationId, string exclusionId)

Creates a LogExclusionName with the pattern organizations/{organization}/exclusions/{exclusion}.

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

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

FromProjectExclusion(string, string)

public static LogExclusionName FromProjectExclusion(string projectId, string exclusionId)

Creates a LogExclusionName with the pattern projects/{project}/exclusions/{exclusion}.

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

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

FromUnparsed(UnparsedResourceName)

public static LogExclusionName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a LogExclusionName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/exclusions/{exclusion}
organizations/{organization}/exclusions/{exclusion}
folders/{folder}/exclusions/{exclusion}
billingAccounts/{billing_account}/exclusions/{exclusion}

Parse(string, bool)

public static LogExclusionName Parse(string logExclusionName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/exclusions/{exclusion}
organizations/{organization}/exclusions/{exclusion}
folders/{folder}/exclusions/{exclusion}
billingAccounts/{billing_account}/exclusions/{exclusion}

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

public static bool TryParse(string logExclusionName, out LogExclusionName result)

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

Parameters
Name	Description
`logExclusionName`	`string` The resource name in string form. Must not be `null`.
`result`	`LogExclusionName` When this method returns, the parsed LogExclusionName, 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}/exclusions/{exclusion}
organizations/{organization}/exclusions/{exclusion}
folders/{folder}/exclusions/{exclusion}
billingAccounts/{billing_account}/exclusions/{exclusion}

TryParse(string, bool, out LogExclusionName)

public static bool TryParse(string logExclusionName, bool allowUnparsed, out LogExclusionName result)

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

Parameters
Name	Description
`logExclusionName`	`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`	`LogExclusionName` When this method returns, the parsed LogExclusionName, 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}/exclusions/{exclusion}
organizations/{organization}/exclusions/{exclusion}
folders/{folder}/exclusions/{exclusion}
billingAccounts/{billing_account}/exclusions/{exclusion}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(LogExclusionName, LogExclusionName)

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

Parameters
Name	Description
`a`	`LogExclusionName`
`b`	`LogExclusionName`

Returns
Type	Description
`bool`

operator !=(LogExclusionName, LogExclusionName)

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

Parameters
Name	Description
`a`	`LogExclusionName`
`b`	`LogExclusionName`

Returns
Type	Description
`bool`