Advisory Notifications v1 API - Class SettingsName (1.5.0)

public sealed class SettingsName : IResourceName, IEquatable<SettingsName>

Reference documentation and code samples for the Advisory Notifications v1 API class SettingsName.

Resource name for the Settings resource.

Inheritance

object > SettingsName

Namespace

Google.Cloud.AdvisoryNotifications.V1

Assembly

Google.Cloud.AdvisoryNotifications.V1.dll

Constructors

SettingsName(string, string)

public SettingsName(string organizationId, string locationId)

Constructs a new instance of a SettingsName class from the component parts of pattern organizations/{organization}/locations/{location}/settings

Parameters
NameDescription
organizationIdstring

The Organization ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

Properties

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
bool

LocationId

public string LocationId { get; }

The Location ID. Will not be null, unless this instance contains an unparsed resource name.

Property Value
TypeDescription
string

OrganizationId

public string OrganizationId { get; }

The Organization ID. Will not be null, unless this instance contains an unparsed resource name.

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, string)

public static string Format(string organizationId, string locationId)

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

Parameters
NameDescription
organizationIdstring

The Organization ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this SettingsName with pattern organizations/{organization}/locations/{location}/settings.

FormatOrganizationLocation(string, string)

public static string FormatOrganizationLocation(string organizationId, string locationId)

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

Parameters
NameDescription
organizationIdstring

The Organization ID. Must not be null or empty.

locationIdstring

The Location ID. Must not be null or empty.

Returns
TypeDescription
string

The string representation of this SettingsName with pattern organizations/{organization}/locations/{location}/settings.

FromOrganizationLocation(string, string)

public static SettingsName FromOrganizationLocation(string organizationId, string locationId)

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

Parameters
NameDescription
organizationIdstring

The Organization ID. Must not be null or empty.

locationIdstring

The Location 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:

  • organizations/{organization}/locations/{location}/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:

  • organizations/{organization}/locations/{location}/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:

  • organizations/{organization}/locations/{location}/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:

  • organizations/{organization}/locations/{location}/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
NameDescription
aSettingsName

The first resource name to compare, or null.

bSettingsName

The second resource name to compare, or null.

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

The first resource name to compare, or null.

bSettingsName

The second resource name to compare, or null.

Returns
TypeDescription
bool

true if the value of a is different from the value of b; otherwise, false.