Class OrganizationName

public sealed class OrganizationName : IResourceName, IEquatable<OrganizationName>

Resource name for the 'organization' resource which is widespread across Google Cloud Platform. While most resource names are generated on a per-API basis, many APIs use an organization resource, and it's useful to be able to pass values from one API to another.

Inheritance

Object > OrganizationName

Namespace

Google.Api.Gax.ResourceNames

Assembly

Google.Api.Gax.dll

Constructors

OrganizationName(String)

public OrganizationName(string organizationId)

Constructs a new instance of a OrganizationName class from the component parts of pattern organizations/{organization}

Parameter
TypeNameDescription
StringorganizationId

The Organization 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
Boolean

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

The OrganizationName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
OrganizationName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Equals(OrganizationName)

public bool Equals(OrganizationName other)
Parameter
TypeNameDescription
OrganizationNameother
Returns
TypeDescription
Boolean

Equals(Object)

public override bool Equals(object obj)
Parameter
TypeNameDescription
Objectobj
Returns
TypeDescription
Boolean
Overrides

Format(String)

public static string Format(string organizationId)

Formats the IDs into the string representation of this OrganizationName with pattern organizations/{organization}.

Parameter
TypeNameDescription
StringorganizationId

The Organization ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this OrganizationName with pattern organizations/{organization}.

FormatOrganization(String)

public static string FormatOrganization(string organizationId)

Formats the IDs into the string representation of this OrganizationName with pattern organizations/{organization}.

Parameter
TypeNameDescription
StringorganizationId

The Organization ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this OrganizationName with pattern organizations/{organization}.

FromOrganization(String)

public static OrganizationName FromOrganization(string organizationId)

Creates a OrganizationName with the pattern organizations/{organization}.

Parameter
TypeNameDescription
StringorganizationId

The Organization ID. Must not be null or empty.

Returns
TypeDescription
OrganizationName

A new instance of OrganizationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static OrganizationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a OrganizationName containing an unparsed resource name.

Parameter
TypeNameDescription
UnparsedResourceNameunparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
OrganizationName

A new instance of OrganizationName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()
Returns
TypeDescription
Int32
Overrides

Parse(String)

public static OrganizationName Parse(string organizationName)

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

Parameter
TypeNameDescription
StringorganizationName

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

Returns
TypeDescription
OrganizationName

The parsed OrganizationName if successful.

Remarks

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

  • organizations/{organization}

Parse(String, Boolean)

public static OrganizationName Parse(string organizationName, bool allowUnparsed)

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

Parameters
TypeNameDescription
StringorganizationName

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

BooleanallowUnparsed

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
OrganizationName

The parsed OrganizationName if successful.

Remarks

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

  • organizations/{organization}
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 OrganizationName)

public static bool TryParse(string organizationName, out OrganizationName result)

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

Parameters
TypeNameDescription
StringorganizationName

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

OrganizationNameresult

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

  • organizations/{organization}

TryParse(String, Boolean, out OrganizationName)

public static bool TryParse(string organizationName, bool allowUnparsed, out OrganizationName result)

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

Parameters
TypeNameDescription
StringorganizationName

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

BooleanallowUnparsed

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.

OrganizationNameresult

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

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

Operators

Equality(OrganizationName, OrganizationName)

public static bool operator ==(OrganizationName a, OrganizationName b)
Parameters
TypeNameDescription
OrganizationNamea
OrganizationNameb
Returns
TypeDescription
Boolean

Inequality(OrganizationName, OrganizationName)

public static bool operator !=(OrganizationName a, OrganizationName b)
Parameters
TypeNameDescription
OrganizationNamea
OrganizationNameb
Returns
TypeDescription
Boolean

Implements