Class OrganizationName (4.8.0)

public sealed class OrganizationName : IResourceName, IEquatable<OrganizationName>

Resource name for the 'organization' resource which is widespread across Google Cloud. 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

Implements

IResourceName, IEquatable OrganizationName

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

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
Name	Description
`organizationId`	`string` 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
Type	Description
`bool`

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

The OrganizationName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`OrganizationNameResourceNameType`

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
Type	Description
`UnparsedResourceName`

Methods

Equals(OrganizationName)

public bool Equals(OrganizationName other)

Parameter
Name	Description
`other`	`OrganizationName`

Returns
Type	Description
`bool`

Equals(object)

public override bool Equals(object obj)

Parameter
Name	Description
`obj`	`object`

Returns
Type	Description
`bool`

Overrides

object.Equals(object)

Format(string)

public static string Format(string organizationId)

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

Parameter
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`organizationId`	`string` The `Organization` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`organizationId`	`string` 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)

public static OrganizationName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a OrganizationName containing an unparsed resource name.

Parameter
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()

public override int GetHashCode()

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static OrganizationName Parse(string organizationName)

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

Parameter
Name	Description
`organizationName`	`string` 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, bool)

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
Name	Description
`organizationName`	`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
`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()

Returns
Type	Description
`string`

Overrides

object.ToString()

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
Name	Description
`organizationName`	`string` The resource name in string form. Must not be `null`.
`result`	`OrganizationName` When this method returns, the parsed OrganizationName, 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}

TryParse(string, bool, 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
Name	Description
`organizationName`	`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`	`OrganizationName` When this method returns, the parsed OrganizationName, 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}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(OrganizationName, OrganizationName)

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

Parameters
Name	Description
`a`	`OrganizationName`
`b`	`OrganizationName`

Returns
Type	Description
`bool`

operator !=(OrganizationName, OrganizationName)

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

Parameters
Name	Description
`a`	`OrganizationName`
`b`	`OrganizationName`

Returns
Type	Description
`bool`