Google Cloud Logging v2 API - Class CmekSettingsName (4.2.0)

public sealed class CmekSettingsName : IResourceName, IEquatable<CmekSettingsName>

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

Resource name for the CmekSettings resource.

Inheritance

object > CmekSettingsName

Implements

IResourceName, IEquatable CmekSettingsName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Logging.V2

Assembly

Google.Cloud.Logging.V2.dll

Constructors

CmekSettingsName(string)

public CmekSettingsName(string projectId)

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

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

The CmekSettingsName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`CmekSettingsNameResourceNameType`

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 CmekSettingsName with pattern projects/{project}/cmekSettings.

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

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

FormatBillingAccount(string)

public static string FormatBillingAccount(string billingAccountId)

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

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

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

FormatFolder(string)

public static string FormatFolder(string folderId)

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

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

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

FormatOrganization(string)

public static string FormatOrganization(string organizationId)

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

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

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

FormatProject(string)

public static string FormatProject(string projectId)

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

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

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

FromBillingAccount(string)

public static CmekSettingsName FromBillingAccount(string billingAccountId)

Creates a CmekSettingsName with the pattern billingAccounts/{billing_account}/cmekSettings .

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

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

FromFolder(string)

public static CmekSettingsName FromFolder(string folderId)

Creates a CmekSettingsName with the pattern folders/{folder}/cmekSettings.

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

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

FromOrganization(string)

public static CmekSettingsName FromOrganization(string organizationId)

Creates a CmekSettingsName with the pattern organizations/{organization}/cmekSettings.

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

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

FromProject(string)

public static CmekSettingsName FromProject(string projectId)

Creates a CmekSettingsName with the pattern projects/{project}/cmekSettings.

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

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

FromUnparsed(UnparsedResourceName)

public static CmekSettingsName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CmekSettingsName containing an unparsed resource name.

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

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

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

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

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

Remarks

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

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

Parse(string, bool)

public static CmekSettingsName Parse(string cmekSettingsName, bool allowUnparsed)

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

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

Remarks

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

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

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

public static bool TryParse(string cmekSettingsName, out CmekSettingsName result)

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

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

TryParse(string, bool, out CmekSettingsName)

public static bool TryParse(string cmekSettingsName, bool allowUnparsed, out CmekSettingsName result)

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

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

Or may be in any format if allowUnparsed is true.

Operators

operator ==(CmekSettingsName, CmekSettingsName)

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

Determines whether two specified resource names have the same value.

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

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

Determines whether two specified resource names have different values.

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