Google Cloud Talent Solution v4 API - Class TenantName (2.5.0)

public sealed class TenantName : IResourceName, IEquatable<TenantName>

Reference documentation and code samples for the Google Cloud Talent Solution v4 API class TenantName.

Resource name for the Tenant resource.

Inheritance

object > TenantName

Implements

IResourceName, IEquatable TenantName

Inherited Members

object.GetType()

Namespace

Google.Cloud.Talent.V4

Assembly

Google.Cloud.Talent.V4.dll

Constructors

TenantName(string, string)

public TenantName(string projectId, string tenantId)

Constructs a new instance of a TenantName class from the component parts of pattern projects/{project}/tenants/{tenant}

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`tenantId`	`string` The `Tenant` 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`

ProjectId

public string ProjectId { get; }

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

Property Value
Type	Description
`string`

TenantId

public string TenantId { get; }

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

Property Value
Type	Description
`string`

Type

public TenantName.ResourceNameType Type { get; }

The TenantName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`TenantNameResourceNameType`

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)

public static string Format(string projectId, string tenantId)

Formats the IDs into the string representation of this TenantName with pattern projects/{project}/tenants/{tenant}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`tenantId`	`string` The `Tenant` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this TenantName with pattern `projects/{project}/tenants/{tenant}`.

FormatProjectTenant(string, string)

public static string FormatProjectTenant(string projectId, string tenantId)

Formats the IDs into the string representation of this TenantName with pattern projects/{project}/tenants/{tenant}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`tenantId`	`string` The `Tenant` ID. Must not be `null` or empty.

Returns
Type	Description
`string`	The string representation of this TenantName with pattern `projects/{project}/tenants/{tenant}`.

FromProjectTenant(string, string)

public static TenantName FromProjectTenant(string projectId, string tenantId)

Creates a TenantName with the pattern projects/{project}/tenants/{tenant}.

Parameters
Name	Description
`projectId`	`string` The `Project` ID. Must not be `null` or empty.
`tenantId`	`string` The `Tenant` ID. Must not be `null` or empty.

Returns
Type	Description
`TenantName`	A new instance of TenantName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static TenantName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a TenantName containing an unparsed resource name.

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

Returns
Type	Description
`TenantName`	A new instance of TenantName containing the provided `unparsedResourceName`.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

Parse(string)

public static TenantName Parse(string tenantName)

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

Parameter
Name	Description
`tenantName`	`string` The resource name in string form. Must not be `null`.

Returns
Type	Description
`TenantName`	The parsed TenantName if successful.

Remarks

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

projects/{project}/tenants/{tenant}

Parse(string, bool)

public static TenantName Parse(string tenantName, bool allowUnparsed)

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

Parameters
Name	Description
`tenantName`	`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
`TenantName`	The parsed TenantName if successful.

Remarks

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

projects/{project}/tenants/{tenant}

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

object.ToString()

TryParse(string, out TenantName)

public static bool TryParse(string tenantName, out TenantName result)

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

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

projects/{project}/tenants/{tenant}

TryParse(string, bool, out TenantName)

public static bool TryParse(string tenantName, bool allowUnparsed, out TenantName result)

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

Parameters
Name	Description
`tenantName`	`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`	`TenantName` When this method returns, the parsed TenantName, 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:

projects/{project}/tenants/{tenant}

Or may be in any format if allowUnparsed is true.

Operators

operator ==(TenantName, TenantName)

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

Determines whether two specified resource names have the same value.

Parameters
Name	Description
`a`	`TenantName` The first resource name to compare, or null.
`b`	`TenantName` 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 !=(TenantName, TenantName)

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

Determines whether two specified resource names have different values.

Parameters
Name	Description
`a`	`TenantName` The first resource name to compare, or null.
`b`	`TenantName` 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.