Google Cloud Logging v2 API - Class SettingsName (4.2.0)

public sealed class SettingsName : IResourceName, IEquatable<SettingsName>

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

Resource name for the Settings resource.

Inheritance

object > SettingsName

Implements

IResourceName, IEquatable SettingsName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Logging.V2

Assembly

Google.Cloud.Logging.V2.dll

Constructors

SettingsName(string)

public SettingsName(string projectId)

Constructs a new instance of a SettingsName class from the component parts of pattern projects/{project}/settings

Parameter
Name	Description
`projectId`	`string` The `Project` 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`

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

The SettingsName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`SettingsNameResourceNameType`

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)

public static string Format(string projectId)

Formats the IDs into the string representation of this SettingsName with pattern projects/{project}/settings.

Parameter
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SettingsName with pattern `projects/{project}/settings` .

FormatBillingAccount(string)

public static string FormatBillingAccount(string billingAccountId)

Formats the IDs into the string representation of this SettingsName with pattern billingAccounts/{billing_account}/settings.

Parameter
Name	Description
`billingAccountId`	`string` The `BillingAccount` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SettingsName with pattern `billingAccounts/{billing_account}/settings`.

FormatFolder(string)

public static string FormatFolder(string folderId)

Formats the IDs into the string representation of this SettingsName with pattern folders/{folder}/settings.

Parameter
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SettingsName with pattern `folders/{folder}/settings`.

FormatOrganization(string)

public static string FormatOrganization(string organizationId)

Formats the IDs into the string representation of this SettingsName with pattern organizations/{organization}/settings.

Parameter
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SettingsName with pattern `organizations/{organization}/settings`.

FormatProject(string)

public static string FormatProject(string projectId)

Formats the IDs into the string representation of this SettingsName with pattern projects/{project}/settings.

Parameter
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this SettingsName with pattern `projects/{project}/settings` .

FromBillingAccount(string)

public static SettingsName FromBillingAccount(string billingAccountId)

Creates a SettingsName with the pattern billingAccounts/{billing_account}/settings.

Parameter
Name	Description
`billingAccountId`	`string` The `BillingAccount` ID. Must not be `null` or empty.

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

FromFolder(string)

public static SettingsName FromFolder(string folderId)

Creates a SettingsName with the pattern folders/{folder}/settings.

Parameter
Name	Description
`folderId`	`string` The `Folder` ID. Must not be `null` or empty.

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

FromOrganization(string)

public static SettingsName FromOrganization(string organizationId)

Creates a SettingsName with the pattern organizations/{organization}/settings.

Parameter
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.

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

FromProject(string)

public static SettingsName FromProject(string projectId)

Creates a SettingsName with the pattern projects/{project}/settings.

Parameter
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static SettingsName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a SettingsName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

projects/{project}/settings
organizations/{organization}/settings
folders/{folder}/settings
billingAccounts/{billing_account}/settings

Parse(string, bool)

public static SettingsName Parse(string settingsName, bool allowUnparsed)

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

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

Remarks

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

projects/{project}/settings
organizations/{organization}/settings
folders/{folder}/settings
billingAccounts/{billing_account}/settings

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

public static bool TryParse(string settingsName, out SettingsName result)

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

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

TryParse(string, bool, out SettingsName)

public static bool TryParse(string settingsName, bool allowUnparsed, out SettingsName result)

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

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

Or may be in any format if allowUnparsed is true.

Operators

operator ==(SettingsName, SettingsName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`SettingsName` The first resource name to compare, or null.
`b`	`SettingsName` 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 !=(SettingsName, SettingsName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`SettingsName` The first resource name to compare, or null.
`b`	`SettingsName` 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.