Class CmekSettingsName (4.0.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class CmekSettingsName : IResourceName, IEquatable<CmekSettingsName>

Resource name for the CmekSettings resource.

Inheritance

Object > CmekSettingsName

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
NameDescription
projectIdString

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
TypeDescription
String

FolderId

public string FolderId { get; }

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

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

Whether this instance contains a resource name with a known pattern.

Property Value
TypeDescription
Boolean

OrganizationId

public string OrganizationId { get; }

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

Property Value
TypeDescription
String

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

Type

public CmekSettingsName.ResourceNameType Type { get; }

The CmekSettingsName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
CmekSettingsName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

The contained UnparsedResourceName. Only non-null if this instance contains an unparsed resource name.

Property Value
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
billingAccountIdString

The BillingAccount ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
folderIdString

The Folder ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
organizationIdString

The Organization ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
billingAccountIdString

The BillingAccount ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
folderIdString

The Folder ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
organizationIdString

The Organization ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
projectIdString

The Project ID. Must not be null or empty.

Returns
TypeDescription
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
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
CmekSettingsName

A new instance of CmekSettingsName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static CmekSettingsName Parse(string cmekSettingsName)

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

Parameter
NameDescription
cmekSettingsNameString

The resource name in string form. Must not be null.

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

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
NameDescription
cmekSettingsNameString

The resource name in string form. Must not be null.

allowUnparsedBoolean

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
TypeDescription
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
TypeDescription
String

The string representation of the resource name.

Overrides

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
NameDescription
cmekSettingsNameString

The resource name in string form. Must not be null.

resultCmekSettingsName

When this method returns, the parsed CmekSettingsName, or null if parsing failed.

Returns
TypeDescription
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}/cmekSettings
  • organizations/{organization}/cmekSettings
  • folders/{folder}/cmekSettings
  • billingAccounts/{billing_account}/cmekSettings

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

The resource name in string form. Must not be null.

allowUnparsedBoolean

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.

resultCmekSettingsName

When this method returns, the parsed CmekSettingsName, or null if parsing failed.

Returns
TypeDescription
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}/cmekSettings
  • organizations/{organization}/cmekSettings
  • folders/{folder}/cmekSettings
  • billingAccounts/{billing_account}/cmekSettings
Or may be in any format if allowUnparsed is true.

Operators

Equality(CmekSettingsName, CmekSettingsName)

public static bool operator ==(CmekSettingsName a, CmekSettingsName b)
Parameters
NameDescription
aCmekSettingsName
bCmekSettingsName
Returns
TypeDescription
Boolean

Inequality(CmekSettingsName, CmekSettingsName)

public static bool operator !=(CmekSettingsName a, CmekSettingsName b)
Parameters
NameDescription
aCmekSettingsName
bCmekSettingsName
Returns
TypeDescription
Boolean