Service Health v1 API - Class OrganizationImpactName (1.1.0)

public sealed class OrganizationImpactName : IResourceName, IEquatable<OrganizationImpactName>

Reference documentation and code samples for the Service Health v1 API class OrganizationImpactName.

Resource name for the OrganizationImpact resource.

Inheritance

object > OrganizationImpactName

Namespace

Google.Cloud.ServiceHealth.V1

Assembly

Google.Cloud.ServiceHealth.V1.dll

Constructors

OrganizationImpactName(string, string, string)

public OrganizationImpactName(string organizationId, string locationId, string organizationImpactId)

Constructs a new instance of a OrganizationImpactName class from the component parts of pattern organizations/{organization}/locations/{location}/organizationImpacts/{organization_impact}

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

organizationImpactId string

The OrganizationImpact 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
Type Description
bool

LocationId

public string LocationId { get; }

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

Property Value
Type Description
string

OrganizationId

public string OrganizationId { get; }

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

Property Value
Type Description
string

OrganizationImpactId

public string OrganizationImpactId { get; }

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

Property Value
Type Description
string

Type

public OrganizationImpactName.ResourceNameType Type { get; }

The OrganizationImpactName.ResourceNameType of the contained resource name.

Property Value
Type Description
OrganizationImpactNameResourceNameType

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

public static string Format(string organizationId, string locationId, string organizationImpactId)

Formats the IDs into the string representation of this OrganizationImpactName with pattern organizations/{organization}/locations/{location}/organizationImpacts/{organization_impact}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

organizationImpactId string

The OrganizationImpact ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this OrganizationImpactName with pattern organizations/{organization}/locations/{location}/organizationImpacts/{organization_impact}.

FormatOrganizationLocationOrganizationImpact(string, string, string)

public static string FormatOrganizationLocationOrganizationImpact(string organizationId, string locationId, string organizationImpactId)

Formats the IDs into the string representation of this OrganizationImpactName with pattern organizations/{organization}/locations/{location}/organizationImpacts/{organization_impact}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

organizationImpactId string

The OrganizationImpact ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this OrganizationImpactName with pattern organizations/{organization}/locations/{location}/organizationImpacts/{organization_impact}.

FromOrganizationLocationOrganizationImpact(string, string, string)

public static OrganizationImpactName FromOrganizationLocationOrganizationImpact(string organizationId, string locationId, string organizationImpactId)

Creates a OrganizationImpactName with the pattern organizations/{organization}/locations/{location}/organizationImpacts/{organization_impact}.

Parameters
Name Description
organizationId string

The Organization ID. Must not be null or empty.

locationId string

The Location ID. Must not be null or empty.

organizationImpactId string

The OrganizationImpact ID. Must not be null or empty.

Returns
Type Description
OrganizationImpactName

A new instance of OrganizationImpactName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static OrganizationImpactName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a OrganizationImpactName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
OrganizationImpactName

A new instance of OrganizationImpactName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static OrganizationImpactName Parse(string organizationImpactName)

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

Parameter
Name Description
organizationImpactName string

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

Returns
Type Description
OrganizationImpactName

The parsed OrganizationImpactName if successful.

Remarks

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

  • organizations/{organization}/locations/{location}/organizationImpacts/{organization_impact}

Parse(string, bool)

public static OrganizationImpactName Parse(string organizationImpactName, bool allowUnparsed)

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

Parameters
Name Description
organizationImpactName 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
OrganizationImpactName

The parsed OrganizationImpactName if successful.

Remarks

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

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

TryParse(string, out OrganizationImpactName)

public static bool TryParse(string organizationImpactName, out OrganizationImpactName result)

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

Parameters
Name Description
organizationImpactName string

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

result OrganizationImpactName

When this method returns, the parsed OrganizationImpactName, 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:

  • organizations/{organization}/locations/{location}/organizationImpacts/{organization_impact}

TryParse(string, bool, out OrganizationImpactName)

public static bool TryParse(string organizationImpactName, bool allowUnparsed, out OrganizationImpactName result)

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

Parameters
Name Description
organizationImpactName 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 OrganizationImpactName

When this method returns, the parsed OrganizationImpactName, 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:

  • organizations/{organization}/locations/{location}/organizationImpacts/{organization_impact}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(OrganizationImpactName, OrganizationImpactName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a OrganizationImpactName

The first resource name to compare, or null.

b OrganizationImpactName

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 !=(OrganizationImpactName, OrganizationImpactName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a OrganizationImpactName

The first resource name to compare, or null.

b OrganizationImpactName

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.