Google Cloud Logging v2 API - Class SettingsName (4.1.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

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

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

The SettingsName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
SettingsNameResourceNameType

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

Parameter
NameDescription
projectIdstring

The Project ID. Must not be null or empty.

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

The BillingAccount ID. Must not be null or empty.

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

The Folder ID. Must not be null or empty.

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

The Organization ID. Must not be null or empty.

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

The Project ID. Must not be null or empty.

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

The BillingAccount ID. Must not be null or empty.

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

The Folder ID. Must not be null or empty.

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

The Organization ID. Must not be null or empty.

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

The Project ID. Must not be null or empty.

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

The unparsed resource name. Must not be null.

Returns
TypeDescription
SettingsName

A new instance of SettingsName containing the provided unparsedResourceName .

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
int
Overrides

Parse(string)

public static SettingsName Parse(string settingsName)

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

Parameter
NameDescription
settingsNamestring

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

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

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

allowUnparsedbool

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

The string representation of the resource name.

Overrides

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

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

resultSettingsName

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

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

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

allowUnparsedbool

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.

resultSettingsName

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

Returns
TypeDescription
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)
Parameters
NameDescription
aSettingsName
bSettingsName
Returns
TypeDescription
bool

operator !=(SettingsName, SettingsName)

public static bool operator !=(SettingsName a, SettingsName b)
Parameters
NameDescription
aSettingsName
bSettingsName
Returns
TypeDescription
bool