Google Cloud Talent Solution v4 API - Class CompanyName (2.1.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class CompanyName : IResourceName, IEquatable<CompanyName>

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

Resource name for the Company resource.

Inheritance

Object > CompanyName

Namespace

Google.Cloud.Talent.V4

Assembly

Google.Cloud.Talent.V4.dll

Constructors

CompanyName(String, String, String)

public CompanyName(string projectId, string tenantId, string companyId)

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

tenantIdString

The Tenant ID. Must not be null or empty.

companyIdString

The Company ID. Must not be null or empty.

Properties

CompanyId

public string CompanyId { get; }

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

Property Value
TypeDescription
String

IsKnownPattern

public bool IsKnownPattern { get; }

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

Property Value
TypeDescription
Boolean

ProjectId

public string ProjectId { get; }

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

Property Value
TypeDescription
String

TenantId

public string TenantId { get; }

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

Property Value
TypeDescription
String

Type

public CompanyName.ResourceNameType Type { get; }

The CompanyName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
CompanyName.ResourceNameType

UnparsedResource

public UnparsedResourceName UnparsedResource { get; }

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

Property Value
TypeDescription
UnparsedResourceName

Methods

Format(String, String, String)

public static string Format(string projectId, string tenantId, string companyId)

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

tenantIdString

The Tenant ID. Must not be null or empty.

companyIdString

The Company ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this CompanyName with pattern projects/{project}/tenants/{tenant}/companies/{company}.

FormatProjectTenantCompany(String, String, String)

public static string FormatProjectTenantCompany(string projectId, string tenantId, string companyId)

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

tenantIdString

The Tenant ID. Must not be null or empty.

companyIdString

The Company ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this CompanyName with pattern projects/{project}/tenants/{tenant}/companies/{company}.

FromProjectTenantCompany(String, String, String)

public static CompanyName FromProjectTenantCompany(string projectId, string tenantId, string companyId)

Creates a CompanyName with the pattern projects/{project}/tenants/{tenant}/companies/{company}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

tenantIdString

The Tenant ID. Must not be null or empty.

companyIdString

The Company ID. Must not be null or empty.

Returns
TypeDescription
CompanyName

A new instance of CompanyName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static CompanyName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a CompanyName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
CompanyName

A new instance of CompanyName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
TypeDescription
Int32
Overrides

Parse(String)

public static CompanyName Parse(string companyName)

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

Parameter
NameDescription
companyNameString

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

Returns
TypeDescription
CompanyName

The parsed CompanyName if successful.

Remarks

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

  • projects/{project}/tenants/{tenant}/companies/{company}

Parse(String, Boolean)

public static CompanyName Parse(string companyName, bool allowUnparsed)

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

Parameters
NameDescription
companyNameString

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

allowUnparsedBoolean

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
CompanyName

The parsed CompanyName if successful.

Remarks

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

  • projects/{project}/tenants/{tenant}/companies/{company}
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 CompanyName)

public static bool TryParse(string companyName, out CompanyName result)

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

Parameters
NameDescription
companyNameString

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

resultCompanyName

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

  • projects/{project}/tenants/{tenant}/companies/{company}

TryParse(String, Boolean, out CompanyName)

public static bool TryParse(string companyName, bool allowUnparsed, out CompanyName result)

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

Parameters
NameDescription
companyNameString

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

allowUnparsedBoolean

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.

resultCompanyName

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

  • projects/{project}/tenants/{tenant}/companies/{company}
Or may be in any format if allowUnparsed is true.

Operators

Equality(CompanyName, CompanyName)

public static bool operator ==(CompanyName a, CompanyName b)
Parameters
NameDescription
aCompanyName
bCompanyName
Returns
TypeDescription
Boolean

Inequality(CompanyName, CompanyName)

public static bool operator !=(CompanyName a, CompanyName b)
Parameters
NameDescription
aCompanyName
bCompanyName
Returns
TypeDescription
Boolean