Class ProfileName (2.0.0-beta07)

public sealed class ProfileName : IResourceName, IEquatable<ProfileName>

Resource name for the Profile resource.

Inheritance

Object > ProfileName

Implements

IResourceName, IEquatable<ProfileName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Talent.V4Beta1

Assembly

Google.Cloud.Talent.V4Beta1.dll

Constructors

ProfileName(String, String, String)

public ProfileName(string projectId, string tenantId, string profileId)

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

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.
`profileId`	`String` The `Profile` 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
`Boolean`

ProfileId

public string ProfileId { get; }

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

Property Value
Type	Description
`String`

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

The ProfileName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`ProfileName.ResourceNameType`

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 profileId)

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

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.
`profileId`	`String` The `Profile` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this ProfileName with pattern `projects/{project}/tenants/{tenant}/profiles/{profile}`.

FormatProjectTenantProfile(String, String, String)

public static string FormatProjectTenantProfile(string projectId, string tenantId, string profileId)

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

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.
`profileId`	`String` The `Profile` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this ProfileName with pattern `projects/{project}/tenants/{tenant}/profiles/{profile}`.

FromProjectTenantProfile(String, String, String)

public static ProfileName FromProjectTenantProfile(string projectId, string tenantId, string profileId)

Creates a ProfileName with the pattern projects/{project}/tenants/{tenant}/profiles/{profile}.

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.
`profileId`	`String` The `Profile` ID. Must not be `null` or empty.

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

FromUnparsed(UnparsedResourceName)

public static ProfileName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a ProfileName containing an unparsed resource name.

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

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

GetHashCode()

public override int GetHashCode()

Returns a hash code for this resource name.

Returns
Type	Description
`Int32`

Overrides

Object.GetHashCode()

Parse(String)

public static ProfileName Parse(string profileName)

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

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

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

Remarks

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

projects/{project}/tenants/{tenant}/profiles/{profile}

Parse(String, Boolean)

public static ProfileName Parse(string profileName, bool allowUnparsed)

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

Parameters
Name	Description
`profileName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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
`ProfileName`	The parsed ProfileName if successful.

Remarks

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

projects/{project}/tenants/{tenant}/profiles/{profile}

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 ProfileName)

public static bool TryParse(string profileName, out ProfileName result)

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

Parameters
Name	Description
`profileName`	`String` The resource name in string form. Must not be `null`.
`result`	`ProfileName` When this method returns, the parsed ProfileName, or `null` if parsing failed.

Returns
Type	Description
`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}/profiles/{profile}

TryParse(String, Boolean, out ProfileName)

public static bool TryParse(string profileName, bool allowUnparsed, out ProfileName result)

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

Parameters
Name	Description
`profileName`	`String` The resource name in string form. Must not be `null`.
`allowUnparsed`	`Boolean` 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`	`ProfileName` When this method returns, the parsed ProfileName, or `null` if parsing failed.

Returns
Type	Description
`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}/profiles/{profile}

Or may be in any format if allowUnparsed is true.

Operators

Equality(ProfileName, ProfileName)

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

Parameters
Name	Description
`a`	`ProfileName`
`b`	`ProfileName`

Returns
Type	Description
`Boolean`

Inequality(ProfileName, ProfileName)

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

Parameters
Name	Description
`a`	`ProfileName`
`b`	`ProfileName`

Returns
Type	Description
`Boolean`