Google Cloud Talent Solution v4beta1 API - Class CompanyName (3.0.0-beta07) 

public sealed class CompanyName : IResourceName, IEquatable<CompanyName>

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

Resource name for the Company resource.

Inheritance

object > CompanyName

Namespace

Google.Cloud.Talent.V4Beta1

Assembly

Google.Cloud.Talent.V4Beta1.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
Name Description
projectId string

The Project ID. Must not be null or empty.
tenantId string

The Tenant ID. Must not be null or empty.
companyId string

The Company ID. Must not be null or empty.

Properties

CompanyId

public string CompanyId { get; }

The Company ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

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. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

TenantId

public string TenantId { get; }

The Tenant ID. May be null, depending on which resource name is contained by this instance.

Property Value
Type Description
string

Type

public CompanyName.ResourceNameType Type { get; }

The CompanyName.ResourceNameType of the contained resource name.

Property Value
Type Description
CompanyNameResourceNameType

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, 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
Name Description
projectId string

The Project ID. Must not be null or empty.
tenantId string

The Tenant ID. Must not be null or empty.
companyId string

The Company ID. Must not be null or empty.
Returns
Type Description
string

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

FormatProjectCompany(string, string)

public static string FormatProjectCompany(string projectId, string companyId)

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

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
companyId string

The Company ID. Must not be null or empty.
Returns
Type Description
string

The string representation of this CompanyName with pattern projects/{project}/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
Name Description
projectId string

The Project ID. Must not be null or empty.
tenantId string

The Tenant ID. Must not be null or empty.
companyId string

The Company ID. Must not be null or empty.
Returns
Type Description
string

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

FromProjectCompany(string, string)

public static CompanyName FromProjectCompany(string projectId, string companyId)

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

Parameters
Name Description
projectId string

The Project ID. Must not be null or empty.
companyId string

The Company ID. Must not be null or empty.
Returns
Type Description
CompanyName

A new instance of CompanyName constructed from the provided ids.

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
Name Description
projectId string

The Project ID. Must not be null or empty.
tenantId string

The Tenant ID. Must not be null or empty.
companyId string

The Company ID. Must not be null or empty.
Returns
Type Description
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
Name Description
unparsedResourceName UnparsedResourceName

The unparsed resource name. Must not be null.
Returns
Type Description
CompanyName

A new instance of CompanyName containing the provided unparsedResourceName.

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type Description
int
Overrides

Parse(string)

public static CompanyName Parse(string companyName)

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

Parameter
Name Description
companyName string

The resource name in string form. Must not be null.
Returns
Type Description
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}
  • projects/{project}/companies/{company}

Parse(string, bool)

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
Name Description
companyName 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
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}
  • projects/{project}/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
Type Description
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
Name Description
companyName string

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

When this method returns, the parsed CompanyName, 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}/companies/{company}
  • projects/{project}/companies/{company}

TryParse(string, bool, 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
Name Description
companyName 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 CompanyName

When this method returns, the parsed CompanyName, 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}/companies/{company}
  • projects/{project}/companies/{company}
Or may be in any format if allowUnparsed is true.

Operators

operator ==(CompanyName, CompanyName)

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

Determines whether two specified resource names have the same value.

Parameters
Name Description
a CompanyName

The first resource name to compare, or null.
b CompanyName

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 !=(CompanyName, CompanyName)

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

Determines whether two specified resource names have different values.

Parameters
Name Description
a CompanyName

The first resource name to compare, or null.
b CompanyName

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.