Service Health v1 API - Class OrganizationEventName (1.2.0)

public sealed class OrganizationEventName : IResourceName, IEquatable<OrganizationEventName>

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

Resource name for the OrganizationEvent resource.

Inheritance

object > OrganizationEventName

Namespace

Google.Cloud.ServiceHealth.V1

Assembly

Google.Cloud.ServiceHealth.V1.dll

Constructors

OrganizationEventName(string, string, string)

public OrganizationEventName(string organizationId, string locationId, string eventId)

Constructs a new instance of a OrganizationEventName class from the component parts of pattern organizations/{organization}/locations/{location}/organizationEvents/{event}

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.

eventId string

The Event ID. Must not be null or empty.

Properties

EventId

public string EventId { get; }

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

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

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

Type

public OrganizationEventName.ResourceNameType Type { get; }

The OrganizationEventName.ResourceNameType of the contained resource name.

Property Value
Type Description
OrganizationEventNameResourceNameType

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

Formats the IDs into the string representation of this OrganizationEventName with pattern organizations/{organization}/locations/{location}/organizationEvents/{event}.

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.

eventId string

The Event ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this OrganizationEventName with pattern organizations/{organization}/locations/{location}/organizationEvents/{event}.

FormatOrganizationLocationEvent(string, string, string)

public static string FormatOrganizationLocationEvent(string organizationId, string locationId, string eventId)

Formats the IDs into the string representation of this OrganizationEventName with pattern organizations/{organization}/locations/{location}/organizationEvents/{event}.

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.

eventId string

The Event ID. Must not be null or empty.

Returns
Type Description
string

The string representation of this OrganizationEventName with pattern organizations/{organization}/locations/{location}/organizationEvents/{event}.

FromOrganizationLocationEvent(string, string, string)

public static OrganizationEventName FromOrganizationLocationEvent(string organizationId, string locationId, string eventId)

Creates a OrganizationEventName with the pattern organizations/{organization}/locations/{location}/organizationEvents/{event}.

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.

eventId string

The Event ID. Must not be null or empty.

Returns
Type Description
OrganizationEventName

A new instance of OrganizationEventName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static OrganizationEventName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a OrganizationEventName containing an unparsed resource name.

Parameter
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.

Returns
Type Description
OrganizationEventName

A new instance of OrganizationEventName 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 OrganizationEventName Parse(string organizationEventName)

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

Parameter
Name Description
organizationEventName string

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

Returns
Type Description
OrganizationEventName

The parsed OrganizationEventName if successful.

Remarks

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

  • organizations/{organization}/locations/{location}/organizationEvents/{event}

Parse(string, bool)

public static OrganizationEventName Parse(string organizationEventName, bool allowUnparsed)

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

Parameters
Name Description
organizationEventName 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
OrganizationEventName

The parsed OrganizationEventName if successful.

Remarks

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

  • organizations/{organization}/locations/{location}/organizationEvents/{event}
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 OrganizationEventName)

public static bool TryParse(string organizationEventName, out OrganizationEventName result)

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

Parameters
Name Description
organizationEventName string

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

result OrganizationEventName

When this method returns, the parsed OrganizationEventName, 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}/organizationEvents/{event}

TryParse(string, bool, out OrganizationEventName)

public static bool TryParse(string organizationEventName, bool allowUnparsed, out OrganizationEventName result)

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

Parameters
Name Description
organizationEventName 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 OrganizationEventName

When this method returns, the parsed OrganizationEventName, 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}/organizationEvents/{event}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(OrganizationEventName, OrganizationEventName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a OrganizationEventName

The first resource name to compare, or null.

b OrganizationEventName

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

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a OrganizationEventName

The first resource name to compare, or null.

b OrganizationEventName

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.