Class JobName (2.3.0)

public sealed class JobName : IResourceName, IEquatable<JobName>

Resource name for the Job resource.

Inheritance

Object > JobName

Implements

IResourceName, IEquatable<JobName>

Inherited Members

Object.GetType()

Object.MemberwiseClone()

Namespace

Google.Cloud.Scheduler.V1

Assembly

Google.Cloud.Scheduler.V1.dll

Constructors

JobName(String, String, String)

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

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

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`locationId`	`String` The `Location` ID. Must not be `null` or empty.
`jobId`	`String` 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
Type	Description
`Boolean`

JobId

public string JobId { get; }

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

Property Value
Type	Description
`String`

LocationId

public string LocationId { get; }

The Location 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`

Type

public JobName.ResourceNameType Type { get; }

The JobName.ResourceNameType of the contained resource name.

Property Value
Type	Description
`JobName.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 locationId, string jobId)

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

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`locationId`	`String` The `Location` ID. Must not be `null` or empty.
`jobId`	`String` The `Job` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this JobName with pattern `projects/{project}/locations/{location}/jobs/{job}`.

FormatProjectLocationJob(String, String, String)

public static string FormatProjectLocationJob(string projectId, string locationId, string jobId)

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

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`locationId`	`String` The `Location` ID. Must not be `null` or empty.
`jobId`	`String` The `Job` ID. Must not be `null` or empty.

Returns
Type	Description
`String`	The string representation of this JobName with pattern `projects/{project}/locations/{location}/jobs/{job}`.

FromProjectLocationJob(String, String, String)

public static JobName FromProjectLocationJob(string projectId, string locationId, string jobId)

Creates a JobName with the pattern projects/{project}/locations/{location}/jobs/{job}.

Parameters
Name	Description
`projectId`	`String` The `Project` ID. Must not be `null` or empty.
`locationId`	`String` The `Location` ID. Must not be `null` or empty.
`jobId`	`String` The `Job` ID. Must not be `null` or empty.

Returns
Type	Description
`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
Name	Description
`unparsedResourceName`	`UnparsedResourceName` The unparsed resource name. Must not be `null`.

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

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

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

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

Remarks

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

projects/{project}/locations/{location}/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
Name	Description
`jobName`	`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
`JobName`	The parsed JobName if successful.

Remarks

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

projects/{project}/locations/{location}/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
Type	Description
`String`	The string representation of the resource name.

Overrides

Object.ToString()

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
Name	Description
`jobName`	`String` The resource name in string form. Must not be `null`.
`result`	`JobName` When this method returns, the parsed JobName, 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}/locations/{location}/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
Name	Description
`jobName`	`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`	`JobName` When this method returns, the parsed JobName, 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}/locations/{location}/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
Name	Description
`a`	`JobName`
`b`	`JobName`

Returns
Type	Description
`Boolean`

Inequality(JobName, JobName)

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

Parameters
Name	Description
`a`	`JobName`
`b`	`JobName`

Returns
Type	Description
`Boolean`