Class JobName

public sealed class JobName : IResourceName, IEquatable<JobName>

Resource name for the Job resource.

Inheritance

Object > JobName

Namespace

Google.Cloud.Talent.V4

Assembly

Google.Cloud.Talent.V4.dll

Constructors

JobName(String, String, String)

public JobName(string projectId, string tenantId, string jobId)

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

tenantIdString

The Tenant ID. Must not be null or empty.

jobIdString

The Job 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
TypeDescription
Boolean

JobId

public string JobId { get; }

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

Property Value
TypeDescription
String

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

The JobName.ResourceNameType of the contained resource name.

Property Value
TypeDescription
JobName.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 jobId)

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

tenantIdString

The Tenant ID. Must not be null or empty.

jobIdString

The Job ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this JobName with pattern projects/{project}/tenants/{tenant}/jobs/{job}.

FormatProjectTenantJob(String, String, String)

public static string FormatProjectTenantJob(string projectId, string tenantId, string jobId)

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

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

tenantIdString

The Tenant ID. Must not be null or empty.

jobIdString

The Job ID. Must not be null or empty.

Returns
TypeDescription
String

The string representation of this JobName with pattern projects/{project}/tenants/{tenant}/jobs/{job}.

FromProjectTenantJob(String, String, String)

public static JobName FromProjectTenantJob(string projectId, string tenantId, string jobId)

Creates a JobName with the pattern projects/{project}/tenants/{tenant}/jobs/{job}.

Parameters
NameDescription
projectIdString

The Project ID. Must not be null or empty.

tenantIdString

The Tenant ID. Must not be null or empty.

jobIdString

The Job ID. Must not be null or empty.

Returns
TypeDescription
JobName

A new instance of JobName constructed from the provided ids.

FromUnparsed(UnparsedResourceName)

public static JobName FromUnparsed(UnparsedResourceName unparsedResourceName)

Creates a JobName containing an unparsed resource name.

Parameter
NameDescription
unparsedResourceNameUnparsedResourceName

The unparsed resource name. Must not be null.

Returns
TypeDescription
JobName

A new instance of JobName 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 JobName Parse(string jobName)

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

Parameter
NameDescription
jobNameString

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

Returns
TypeDescription
JobName

The parsed JobName if successful.

Remarks

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

  • projects/{project}/tenants/{tenant}/jobs/{job}

Parse(String, Boolean)

public static JobName Parse(string jobName, bool allowUnparsed)

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

Parameters
NameDescription
jobNameString

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
JobName

The parsed JobName if successful.

Remarks

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

  • projects/{project}/tenants/{tenant}/jobs/{job}
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 JobName)

public static bool TryParse(string jobName, out JobName result)

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

Parameters
NameDescription
jobNameString

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

resultJobName

When this method returns, the parsed JobName, 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}/jobs/{job}

TryParse(String, Boolean, out JobName)

public static bool TryParse(string jobName, bool allowUnparsed, out JobName result)

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

Parameters
NameDescription
jobNameString

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.

resultJobName

When this method returns, the parsed JobName, 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}/jobs/{job}
Or may be in any format if allowUnparsed is true.

Operators

Equality(JobName, JobName)

public static bool operator ==(JobName a, JobName b)
Parameters
NameDescription
aJobName
bJobName
Returns
TypeDescription
Boolean

Inequality(JobName, JobName)

public static bool operator !=(JobName a, JobName b)
Parameters
NameDescription
aJobName
bJobName
Returns
TypeDescription
Boolean