Class 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

System.Object

OrganizationName

Implements

IResourceName

System.IEquatable<OrganizationName>

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Google.Api.Gax.ResourceNames

Assembly: Google.Api.Gax.dll

Syntax

public sealed class OrganizationName : IResourceName, IEquatable<OrganizationName>

Constructors

OrganizationName(String)

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

Declaration

public OrganizationName(string organizationId)

Parameters

Type	Name	Description
System.String	organizationId	The Organization ID. Must not be null or empty.

Properties

IsKnownPattern

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

Declaration

public bool IsKnownPattern { get; }

Property Value

Type	Description
System.Boolean

Implements

IResourceName.IsKnownPattern

OrganizationId

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

Declaration

public string OrganizationId { get; }

Property Value

Type	Description
System.String

Type

The OrganizationName.ResourceNameType of the contained resource name.

Declaration

public OrganizationName.ResourceNameType Type { get; }

Property Value

Type	Description
OrganizationName.ResourceNameType

UnparsedResource

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

Declaration

public UnparsedResourceName UnparsedResource { get; }

Property Value

Type	Description
UnparsedResourceName

Methods

Equals(OrganizationName)

Declaration

public bool Equals(OrganizationName other)

Parameters

Type	Name	Description
OrganizationName	other

Returns

Type	Description
System.Boolean

Implements

System.IEquatable<T>.Equals(T)

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

Overrides

System.Object.Equals(System.Object)

Format(String)

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

Declaration

public static string Format(string organizationId)

Parameters

Type	Name	Description
System.String	organizationId	The Organization ID. Must not be null or empty.

Returns

Type	Description
System.String	The string representation of this OrganizationName with pattern organizations/{organization}.

FormatOrganization(String)

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

Declaration

public static string FormatOrganization(string organizationId)

Parameters

Type	Name	Description
System.String	organizationId	The Organization ID. Must not be null or empty.

Returns

Type	Description
System.String	The string representation of this OrganizationName with pattern organizations/{organization}.

FromOrganization(String)

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

Declaration

public static OrganizationName FromOrganization(string organizationId)

Parameters

Type	Name	Description
System.String	organizationId	The Organization ID. Must not be null or empty.

Returns

Type	Description
OrganizationName	A new instance of OrganizationName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

Creates a OrganizationName containing an unparsed resource name.

Declaration

public static OrganizationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Parameters

Type	Name	Description
UnparsedResourceName	unparsedResourceName	The unparsed resource name. Must not be null.

Returns

Type	Description
OrganizationName	A new instance of OrganizationName containing the provided unparsedResourceName.

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

Overrides

System.Object.GetHashCode()

Parse(String)

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

Declaration

public static OrganizationName Parse(string organizationName)

Parameters

Type	Name	Description
System.String	organizationName	The resource name in string form. Must not be null.

Returns

Type	Description
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)

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

Declaration

public static OrganizationName Parse(string organizationName, bool allowUnparsed)

Parameters

Type	Name	Description
System.String	organizationName	The resource name in string form. Must not be null.
System.Boolean	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.

Returns

Type	Description
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()

The string representation of the resource name.

Declaration

public override string ToString()

Returns

Type	Description
System.String	The string representation of the resource name.

Overrides

System.Object.ToString()

Implements

IResourceName.ToString()

TryParse(String, out OrganizationName)

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

Declaration

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

Parameters

Type	Name	Description
System.String	organizationName	The resource name in string form. Must not be null.
OrganizationName	result	When this method returns, the parsed OrganizationName, or null if parsing failed.

Returns

Type	Description
System.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)

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

Declaration

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

Parameters

Type	Name	Description
System.String	organizationName	The resource name in string form. Must not be null.
System.Boolean	allowUnparsed	If true will successfully store an unparseable resource name into the UnparsedResource property; otherwise will throw an System.ArgumentException if an unparseable resource name is specified.
OrganizationName	result	When this method returns, the parsed OrganizationName, or null if parsing failed.

Returns

Type	Description
System.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)

Declaration

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

Parameters

Type	Name	Description
OrganizationName	a
OrganizationName	b

Returns

Type	Description
System.Boolean

Inequality(OrganizationName, OrganizationName)

Declaration

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

Parameters

Type	Name	Description
OrganizationName	a
OrganizationName	b

Returns

Type	Description
System.Boolean